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

Rocket League game events sample app

Available Features

gep_internal
stats
teamGoal
opposingTeamGoal
match
roster
me
match_info

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.

`gep_internal`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
gep_internal	gep_internal	Local + Public version number	See notes	143.0

gep_internal note

Data Example:

{"info":{"gep_internal":{"version_info":"{"local_version":"157.0.1","public_version":"157.0.1","is_updated":true}"}},"feature":"gep_internal"}

`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)
local – Whether the player who scored is the local player

Comments:

Encoded stringified JSON containing the properties. Need to do a decodeURI() on the value and then JSON.parse() on the result

Data Example:

{"events":[{"name":"goal","data":"{  "steamId": "0",  "score": 118,  "goals": "1",  "deaths": "0",  "name": "Ram is troll",  "state": "0",  "team_score": 1,  "team": "2",  "local": "1",  "index": 3}"}]}

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

Data Example:

{"info":{"me":{"team_score":"0"}},"feature":"me"}
{"info":{"teamsScore":{"team1_score":"0"}},"feature":"roster"}
{"info":{"teamsScore":{"team2_score":"0"}},"feature":"roster"}
{"info":{"me":{"score":"725"}},"feature":"me"}

`teamGoal`

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
teamGoal	null	When the local player’s team has scored a goal	See notes	131.0

teamGoal note

Data Example:

{"events":[{"name":"teamGoal","data":"{"steamId":"2535424769966317","score":126,"goals":"1","deaths": "0","name":"JteRushencroks0","state":"0","team_score":2,"team":"1","index":4}"}]}

`opposingTeamGoal`

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
opposingTeamGoal	null	When the opposing team has scored a goal	See notes	131.0

opposingTeamGoal note

Data Example:

{"events":[{"name":"opposingTeamGoal","data":"{"steamId":"2535461211167231","score":128,"goals":"1",  "deaths":"0","name":"JaffaCake200015","state":"0","team_score":1,"team":"1","index":2}"}]}

`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	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”]

Data Example:

{"info":{"matchInfo":{"matchType":"Online"}},"feature":"match"}

maxPlayers note

(integer – use parseInt)

Data Example:

{"info":{"matchInfo":{"maxPlayers":"6"}},"feature":"match"}

gameMode note

Data Example:

[“soccar” | “basketball”, “hockey”, “items”, “volleyball”, “breakout”, “playTest”]

gameState note

Data Example:

{"info":{"matchInfo":{"gameState":"WaitingForPlayers"}},"feature":"match"}

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
matchStart	null	Match starts	See notes	14.0
matchEnd	null	Match ends	See notes	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

matchStart note

Data Example:

{"events":[{"name":"matchStart","data":""}]}

matchEnd note

Data Example:

{"events":[{"name":"matchEnd","data":""}]}

victory note

Data Example:

{"events":[{"name":"victory","data":"{"team_score":5}"}]}

defeat note

Data Example:

{"events":[{"name":"defeat","data":"{"team_score":0}"}]}

`match_info`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
pseudo_match_id	match_info	Current match’s internal ID code.	See notes	130.0
mutator_settings	match_info	The current-chosen settings of the private match.	See notes	147.0
arena	match_info	The current private match's arena setting.	See notes	147.0
server_info	match_info	The info of the current match's server info.	See notes	147.0

pseudo_match_id note

Data Example:

0c0ea3df-97ea-4d3a-b1f6-f8e34042251f

mutator_settings note

Data Example:

{"info":{"match_info":{"mutator_settings":"SmallBall,HighBounciness,FastBall,LightBall,Pinball,BotsNone"}},"feature":"match_info"}

arena note

Data Example:

{"info":{"match_info":{"arena":"Random"}},"feature":"match_info"}

server_info note

Data Example:

{"info":{"match_info":{"server_info":"EU511-Gimbal9"}},"feature":"match_info"}

`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.

Data Example:

{"info":{"playersInfo":{"player0":"%7B%22steamId%22:%222535441382512370%22,%22score%22:0,%22goals%22:%220%22,%22deaths%22:%220%22,%22name%22:%22Grexio%22,%22state%22:%220%22,%22team_score%22:0,%22team%22:%221%22,%22index%22:0%7D"}},"feature":"roster"}

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.

Data Example

{"info":{"teamsInfo":{"team1":"%5B%22player0%22%5D"}},"feature":"roster"}

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
rosterChange	Array containing players' information	A player leaves or joins the match	See notes	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

rosterChange note

Data Example:

{"events":[{"name":"rosterChange","data":"{"roster":[{"steamId":"1","score": 0,"goals":"0","deaths":"0","name":"Fury","state":"64","team_score": 1,"team":"1","index":0},{"steamId":"2535423426833677","score":0,"goals": "0","deaths":"0","name":"IISGoAt708","state":"0","team_score": 3,"team":"2","index":1},{"steamId":"2535428144972964","score": 34,"goals":"0","deaths":"0","name":"Joschy900","state":"0","team_score": 1,"team":"1","index":2},{"steamId": "2535424769966317","score":0,"goals":"0","deaths":"0","name":"JteRushencroks0","state": "0","team_score":1,"team":"1","index":3},{"steamId": "76561198045142971","score":455,"goals":"3","deaths":"0","name":"Klide", "state":"0","team_score":3,"team":"2","index":4},{ "steamId":"4193393565673947567","score":62,"goals":"0","deaths":"0","name": "YAHHOLAND","state":"0","team_score":3,"team":"2","index":5}]}"}]}

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)

Data Example:

{"events":[{"name":"playerJoined","data":"{"steamId":"2535428144972964","score":0,"goals": "0","deaths":"0","name":"Joschy900","state":"0\","team_score":0,"team":"1","index": 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)

Data Example:

{"events":[{"name":"playerLeft","data":"{"steamId":"156382600742638838","score":52,"goals":"0",  "deaths":"0","name":"JHONNYHS","state":"0","team_score":1,"team":"2","index": 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	Currently not supported	14.0
team	me	Player’s team number		14.0
team_score	me	Team score		86.0

me note

Data Examples:

{"info":{"me":{"goals":"1"}},"feature":"me"}
{"info":{"me":{"score":"102"}},"feature":"me"}
{"info":{"me":{"team_score":"1"}},"feature":"me"}