Loading...
- Game events API
Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
Sample Apps
Available Features
Game event status
It is highly recommended to communicate errors and warnings to app users.
Check the current game event status here. Alternatively, you can easily check that status from your app itself, using our API.
gep_internal
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
gep_internal | gep_internal | Local + Public version number | See notes | 252.0 |
gep_internal note
Data Example:
{"info":{"gep_internal":{"version_info":"{"local_version":"244.0.0","public_version":"244.0.0","is_updated":true}"}},"feature":"gep_internal"}
game_info
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
player_name | game_info | The local player's name | See notes | 277.0 |
player_id | game_info | The local player's id | See notes | 277.0 |
player_name note
Data Example:
{"feature":"game_info","category":"game_info","key":"player_name","value":"Stungaxi"}
player_id note
Data Example:
{"feature":"game_info","category":"game_info","key":"player_id","value":"7656119235655409266"}
match_info
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
match_start | null | In the beginning of the game | See notes | 277.0 |
match_end | null | At the end of the game | See notes | 277.0 |
sleep_start | null | When the local player starts sleeping | See notes | 277.0 |
sleep_end | null | When the local player wakesup | See notes | 277.0 |
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
player_rank | game_info | The local player's rank name + curent value + total value | See notes | 277.0 |
pursuit_level | game_info | The current pursuit level | See notes | 277.0 |
match_start note
Data Example:
{"events":[{"name":"match_start","data":null}]}
match_end note
Data Example:
{"events":[{"name":"match_end","data":null}]}
sleep_start note
Data Example:
{"events":[{"name":"sleep_start","data":null}]}
sleep_end note
Data Example:
{"events":[{"name":"sleep_end","data":null}]}
player_rank note
Data Example:
{"feature":"match_info","category":"match_info","key":"player_rank","value":"{\"name\":\"Street Rat III\",\"value\":95,\"total\":170}"}
pursuit_level note
Possible values:
- regular - by deafult
- body_search
- escalating
- arresting
- arrested
Data Example:
{"feature":"match_info","category":"match_info","key":"pursuit_level","value":"regular"}
Loading...