Rocket League Game Events
Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
Game ID
10798
Sample Apps
Available Features
Game events status
It's recommended to communicate errors and warnings to your users. You can check game event status here or easily verify event status directly from your app using our API.
stats
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| goal | Check notes | A goal has been scored | See notes | 14.0 |
| death | null | Player has died | Currently not supported | 86.0 |
| score | Check notes | Score of a player has changed | See notes | 86.0 |
goal note
Event Data:
- steamId – Steam id of the player scoring the goal
- score – Score of the player scoring the goal
- goals – Goal count of the player
- deaths – Death count of the player
- name – Name of the player scoring the goal
- team – Team number of the scoring player (1 or 2)
Comments:
Encoded stringified JSON containing the properties. Need to do a decodeURI() on the value and then JSON.parse() on the result
score note
Event Data:
- steamId – Steam ID of the player
- score – Score of the player
- goals – Goal count of the player
- deaths – Death count of the player
- name – Name of the player
- state
- team_score
- team – Team number of the player (1 or 2)
- index
Comments:
Encoded stringified JSON containing the properties. Need to do a decodeURI() on the value and the JSON.parse() on the result
teamGoal
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| teamGoal | null | When the local player’s team has scored a goal | 131.0 |
opposingTeamGoal
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| opposingTeamGoal | null | When the opposing team has scored a goal | 131.0 |
match
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| started | matchState | true / false | 14.0 | |
| ended | matchState | true / false | 86.0 | |
| matchType | matchInfo | Current match type | See notes | 86.0 |
| ranked | matchInfo | True if the match is ranked, false otherwise "True/False" | 86.0 | |
| maxPlayers | matchInfo | Maximum number of players allowed in this match | See notes | 86.0 |
| gameMode (Not Available) | matchInfo | Game mode of the match | See notes | 86.0 |
| gameState | matchInfo | Current state of the game | See notes | 86.0 |
| gameType | matchInfo | Current game type | 86.0 |
matchType note
Data Example:
[“Lobby” | “Private” | “Online” | “Offline”]
maxPlayers note
(integer – use parseInt)
gameMode note
Data Example:
[“soccer” | “basketball”, “hockey”, “items”, “volleyball”, “breakout”, “playTest”]
gameState note
Data Example:
[“waitingForPlayers” | “countdown | “active” | “postGoalScored”]
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| matchStart | null | Match starts | 14.0 | |
| matchEnd | null | Match ends | 14.0 | |
| victory | null | team_score (1 / 2)(1 – Victory, 2 - defeat) | 86.0 | |
| defeat | null | team_score (1 / 2)(1 – Victory, 2 - defeat) | 86.0 |
match_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| pseudo_match_id | match_info | Current session’s internal ID code. | See notes | 130.0 |
pseudo_match_id note
Data Example:
0c0ea3df-97ea-4d3a-b1f6-f8e34042251f
roster
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| player0 / player1 … palyerN(N = number of players in the match) | playersInfo | Check notes | See notes | 14.0 |
| team1 / team2 | teamsInfo | Check notes | See notes | 24.0 |
| team1_score / team2_score | teamsScore | team1 / team2 score – integer | See notes | 86.0 |
player note
- Encoded stringified JSON containing the properties:
- steamId – Steam ID of the player who died
- score – Score of the player who died
- goals – Goal count of the player
- deaths – Death count of the player
- name – Name of the player that died
- team – Team number of the player (1 or 2)
Comment:
Encoded stringified JSON containing the properties. Need to do a decodeURI() on the value and then JSON.parse() on the result.
teamsInfo note
Value:
Encoded stringified array of strings indicating the players IDs for each team. Each ID corresponds to an ID under the playersInfo category.
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| rosterChange | Array containing players' information | A player leaves or joins the match | 14.0 | |
| playerJoined | Check notes | A player joins the match | See notes | 24.0 |
| playerLeft | Check notes | A player leaves the match | See notes | 24.0 |
playerJoined note
Event Data:
- steamId – Steam ID of the player
- score – Score of the player
- goals – Goal count of the player
- deaths – Death count of the player
- name – Name of the player
- team – Team number of the player (1 or 2)
playerLeft note
Event Data:
- steamId – Steam ID of the player
- score – Score of the player
- goals – Goal count of the player
- deaths – Death count of the player
- name – Name of the player
- team – Team number of the player (1 or 2)
me
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| steamId | me | Player’s Steam ID | 14.0 | |
| name | me | Player’s name | 14.0 | |
| goals | me | Player’s goal count | 14.0 | |
| score | me | Player’s score | 14.0 | |
| deaths | me | Player’s death count | 14.0 | |
| team | me | Player’s team number | 14.0 | |
| team_score | me | Team score | 86.0 |