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 events status
It is highly recommended to communicate errors and warnings to your app users.
Check here the game events status. Or easily check the game events status 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 | 182.0 |
gep_internal note
Data Example:
{"gep_internal":{"version_info":"{"local_version":"182.0.1","public_version":"182.0.1","is_updated":true}"}},"feature":"gep_internal"}
game_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| player_class | me | The player's current class. | See notes | 217.0 |
player_class note
Data Example:
{"info":{"me":{"player_class":"DESTROYER"}},"feature":"game_info"}
match_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| mob_details | match_info | Details about the monster the player is fighting with. | See notes | 217.0 |
Events
| Event | Event Data | Fired When (announcement) | Notes | Since GEP Ver. |
|---|---|---|---|---|
| match_start | null | Match started. | See notes | 217.0 |
| match_end | null | Match ended. | See notes | 217.0 |
mob_details note
List of parameters:
- name - creature name
- grade - creature grade
- health - current creature health
- health_max - max health of the creature
- level - creature level
- health_phase - health phase of the creature
Data Example:
{"info":{"match_info":{"mob_details":"{\"name\":\"Rudric\",\"grade\":\"BOSS\",\"health\":1034510,\"health_max\":1034510,\"health_phase\":23,\"level\":17}"}},"feature":"match_info"}
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. |
|---|---|---|---|---|
| map | match_info | Map name | See notes | 227.0 |
| location | match_info | player location | See notes | 227.0 |
map note
Data Example:
{"info":{"match_info":{"map":"LV_ATM_Border_F_PS"}},"feature":"location"}
location note
Data Example:
{"info":{"match_info":{"location":"{\"x\":22869.693359,\"y\":20543.306641,\"z\":1633.370850}"}},"feature":"location"}
Loading...