Skip to main content
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. Alternately, you can easily check that status from your app itself, using our API.

gep_internal

Info Updates

keyCategoryValuesNotesSince GEP Ver.
gep_internalgep_internalLocal + Public version numberSee notes143.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

keyCategoryValuesNotesSince GEP Ver.
scenegame_infoThe current scene during the gameList of values See notes238.0

scene note

Possible values:

  • Menu - Main lobby menu
  • Running - While in game
  • Save - After save during a match

Data Example:

{"info":{"game_info":{"scene":"Menu"}},"feature":"game_info"}

match_info

Events

EventEvent DataFired WhenNotesSince GEP Ver.
match_startIn the beginning of each matchSee notes238.0
match_endAt the end of each matchSee notes238.0

match_start note

Data Example:

{"events":[{"name":"match_start","data":""}]}

match_end note

Data Example:

{"events":[{"name":"match_end","data":""}]}

location

Info Updates

keyCategoryValuesNotesSince GEP Ver.
location_cameralocationThe current POV location of the cameraSee notes241.0
location_playerslocationThe current location of the playersSee notes241.0
main_maplocationThe current main map nameSee notes241.0
sub_maplocationThe current sub map nameSee notes241.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 the 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"}