overwolf.settings.games

Returns an object with game-settings features functions.

  • More information and best practices for using game settings can be found here

 

You can also use the following helpful URLs to open the relevant Overwolf game settings in the Appstore:

URL What it does
overwolf://store/game-settings/game-id/[game-id]
  • A clickable link that opens the Overwolf (game-id) game settings window from your app
overwolf://store/game-settings/appid-id/[extension-id]
  • A clickable link that opens the Overwolf (targeted by your app) game settings window from your app

Methods

getOverlayEnabled(gameClassId, callback)

Version added: 0.112.1

Provides per-game settings as set by the user via the Overwolf store

  • Parameter: gameClassId <int>

    The game ID for which the flag is retrieved for

  • Parameter: callback <function>

Callback argument:
{status: "success", gameClassId: 5426, enabled: true}

getAutoLaunchEnabled(gameClassId, callback)

Version added: 0.112.1

Returns the current Auto-Launch enabled setting for the calling app in a given game (gameClassId)

  • Parameter: gameClassId <int>

    the game id for which the flag is retrieved for

  • Parameter: callback <function>

Callback argument:
{status: "success", gameClassId: 5426, autoLaunchEnabled: true}