League of Legends

League of Legends game events.

 

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

Game ID

  • 5426

Sample apps

 

Available Features:

  • matchState
  • death
  • respawn
  • abilities
  • kill
  • assist
  • gold
  • minions
  • summoner_info
  • gameMode
  • teams
  • level
  • announcer.

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()

overwolf.games.events.onInfoUpdates2.addListener(function(data) {

if (data.info.summoner_info && data.info.name) {
 // do something interesting with the value (summoner name)
}

if (data.info.summoner_info && data.info.champion) {
 // do something interesting with the value (champion)
}
});

It is also possible to get the current available information using overwolf.games.events.getInfo()

Feature Information
summoner_info
Key Category Values Notes Since Version
id summoner_info The user’s Summoner Id Fired immediately with game start  0.7.0
region summoner_info

The user’s region (EUE, EUW, etc.)

"region":"EUW"
   0.7.0
champion summoner_info

the name of the selected champion

"champion":"Chogath"

All champion names (provided by the Overwolf Game Events Provider) match the champion-key from the Riot API, except for Fiddlesticks.

  • Game Events Provider value: “FiddleSticks”
  • Riot API value: “Fiddlesticks”
0.7.0
level summoner_info

The user’s summoner level

"level":"137"
  0.120.0
tier summoner_info

The user’s tier in his most played queue

"tier":"GOLD"
  0.120.0
division summoner_info

The user’s division in his most played queue

"division":"V"
   0.120.0
queue summoner_info

The most played match queue

"queue":"RANKED_SOLO_5x5"
   0.120.0
accountId summoner_info

The user’s account id

"key":"accountId","value":"224346930"
   0.120.0

gameMode

* Not available at the moment

Key Category Values Notes Since Version
 gameMode  game_info tutorial, spectator, ranked, custom    0.14.0

teams

 
Key Category Values Notes Since Version
 teams  game_info  A URI – decoded string that represents a JSON object with the teams formation  Need to decodeURI() the value and then JSON.parse() the result. See example below.  0.7.0

Lets assume we save the data in a variable called “info”. It will be the equivalent of:

var info = {"info":[{"category":"game_info","key":"teams","value":
"%5B%7B%22team%22:%22Order%22,%22champion%22:%22Riven%22,%22skinId%22:%227%22,%22summoner%22:%22ruizete%22%7D,
%7B%22team%22:%22Order%22,%22champion%22:%22Twitch%22,%22skinId%22:%228%22,%22summoner%22:%22heaser%22%7D,
%7B%22team%22:%22Order%22,%22champion%22:%22Vi%22,%22skinId%22:%222%22,%22summoner%22:%22hono%20kyumin%22%7D,
%7B%22team%22:%22Order%22,%22champion%22:%22Brand%22,%22skinId%22:%225%22,%22summoner%22:%22s%C3%A2baki%22%7D,
%7B%22team%22:%22Order%22,%22champion%22:%22Kennen%22,%22skinId%22:%226%22,%22summoner%22:%22fupnlul%22%7D,
%7B%22team%22:%22Chaos%22,%22champion%22:%22Nunu%22,%22skinId%22:%226%22,%22summoner%22:%22john1126y%22%7D,
%7B%22team%22:%22Chaos%22,%22champion%22:%22Orianna%22,%22skinId%22:%220%22,%22summoner%22:%22lp%20omg%20cartman%22%7D,
%7B%22team%22:%22Chaos%22,%22champion%22:%22Ryze%22,%22skinId%22:%227%22,%22summoner%22:%22bigmoney%C5%82egolas%22%7D,
%7B%22team%22:%22Chaos%22,%22champion%22:%22Malzahar%22,%22skinId%22:%220%22,%22summoner%22:%22hell0w0rld%22%7D,
%7B%22team%22:%22Chaos%22,%22champion%22:%22Kayn%22,%22skinId%22:%220%22,%22summoner%22:%22erikolo878%22%7D%5D"}]} 

So now we will decode the value:

var decoded = decodeURI(info.info[0].value);

And get:

"[{"team":"Order","champion":"Riven","skinId":"7","summoner":"ruizete"},
{"team":"Order","champion":"Twitch","skinId":"8","summoner":"heaser"},
{"team":"Order","champion":"Vi","skinId":"2","summoner":"hono kyumin"},
{"team":"Order","champion":"Brand","skinId":"5","summoner":"sâbaki"},
{"team":"Order","champion":"Kennen","skinId":"6","summoner":"fupnlul"},
{"team":"Chaos","champion":"Nunu","skinId":"6","summoner":"john1126y"},
{"team":"Chaos","champion":"Orianna","skinId":"0","summoner":"lp omg cartman"},
{"team":"Chaos","champion":"Ryze","skinId":"7","summoner":"bigmoneyłegolas"},
{"team":"Chaos","champion":"Malzahar","skinId":"0","summoner":"hell0w0rld"},
{"team":"Chaos","champion":"Kayn","skinId":"0","summoner":"erikolo878"}]"}

Now we will parse the string:

var teams = JSON.parse(decoded);

 And get a json array with the teams

 

Noteteams info-update might be provided a bit late in some game modes (a few seconds before the loading screen ends), this is a known issue and we’re working on a fix.

gold  
Key Category Values Notes Since Version
 gold  game_info  numeric value – amount of gold    0.7.0
minions  
Key Category Values Notes Since Version
minionKills game_info amount of enemy minions killed by the player    0.7.0
neutralMinionKills game_info amount of neutral minions killed by the player    0.7.0
matchState
Key Category Values Notes Since Version
 matchStarted  game_info  “True”/”False” (string)    0.14.0
 matchOutcome  game_info  win/lose    0.14.0
matchId game_info The current match id
"matchId":"3828196424"
  0.120.0
queueId game_info

The current match queue id

"queueId":"440"
 List of possible queue ids 0.120.0
level
Key Category Values Notes Since Version
 level  level  the level number of the player    0.19.0
kill
Key Category Values Notes Since Version
kills game_info Total kills in the match   0.35
doubleKills game_info Total double-kills in the match   0.35
tripleKills game_info Total triple-kills in the match   0.35
quadraKills game_info Total quadra-kills in the match   0.35
pentaKills game_info Total penta-kills in the match   0.35
death
Key Category Values Notes Since Version
 deaths  game_info  Number of deaths for this session    0.77.4

Events:

Feature Information
 death  
Event Event Data Fired when Notes Since Version
death Number of deaths for this session. The player’s champion died.    0.77.4
respawn
Event Event Data Fired when Notes Since Version
respawn null The player’s champion respawned.    0.77.4
 kill  
Event Event Data Fired when Notes Since Version
kill

A JSON containing:

  • count: Number of times this kill type happened in the match
  • label: kill / double_kill / triple_kill / quadra_kill / penta_kill
  • totalKills: The total kills in this match
Killing another champion   0.7.0
 assist  
Event Event Data Fired when Notes Since Version
assist Number of times this event happened in the match When you assists killing another champion   0.7.0
 matchState  
Event Event Data Fired when Notes Since Version
 matchStart  null  Match has started    0.14.0
 matchEnd  null  Match is ended    0.14.0
abilities
Event Event Data Fired when Notes Since Version
ability ability number player use an ability
  • abilityies are numbered between 1-4
  • “ability” event is fired when the player clicked on the ability key (but he may cancel the ability action later) 
0.14.0

usedAbility

 

 

JSON containing: “type” with the ability number between 1-4

Example: { type: "4" } for ult

player activated the ability “usedAbility” fired when the player actually activated the ability.  0.31.0
announcer
Event Event Data Fired when (announcement) Notes Since Version
welcome_rift null “Welcome to Summoner’s Rift!”   0.75.0
minions_30_sec null

 

“Thirty seconds until minions spawn!”    0.75.0
minions_spawn

null

“Minions have spawned!”   0.75.0
first_blood

null

“First Blood!”   0.75.0
slain

“team”

“An enemy has been slain!!”   0.75.0
self_slain

“team”

“You have slain an enemy!!”   0.75.0
killing_spree

“team”

“Killing Spree!”   0.75.0
rampage

“team”

“Rampage!”   0.75.0
unstoppable

“team”

“Unstoppable!”   0.75.0
dominating

“team”

“Dominating!”   0.75.0
godlike

“team”

“Godlike!”   0.75.0
legendary

“team”

“Legendary!”   0.75.0
double_kill “team” “Double Kill!”   0.75.0
triple_kill “team” “Triple Kill!”   0.75.0
quadra_kill “team” “Quadra Kill!”   0.75.0
penta_kill “team” “Penta Kill!”   0.75.0
slain “enemy” “An ally has been slain!”   0.75.0
slain_self “enemy” “You have been slain!”   0.75.0
killing_spree “enemy” “Enemy Killing Spree!”   0.75.0
rampage “enemy” “Enemy Rampage!”   0.75.0
unstoppable “enemy” “An enemy is Unstoppable!”   0.75.0
dominating “enemy” “An enemy is Dominating!”   0.75.0
godlike “enemy” “An enemy is Godlike!”   0.75.0
legendary “enemy” “An enemy is Legendary!”   0.75.0
double_kill “enemy” “Enemy Double Kill!”   0.75.0
triple_kill “enemy” “Enemy Triple Kill!”   0.75.0
quadra_kill “enemy” “Enemy Quadra Kill!”   0.75.0
penta_kill “enemy” “Enemy Penta Kill!”   0.75.0
executed “minion” “Executed!”   0.81.5
executed “tower” “Executed!”   0.81.5
shutdown null “Shut down!”   0.75.0
ace null “Aced!”   0.75.0
turret_destroy “team” “Your turret has been destroyed!”   0.75.0
inhibitor_destroy “team” “Your inhibitor has been destroyed!”   0.75.0
inhibitor_respawn “team” “Your inhibitor is respawning soon!”   0.75.0
turret_destroy “enemy” “Your team has destroyed a turret!”   0.75.0
inhibitor_destroy “enemy” “Your team has destroyed an inhibitor!”   0.75.0
inhibitor_respawn “enemy” “The enemy’s inhibitor is respawning soon!”   0.75.0
defeat null “Defeat!”   0.75.0
victory null “Victory!”   0.75.0

3rd party API’s:

  • Riot Games API | API
    • Important notes:
      • Riot Games’ policy is that any Overwolf app developed specifically for League of Legends shall not have a direct interaction with the player’s LoL experience. For example, it is OK to show general item builds, or match history – but not OK to automate builds based on the items that the other team is buying. In case of doubt, please contact developers@overwolf.com with a description of your idea.
      • Please make sure you don’t abuse Riot API endpoints rate limit, more details can found here.
  • League of Legends client API (rift-explorer)
  • (Another) League of Legends Client API
  • Champion.GG | API
  • Elophant | API

* Riot Games’ policy is that any Overwolf app developed specifically for League of Legends shall not have a direct interaction with the player’s LoL experience. For example, it is OK to show general item builds, or match history – but not OK to automate builds based on the items that the other team is buying. In case of doubt, please contact developers@overwolf.com with a description of your idea.