overwolf.games.launchers.events

This API returns an object with launchers related events and info-updates. (Currently supported only with League of Legends Launcher/Client)

Methods

setRequiredFeatures(launcherClassId, features, callback)

Version added: 0.126.0

Sets the required features from the provider.

  • Parameter: launcherClassId <int>

    The launcher Id of interest

  • Parameter: features <string>

    A string array of features to utilize.

  • Parameter: callback <function>

    Called with success or failure state.

Callback argument:
{status: "success", supportedFeatures: Array(1)}

getInfo(launcherClassId, callback)

Version added: 0.126.0

Gets the current state of information for a given launcher id

  • Parameter: launcherClassId <int>

    The launcher Id of interest

  • Parameter: callback <function>

    Provides the current game info.

Callback argument:
{  
   "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"
      }
   }
}

Events How to use events

onInfoUpdates

Version added: 0.126.0

Fired when there are game info updates with a JSON object of the updates.

onNewEvents

Version added: 0.126.0

Fired when there are new game events with a JSON object of the events information.