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 | 282.0 |
scene | game_info | Different scenes during the game | See notes | 282.0 |
party_players | game_info | A list of players that joined the party | See notes | 282.0 |
game_mode | game_info | The current game mode | See notes | 282.0 |
player_name note
Data Example:
{"feature":"game_info","category":"game_info","key":"player_name","value":"Stungaxi"}
scene note
Possible values:
- main_menu
- airport
- ingame
Data Example:
{"feature":"game_info","category":"game_info","key":"scene","value":"main_menu"}
party_players note
Data Example:
{"feature":"game_info","category":"game_info","key":"party_players","value":"["Captain a","OverTheTop"]"}
game_mode note
Possible values:
- offline
- host
Data Example:
{"feature":"game_info","category":"game_info","key":"game_mode","value":"offline"}
match_info
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
match_start | null | At the beginning of the game | See notes | 282.0 |
match_end | null | At the end of the game | See notes | 282.0 |
death | null | When the local player dies | See notes | 282.0 |
teammate_death | The name of the player | When a teammate dies | See notes | 282.0 |
checkpoint | null | When the local player lights a campfire | See notes | 282.0 |
match_start note
Data Example:
{"events":[{"name":"match_start","data":null}]}
match_end note
Data Example:
{"events":[{"name":"match_end","data":null}]}
death note
Data Example:
{"events":[{"name":"death","data":null}]}
teammate_death note
Data Example:
{"events":[{"name":"teammate_death","data":"Captain a"}]}
checkpoint note
Data Example:
{"events":[{"name":"checkpoint","data":null}]}
Loading...