Skip to main content

overwolf.games.tracked API

important

Use this API to get information about games that are defined as unsupported in the Gameslist. Requires tracked under the launch_events property in the manifest.json

Methods Reference

Events Reference

Types Reference

getRunningGameInfo(callback)

Version added: 0.199

warning

Unsupported games will not necessarily be detected as expected, and are by their very nature unsupported by default. Please make sure to test this for the specific game before using it in production!

warning

This method will only work for games with a GameInfoType of type "game"!

If both tracked and track_all_games are set to true in the manifest, returns an object with information about the most recently launched game, similarly to the way overwolf.games.getRunningGameInfo() works.

Note: In a scenario when more than one game is running, we'll display information only from the latest one that was launched, including both "unsupported" and "supported" games.

ParameterTypeDescription
callback(Result: GetRunningGameInfoResult) => voidReturns info about the currently running game

onUnsupportedExecuted

Version added: 0.195

important

Requires tracked and track_all_games under the launch_events property in the manifest.json

Fired when an unsupported game process has launched.

onTerminated

Version added: 0.83

important

Requires tracked under the launch_events property in the manifest.json

Fired when an unsupported game process has terminated.

GetRunningGameInfoResult Object

ParameterTypeDescription
successboolean
errorstringnull if success is true
isInFocusboolReturns whether the game is currently in focus
isRunningboolReturns whether the game is currently running
allowsVideoCaptureboolReturns whether the game allows video to be captured
titlestringReturns the title of the game
idintReturns the game ID concatenated with the Instance ID of the game. Divide it by 10 and round down to get the game ID
classIdintReturns the game ID
widthintReturns the pixel width of the game window
heightintReturns the pixel height of the game window
logicalWidthintReturns the game-reported (logical) pixel width of the game window
logicalHeightintReturns the game-reported (logical) pixel height of the game window
processIdintReturns the current process id of the running game
renderersstring[]Returns an array of the rendering technology names supported by the running game
detectedRendererstringReturns the rendering technology detected by the running game
commandLinestringReturns the game process commandline
typeintReturns the process type as a number. See notes
typeAsStringstringReturns the process type as a string. See notes
windowHandleobjectReturns the current game window handle
monitorHandleobjectReturns the current monitor handle
overlayInfoOverlayInfo ObjectReturns info about the the running out of process overlays

Example data: Success

{
"success":true,
"isInFocus":false,
"isRunning":true,
"allowsVideoCapture":true,
"title":"Guild Wars",
"displayName":"",
"shortTitle":"",
"id":11361,
"classId":1136,
"width":1920,
"height":1080,
"logicalWidth":1920,
"logicalHeight":1080,
"processId": 3840,
"renderers":[
"D3D9"
],
"detectedRenderer":"Unknown",
"executionPath":"D:/Games/Guild Wars/Gw.exe",
"sessionId":"3ced63b755724fd4ab1d3d2a210aa764",
"commandLine":"\"D:/Games/Guild Wars/Gw.exe\"",
"type":0,
"typeAsString":"Game",
"windowHandle":{
"value":0
},
"monitorHandle":{
"value":0
}
}

GameInfoType enum

The type value for a process is determined by the gamelist entry for it.

OptionDescription
GameThis is a Game
LauncherThis is a launcher
ApplicationThis is an app