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 | 143.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. |
|---|---|---|---|---|
| scene | game_info | The current scene during the game | List of values See notes | 238.0 |
scene note
Possible values:
- Menu - Main lobby menu
- Running - While in-game
- Save - After saving during a match
Data Example:
{"info":{"game_info":{"scene":"Menu"}},"feature":"game_info"}
match_info
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| match_start | In the beginning of each match | See notes | 238.0 | |
| match_end | At the end of each match | See notes | 238.0 |
match_start note
Data Example:
{"events":[{"name":"match_start","data":""}]}
match_end note
Data Example:
{"events":[{"name":"match_end","data":""}]}
location
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| location_camera | location | The current POV location of the camera | See notes | 241.0 |
| location_players | location | The current location of the players | See notes | 241.0 |
| main_map | location | The current main map name | See notes | 241.0 |
| sub_map | location | The current sub map name | See notes | 241.0 |
location_camera note
Data Example:
{"feature": "location", "category": "location", "key": "location_camera", "data": "[{\"x\":60.765,\"y\":-430.126,\"z\":24.668}]"}
location_players note
Data Example:
- This info-update includes the location of all 4 possible players and will update only the characters that are moving
{"feature": "location", "category": "location", "key": "location_players", "data": "[{\"player_0\":{\"x\":-1086.69,\"y\":-224.49,\"z\":-0.595}},{\"player_1\":{\"x\":-1089.05,\"y\":-218.029,\"z\":-0.414}},{\"player_2\":{\"x\":-1077.75,\"y\":-229.75,\"z\":-0.507}},{\"player_3\":{\"x\":-1082.75,\"y\":-206.75,\"z\":0.168}}]"}
main_map note
Data Example:
{"feature": "location", "category": "location", "key": "main_map", "data": "Wilderness"}
sub_map note
Data Example:
{"feature": "location", "category": "location", "key": "sub_map", "data": "CAMPSITE"}
Loading...