Loading...
Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
Sample Apps
Available Features
Game events status
It's highly recommended to communicate errors and warnings to your app users. Check current game event status here or easily check game event status from your app using our API.
gep_internal
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
gep_internal | gep_internal | Local + Public version number | See notes | 245.1.0 |
gep_internal note
Data Example:
{"info":{"gep_internal":{"version_info":"{"local_version":"157.0.1","public_version":"157.0.1","is_updated":true}"}},"feature":"gep_internal"}
match_info
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
match_start | null | The player’s champion died | See notes | 245.1.0 |
match_end | null | The player’s champion died | See notes | 245.1.0 |
knockout | null | The player is knockout | See notes | 245.1.0 |
death | null | The player is dead | See notes | 245.1.0 |
respawn | null | The player respawned | See notes | 245.1.0 |
revive | null | The player revived | See notes | 245.1.0 |
match_start note
Data Example:
{"events":[{"name":"match_start","data":null}]}
match_end note
Data Example:
{"events":[{"name":"match_end","data":null}]}
knockout note
Data Example:
{"events":[{"name":"knockout","data":null}]}
death note
Data Example:
{"events":[{"name":"death","data":null}]}
respawn note
Data Example:
{"events":[{"name":"respawn","data":null}]}
revive note
Data Example:
{"events":[{"name":"revive","data":null}]}
game_info
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
scene | game_info | The name of the current scene. | See notes | 245.1.0 |
scene note
List of possible values:
- lobby
- ingame
Data Example:
{"info":{"game_info":{"scene":"lobby"}},"feature":"game_info"}
location
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
location | match_info | local player location | See notes | 245.2.0 |
location note
Data Example:
{"feature":"location","category":"match_info","key":"location","value":"{\"x\" : 231317,\"y\" : -337646,\"z\" : -1794}"}