Skip to main content

overwolf.settings.games API

Use this API to view the game-settings features functions.

important

Please read our best practices for using game settings can be found here.

Special OW URL's

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

  • 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 Reference

Events Reference

Types Reference

getOverlayEnabled(gameClassId, callback)

Version added: 0.112

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

ParameterTypeDescription
gameClassIdintThe game ID for which the flag is retrieved for
callback(Result: OverlayEnabledResult) => voidA callback function which will be called with the status of the request

getAutoLaunchEnabled(gameClassId, callback)

Version added: 0.112

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

ParameterTypeDescription
gameClassIdintThe game ID for which the flag is retrieved for
callback(Result: AutolaunchEnabledResult) => voidA callback function which will be called with the status of the request

setAutoLaunchEnabled(gameClassId, callback)

Version added: 0.173

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

ParameterTypeDescription
gameClassIdintThe game ID for which the flag is set
enabledboolwhether auto-launch should be enabled
callback(Result: AutolaunchEnabledResult) => voidA callback function which will be called with the status of the request

onOverlayEnablementChanged

Version added: 0.124

Fired when the overlay is enabled or disabled for a game, with the following structure: OverlayEnablementChangedEvent Object

Event Data Example: Success

{ "gameId": 7764, "enabled": false}

onAutoLaunchEnablementChanged

Version added: 0.124

Fired when auto launch is enabled or disabled for a game, with the following structure: AutoLaunchEnablementChangedEvent Object

OverlayEnabledResult Object

ParameterTypeDescription
successbooleaninherited from the "Result" Object
errorstringinherited from the "Result" Object
enabledboolean

Example data: Success

{
"enabled": true
}

AutolaunchEnabledResult Object

ParameterTypeDescription
successbooleaninherited from the "Result" Object
errorstringinherited from the "Result" Object
autoLaunchEnabledboolean

Example data: Success

{
"autoLaunchEnabled": true
}

OverlayEnablementChangedEvent Object

ParameterTypeDescription
gameIdnumber
enabledboolean

Event data example


{ "gameId": 7764, "enabled": false }

AutoLaunchEnablementChangedEvent Object

ParameterTypeDescription
gameIdnumber
appIdstring
enabledboolean

Event data example


{ "gameId": 7764, "appId": "hffhbjnafafjnehejohpkfhjdenpifhihebpkhni", "enabled": false }