Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
Sample Apps
Available Features
In WoT, due to technical reasons, Overwolf API starts to work only if the game was launched before, at least one time (because only then, we identify the location of the game installation). So, if you identify an error when you try to register to the game events (and in particular - when you get the “failed after 11 tries” error when calling setRequiredFeatures ) - on that case, notify the user that she has to relaunch the game. Not ideal - but working. And cover those cases.
Game events status
It's highly recommended to communicate errors and warnings to your app users. Check game event status here or easily check game events straight 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 | 143.0 |
gep_internal note
Data Example:
{"feature":"gep_internal","category":"gep_internal","key":"version_info","value":"{"local_version":"143.0.10","public_version":"143.0.10","is_updated":true}"}
kill
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| kill | Enemy team | A tank was destroyed | See notes | 47.0 |
| one_shot_kill | Enemy team | The player’s tank destroyed another tank with a single shot and no ally assistance | See notes | 47.0 |
| damage | Enemy team and damage | The player’s tank damaged another tank | See notes | 47.0 |
| assist | Enemy team | The player’s tank assisted in destroying another tank | See notes | 47.0 |
kill note
Event Data:
{"enemyTeam":true}
true if the event refers to an enemy unit, false if the event refers to an ally unit
one_shot_kill note
Event Data:
{"enemyTeam":true}
true if the event refers to an enemy unit, false if the event refers to an ally unit
damage note
Event Data:
{"enemyTeam":true,"damage":"33"}
true if the event refers to an enemy unit, false if the event refers to an ally unit
assist note
Event Data:
{"enemyTeam":true}
true if the event refers to an enemy unit, false if the event refers to an ally unit
death
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| death | null | The player’s tank was destroyed | 47.0 | |
| hit | Enemy type and damage | The player’s tank was damaged | See notes | 47.0 |
hit note
Event Data:
{"enemyTeam":true,"damage":"41"}
true if the event refers to an enemy unit, false if the event refers to an ally unit
game_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| game_start_timestamp | game_info | See notes | Deprecated | 47.0 |
| game_state | game_info | See notes | 47.0 | |
| map_name | game_info | See notes | 86.0 |
game_start_timestamp note
This event is deprecated
Example data - "Tue Feb 07 2017 15:48:48 GMT+0200"
game_state note
what is the current state of the game.
Data example:
['hangar' | 'battle' | 'training' | 'replay']
'replay' means we are running a replay file.
map_name note
Name of the map or loading space the player is currently in
Data example:
['hangar_v2' | 'hangar_bootcamp' | '05_prohorovka' | '08_ruinberg']
match_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| pseudo_match_id | match_info | Current match’s ID code. | See notes | 47.0 |
Data example
{"feature":"match_info","category":"match_info","key":"pseudo_match_id","value":"c03af125-b319-449a-9b6f-1310073f3f86"}
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| match_outcome | victory/defeat | When local player wins/loses. | See notes | 137.0 |
| match_start | null | When a match started. | See notes | 218.0 |
| match_end | null | When a match ended. | See notes | 218.0 |
pseudo_match_id note
Data example:
{"feature":"match_info","category":"match_info","key":"pseudo_match_id","value":"c03af125-b319-449a-9b6f-1310073f3f86"}
match_outcome note
Data Example:
{"events":[{"name":"match_outcome","data":"defeat"}]}
{"events":[{"name":"match_outcome","data":"victory"}]}
match_start note
Data Example:
{"events":[{"name":"match_start","data":""}]}
match_end note
Data Example:
{"events":[{"name":"match_end","data":""}]}