Rocket League

Please use the Developers version of Overwolf to get the latest Overwolf Game Events Provider.
(Rocket League events are currently available only in the Developers channel, and will be added in the near future to Overwolf’s public version)

 

When an app wants to receive events from the Game Events Provider it needs to set the requested features from the Game Events Provider.
Each feature contains a set of events or info update notifications that can be triggered.
Events can have event data attached to them.

So for example when an app requires Rocket League features like the following:

overwolf.games.events.setRequiredFeatures(['stats', 'match'], function(info) {
console.log(info);
});

the app could receive the stats and match events.

so listening to game events this way:

overwolf.games.events.onNewEvents.addListener(function(info) {
console.log('EVENT FIRED: ' + JSON.stringify(info));
});

will print to the console these lines when the events will be triggered:

EVENT FIRED: {"events":[{"name":"matchStart","data":""}]}
EVENT FIRED: {"events":[{"name":"goal","data":"{\r\n \"steamId\": \"76561198032746532\",\r\n \"score\": \"65\",\r\n \"goals\": \"1\",\r\n \"deaths\": \"0\",\r\n \"name\": \"Alon (client)\",\r\n \"team\": \"1\"\r\n}"}]}

and listening to event info updates this way:

overwolf.games.events.onInfoUpdates2.addListener(function(info) {
          console.log("Info UPDATE: " + JSON.stringify(info));
      });

will print to the console when the a relevant info gets updated:

Info UPDATE: {"info":{"matchState":{"started":"True"}},"feature":"match"}

 Sample app

Game id: 10798

Events:

Feature  Event name Provided Info  Fired when  Comments Since Version 
stats goal
  • steamId – the steam id of the player that score the goal

  • score – the score of the player that scored the goal

  • goals – the goals count of the player

  • deaths – the deaths count of the player

  • name –  the name of the player that scored the goal

  • team – the team number of the player (1 or 2)
A goal has been scored Encoded stringified JSON containing the properties.
Need to do a decodeURI() on the value and the JSON.parse() on the result
0.14.0 
stats score
  • steamId – the steam id of the player
  • score – the score of the player
  • goals – the goals count of the player
  • deaths – the deaths count of the player
  • name –  the name of the player
  • team – the team number of the player (1 or 2)
the score of a player has changed encoded stringified JSON containing the properties.
Need to do a decodeURI() on the value and the JSON.parse() on the result
0.14.0
match matchStart
  • null
match starts   0.14.0 
match matchEnd
  • null
match ends   0.14.0
roster rosterChange
  • Array containing the players info
A player leaves/ enters a match   0.14.0 
roster

playerJoined

 
  • steamId – the steam id of the player
  • score – the score of the player
  • goals – the goals count of the player
  • deaths – the deaths count of the player
  • name –  the name of the player
  • team – the team number of the player (1 or 2)
 

A player joins the match

   0.24.0
roster

playerLeft

 
  • steamId – the steam id of the player
  • score – the score of the player
  • goals – the goals count of the player
  • deaths – the deaths count of the player
  • name –  the name of the player
  • team – the team number of the player (1 or 2)
 

A player leaves the match

   0.24.0

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 Category Key Value Comments Since Version 
roster playersInfo player0 / player1 … palyerN
(N = number of players in the match)
  • Encoded stringified JSON containing the properties:
    • steamId – the steam id of the player that died
    • score – the score of the player that died
    • goals – the goals count of the player
    • deaths – the deaths count of the player
    • name –  the name of the player that died
    • team – the team number of the player (1 or 2)
Encoded stringified JSON containing the properties.
Need to do a decodeURI() on the value and the JSON.parse() on the result
0.14.0 
roster

teamsInfo

team1 / team2

  • Encoded stringified array of strings indicating the players ids for each team.
    Each id corresponds to an id under the playersInfo category.
  0.24.0
me me steamId
  • The player’s steam id
  0.14.0 
me me name
  • The player’s name
  0.14.0 
me me goals
  • The player’s goals count
  0.14.0 
me me score
  • The player’s score
  0.14.0 
me me deaths
  • The player’s death count
  0.14.0 
me me team
  • The player’s team number
  0.14.0 
match matchState started
  • true/false
  0.14.0