PUBG

PlayerUnknown’s Battlegrounds game events.

 

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

Game ID

  • 10906

PUBG Dev Challenge Sample Apps

Sample app

Available Features:

  • kill
  • revived
  • death
  • killer
  • match
  • rank
  • location
  • me
  • team
  • phase
  • map
  • roster

 

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
kill
Category Key Values Notes Since Version
match_info kills

Total number of kills in the match

Currently there is a known issue where if a teammate knocks out an enemy and local player finishes him off, he will not get the kill event.  0.90.0
match_info headshots

Total number of headshots in the match

  127.0.7
match_info total_damage_dealt Total damage dealt in the current match   127.0.7
match_info max_kill_distance Max kill distance in CM   127.0.7
match
Category Key Values Notes Since Version
match_info mode

[‘Solo’|’Duo’|’Squad’]

{"mode":"squad"}
   0.90.0
match_info match_id

The current match ID code.

 

Example:

 

match.bro.official.pc-2018-03.steam.solo.eu.2019.05.07.08.ce8d1a14-b2af-41c8-8bf4-d2a504326630
 Can be compared and checked at this link  120.0.0
 match_info pseudo_match_id

The current session’s ID code.

 

Example:

 

0c0ea3df-97ea-4d3a-b1f6-f8e34042251f
 This is an Overwolf-generated code which is unrelated to the match ID given above.  130.0.15
rank  
Category Key Values Notes Since Version
match_info  me

The player’s rank at the end of the match

   0.90.0
match_info total_teams

The total number of players

  0.90.0

 

location
Category Key Values Notes Since Version
game_info  location

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

  • Top-left is (0,0,z)
  • Large map (Miramar, Erangel, etc.) size is 8000×8000 (8 sq. KM)
  • Medium map (Vikendi) size is 6000×6000 (6 sq. KM)
  • Small map (Sanhok) size is 4000×4000 (4 sq. KM)
  • The location is being updated every two seconds while the player is in the airplane
  • The location is being updated every second while the user is not in the airplane (freefly or on the ground)
{"location":"{ \"x\" : 2300, \"y\" : 5740, \"z\" : 1520 }"}
   0.116.2
game_info safe_zone

The location of the white circle and its radius.

  • “x” & “y” are the center of the circle
  • “radius” – The circle’s radius.

Example:

{"info":{"game_info":{"safe_zone":"{\"x\":6727
,\"y\":2556,\"radius\":1507}"}},"feature":"location"}
  133.0.2
game_info blue_zone

The location of the blue circle and its radius.

  • “x” & “y” are the center of the circle
  • “radius” – The circle’s radius.

Example:

{"info":{"game_info":{"blue_zone":"{\"x\":6971
,\"y\":2540,\"radius\":5043}"}},"feature":"location"}
Ticks every second while the circle is closing. 133.0.2
game_info red_zone

The location of the red circle and its radius.

  • “x” & “y” are the center of the circle
  • “radius” – The circle’s radius.

Example:

{"info":{"game_info":{"red_zone":"{\"x\":6976
,\"y\":2541,\"radius\":500}"}},"feature":"location"}
  133.0.2
me  
Category Key Values Notes Since Version
me  name

The player’s nickname

{"name":"itayG"}
   0.90.0
me bodyPosition

The local player’s peek-position.

  • ‘leanLeft’
  • ‘leanRight’
  • ‘straight’
  0.128.0.13
me inVehicle

Whether local player is inside a vehicle or not.

Bool

  • ‘True’
  • ‘False’
Valid for the airplane as well. 0.128.0.13
me aiming

The player’s different type of aim-focus usage.

  • ‘null’
  • ‘focusedAim’
  • ‘aimDownSight’
  • ‘aimDownSight_holding_breath’
  0.128.0.13
me view

The player’s perspective (Third Person/First Person).

  • ‘TPP’
  • ‘FPP’
 This does not represent the game mode but rather the actual current view of the local player (can be changed by pressing ‘V’). 0.128.0.13
me freeView

When the local player uses ‘ALT’ feature to look around.

Bool

  • True
  • False
  0.128.0.13
me movement

The player’s type of movement speed.

  • ‘normal’
  • ‘fast’
  • ‘stealth’
 Relevant for running, vehicle movement, parachuting from airplane, etc. 0.128.0.13
inventory inventory_XX

Info about the inventory of the local player. Each “inventory_XX” object represents one item and is being cleared once this item is dropped/replaced by the player.

This info-update provides:

  • name (string) – name of the item
  • count (int) – number of items
{"feature":"me","category":"inventory","key":"inventory_1","value":
"{\"name\" : \"Item_Attach_Weapon_Muzzle_FlashHider_Medium_C_2\",\"count\" : \"1\"}"}

“inventory” includes items like ammo, attachments, etc.

Inventory dictionary

 130.0.9
inventory equipped_XX

Info about “equipable” items. Each “equipped_XX” object represents one item and is being cleared once this item is dropped/replaced by the player.

This info-update provides:

  • name (string) – the name of the item
  • count (int) – number of items
{"feature":"me","category":"inventory","key":"equipped_1","value":
"{\"name\" : \"Item_Weapon_vz61Skorpion_C_1\",\"count\" : \"1\"}"}

“equipped” includes weapons, helmets, vests, etc.

Inventory dictionary

 130.0.9
inventory weaponState

Info about the weapon and its state.

This info-update provides:

  • name (string) – the name of the weapon used by the local player
  • equipped (bool) – in hand (true) or holstered (false)
  • firing_mode – 0 = single, 1 = burst, 2 = full auto
{\"name\" : \"Weapvz61Skorpion_C_0\",\"equipped\" : \"true\",\"firing_mode\" : \"0\"}
   130.0.9
team  
Category Key Values Notes Since Version
match_info nicknames

The names of players in the player’s team

{"nicknames":"{\"team_members\" : [{\"player\" : \"yy899189\"},{\"player\" : \"itayG\"},
{\"player\" : \"fucis\"},{\"player\" : \"gedyan\"}]}"}},"feature":"team"}
   0.90.0
phase
Category Key Values Notes Since Version
game_info  phase

The game’s current state, can be one of the following:

  • ‘lobby’
  • ‘loading_screen’
  • ‘airfield’
  • ‘aircraft’
  • ‘freefly’
  • ‘landed’
   0.90.0
map
Category Key Values Notes Since Version
match_info map

The current map name

{"map":"Erangel_Main"}
 map names mapping  0.90.0
roster
Category Key Values Notes Since Version
match_info roster_XX

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

Each player that joins the game (during the “airfield” phase) will be reported in the following way:

{"feature":"roster","category":"match_info","key":"roster_0",
"value":"{\"player\":\"Dr4ex\",\"kills\":\"0\",\"out\":false}"}

 As you can see, this object includes:

  • player – Player name
  • kills – Number of kills. This field is being updated once the player leaves the game ( = died or quit the match)
  • out – “false” when the player is “alive”, “true” when the player left the game (died or quit the match) 

When a player “leaves” the match, the following info-update will be reported:

{"feature":"roster","category":"match_info","key":"roster_0",
"value":"{\"player\":\"Dr4ex\",\"kills\":\"0\",\"out\":true}"}
   0.119.1

 

Events

Feature Information
 kill  
Event Event Data Fired when Notes Since Version
kill null The local player killed another player  Currently there is a known issue where if a teammate knocks out an enemy and local player finishes him off, he will not get the kill event.  0.90.0
knockout null The local player knocked-out another player   127.0.7
headshot null The local player hit another player with a headshot   127.0.7
damage_dealt amount of damage dealt by the local player The local player “damaged” an enemy or himself This event can not be used in real time, as it can give an un-fair advantage to the user. You can use it post-match. 127.0.7
fire null When local player attacks. Relevant also for fists. 0.128.0.13
 revived
Event Event Data Fired when Notes Since Version
revived null The local player was revived    0.90.0
 death
Event Event Data Fired when Notes Since Version
death null The local player dies    0.90.0
knockedout null The local player is knocked-out    0.90.0
damageTaken null The local player receives damage. Not including damage taken when outside the zone. 0.128.0.13
killer
Event Event Data Fired when Notes Since Version
killer The killer’s nickname The local player was killed by one of the players When one of local player’s squad members kill the local player, the provided data will be “self_kill”  0.90.4
match
Event Event Data Fired when Notes Since Version
matchStart null Match started    0.90.0
matchEnd null Match ended    0.90.0
matchSummary null

The match summary screen (with the user’s rank) is shown

{"name":"matchSummary","data":""}
  0.120.0
me
Event Event Data Fired when Notes Since Version
jump null Local player jumps (space)   0.128.0.13