overwolf.games.launchers.events API
This API returns an object with launcher related events and info-updates (Currently supported only for the League of Legends Launcher).
Methods Reference
Events Reference
How to register for features
The Launcher Events Provider keeps an info DB with information about the launcher state.
Updates for these entries can be received as events by registering an event listener using overwolf.games.launchers.events.onInfoUpdates().
It is also possible to get the currently available information using overwolf.games.launchers.events.getInfo().
setRequiredFeatures(launcherClassId, features, callback)
Version added: 0.126
Sets the required features from the provider.
| Parameter | Type | Description |
|---|---|---|
| launcherClassId | int | Launcher ID of interest |
| features | string | String array of features to utilize |
| callback | function | Returns with the result |
Callback argument: Success
A callback function which will be called with the status of the request
{"status": "success", "supportedFeatures": Array(1)}
getInfo(launcherClassId, callback)
Version added: 0.126
Gets the current information for a given launcher id.
| Parameter | Type | Description |
|---|---|---|
| launcherClassId | int | The launcher Id of interest |
| callback | function | Provides the current game info |
Callback argument: Success
A callback function which will be called with the status of the request
{
"status":"success",
"res":{
"game_flow":{
"phase":"None"
},
"summoner_info":{
"account_id":"224346939",
"display_name":"itaygl",
"internal_name":"itaygl",
"profile_icon_id":"3902",
"summoner_id":"79489298",
"summoner_level":"31"
}
}
}
onInfoUpdates
Version added: 0.78
Fired when there are game info updates with a JSON object of the updates.
onNewEvents
Version added: 0.78
Fired when there are new game events with a JSON object of the events.