Apex Legends

Apex Legends game events.

Please read the overwolf.games.events documentation page to learn how to use Overwolf game events. 

Game ID

  • 21566

Sample app

Available Features:

  • me
  • team
  • kill
  • damage
  • death
  • revive
  • match_state
  • match_info
  • inventory
  • location
  • match_summary
  • roster
  • victory
  • kill_feed

Info Updates

The Game Events Provider keeps an info DB with various information about the game state.
Updates about this information can be received as events by registering an event listener using overwolf.games.events.onInfoUpdates2()
It is also possible to get the current available information using overwolf.games.events.getInfo()

Feature Information
me
Category Key Values Notes Since Version
me name

Name of local player

  0. 128.0.1
me ultimate_cooldown

The current ultimate ability cooldown of the local player.

Begins with 0 and stops at 100 when it’s ready.
Drops back to zero after the ultimate ability was used.
0.130.0.6
match_info
Category Key Values Notes Since Version
match_info pseudo_match_id

The current session’s ID code.

 

Example:

 

0c0ea3df-97ea-4d3a-b1f6-f8e34042251f
  0.130.0.15
match_state  
Category Key Values Notes Since Version
match_info match_state

active/inactive

  0.128.0.1
team
Category Key Values Notes Since Version
match_info teammate_X

This feature provides the list of your squad members.

Each teammate that joins the game will be reported in the following way:

{"info":{"match_info":{"teammate_0":"{\"name\":\"Sh4rgaas\",\"state\":\"alive\"}"}},"feature":"team"}

As you can see, this object includes:

  • player – Player name
  • state – alive/death/knockedout
 the teammate state is getting updated in real-time, depending on his current state. 0.128.0.1
match_info legendSelect_X

The name of the legend & order of selection for every member in the team, including who is the jump-master.

Example:

{"feature":"team","category":"match_info","key":"legendSelect_2","value":"{\"playerName\":\"Sh4rgaas\",\"legendName\":\
"#character_octane_NAME\",\"selectionOrder\":\"2\",\"lead\":true}"}

This object includes:

  • selection order
  • legend name
  • jumpmaster – Bool
  130.0.6
roster
Category Key Values Notes Since Version
match_info roster_XX

This feature provides the entire list of players (~60 players).

Each player that joins the game will be reported in the following way:

{"info":{"match_info":{"roster_3":"{\"name\":\"RunLikePistorius\",\"isTeammate\":false}"}},"feature":"roster"}

As you can see, this object includes:

  • player – Player name
  • teammate (Bool) – Player is a squad member/not
  0.128.0.1
location
Category Key Values Notes Since Version
game_info location

The player’s current grid location (x,y,z)
Notes:

  • Map Center is (0,0,z)
  • King’s Canyon appears to be 1×1 km.
  • The location is updated up to 2 updates in 1 second.
  • Location accuracy is 1 meter.
{"info":{"match_info":{"location":"{\"x\":\"93\",\"y\":\"305\",\"z\":\"49\"}"}},"feature":"location"}
  0.130.0.6
victory
Category Key Values Notes Since Version
match_info victory

This info update notifies at the end of the match and provides “true” for winning and “false” for losing.

  0.128.0.1
 match_summary
Category Key Values Notes Since Version
match_info match_summary

The following info is provided:

 

  • The final position the squad has reached (rank 1-20).
  • Total number of teams
  • Number of squad kills (total squad eliminated).

 

Example:

{"feature":"match_summary","category":"match_info","key":"match_summary"
,"value":"{\"rank\":\"12\",\"teams\":\"20\",\"squadKills\":\"5\"}"}
  0.130.0.6
 damage
Category Key Values Notes Since Version
me totalDamageDealt

The total amount of damage inflicted in 1 match of Apex.

Example:

{"feature":"damage","category":"me","key":"totalDamageDealt","value":668}
Important to note that the game does not count damage that is inflicted on Armor. Only after the armor was broken.
Our damage includes damage on armor aswell, so it will always be higher than game-damage.
0.130.0.6
inventory
Category Key Values Notes Since Version
me inventory_XX

The items that are picked up into the inventory slots of the local player (Tab).

Example:

{"feature":"inventory","category":"me","key":"inventory_0","value":
"{\"name\":\"Shotgun Shells\",\"amount\":\"36\"}"}
  0.130.0.6
me weapons

The weapons that are currently used by the local player (only 2 slots are available – 0 & 1).

Example:

{"category":"game_info","key":"weapons","value":"{\"weapon_0\":\
"mp_weapon_shotgun_pistol\",\"weapon_1\":\"mp_weapon_doubletake\",\
"active_0\":\"mp_weapon_doubletake\"}","valueLength":107}
   0.130.0.6
me inUse

Any item that is currently used by the local player.

Example:

{"feature":"inventory","category":"me","key":"inUse","value":"
{\"inUse\":\"Triple Take\"}"}
Important to note that this includes anything that appears in front of the screen (can be health packs/shield batteries/even ultimates).  0.130.0.6

Events

Feature Information
 kill  
Event Event Data Fired when Notes Since Version
kill victimName The local player killed another player   130.0.6
knockdown victimName The local player knocked out another player   130.0.6
assist victimName

The local player participated in a team member’s kill.

Provided values:

  1. victimName
  2. type – knockdown / elimination

Example:

{"name":"assist","data":"{\r\n  \"victimName\": \"VioletAlbicocca\",\r\n  \"type\": \"knockdown\"\r\n}"} 
  130.0.6
 revive
Event Event Data Fired when Notes Since Version
healed_from_ko null  Local player was revived from knocked out state.   0.128.0.1
respawn null Local player was returned at game beacon.   0.128.0.1
 death
Event Event Data Fired when Notes Since Version
knocked_out null The local player’s health drops to zero.   0.128.0.1
death null (in the future we will provide the killer name). The local player died during knocked out state. There is another health bar during knocked out state, it’s orange, above the player name. 0.128.0.1
match_state
Event Event Data Fired when Notes Since Version
match_start null Match started   0.128.0.1
match_end null Match ended   0.128.0.1
kill_feed
Event Event Data Fired when Notes Since Version
kill_feed

The following properties are provided:

 

  • attackerName
  • victimName
  • weaponName
  • action

When information is presented on the game’s UI (top right corner).

Example:

{"attackerName":"NerdGhela","victimName":"DJerryKhan"
,"weaponName":"energy_ar","action":"knockdown"}
  0.130.0.6
damage
Event Event Data Fired when Notes Since Version
damage

The following properties are provided:

  • targetName
  • damageAmount
  • armor
  • headshot
  • grenade

When information is presented on the game’s UI (top right corner).

Example:

{"name":"damage","data":"{\r\n  \"targetName\": \"masiqu22\",\r\n  \"damageAmount\": 
\"13.000000\",\r\n  \"armor\": \"true\",\r\n  \"headshot\": \"false\"\r\n}"}

  0.130.0.6