Loading...
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 | 137.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"}
game_info
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
character_name | game_info | Local player's current character name | See notes | 242.0 |
player_id | game_info | Current player ID | See notes | 242.0 |
character_name note
Data Example:
{"info":{"character_info":{"character_name":"PlayerBoy"}},"feature":"game_info"}
player_id note
Data Example:
{"info":{"game_info":{"player_id":766078275}},"feature":"game_info"}
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
character_switch | When the player switch the character | See notes | 242.0 |
character_switch note
Data Example:
{"events":[{"name":"character_switch","data":"null"}]}
match_info
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
match_start | In the beginning of each match | See notes | 242.0 | |
match_end | At the end of each match | See notes | 242.0 | |
dungeon_start | At the beginning of a dungeon | See notes | 255.0 | |
dungeon_end | At the end of a dungeon | See notes | 255.0 |
match_start note
Data Example:
{"events":[{"name":"match_start","data":null}]}
match_end note
Data Example:
{"events":[{"name":"match_end","data":null}]}
dungeon_start note
Data Example:
{"events":[{"name":"dungeon_start","data":null}]}
dungeon_end note
Data Example:
{"events":[{"name":"dungeon_end","data":null}]}