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

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

Total number of kills in the match

   0.90.0
match
Key Category Values Notes Since Version
mode match_info

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

{"mode":"squad"}
   0.90.0
rank  
Key Category Values Notes Since Version
 me match_info

The player’s rank at the end of the match

   0.90.0
total_teams match_info

The total number of players

  0.90.0

 

location
Key Category Values Notes Since Version
 location game_info

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

  • Top-left is (0,0,z)
  • Map size is 800×800 (8 sq. KM)
  • z is the player’s altitude, (x,y,0) is sea level
  • 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\" : 230, \"y\" : 574, \"z\" : 152 }"}
   0.116.2
me  
Key Category Values Notes Since Version
 name  me

The player’s nickname

{"name":"itayG"}
   0.90.0
team  
Key Category Values Notes Since Version
nicknames match_info

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
Key Category Values Notes Since Version
 phase  game_info

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

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

The current map name

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

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    0.90.0
 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
killer
Event Event Data Fired when Notes Since Version
killer The killer’s nickname The local player was killed    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