Skip to main content

ActiveGameInfo

Electron APIs / overlay / ActiveGameInfo

Info about the currently running game.

Combines general game metadata, window information, and input interception state, allowing the overlay to assess readiness and manage behavior accordingly.

Example

const activeGameInfo = overlay.getActiveGameInfo();
if (activeGameInfo?.gameInfo) {
console.log(`The active game is ${activeGameInfo.gameInfo.title}`);
}

Properties

PropertyModifierTypeDescription
gameInforeadonlyGameInfoInformation about the currently running game. See GameInfo.
gameInputInforeadonlyGameInputInterceptionInput interception state between the overlay and the game. See GameInputInterception.
gameWindowInforeadonlyGameWindowInfoWindow-specific details for the running game. See GameWindowInfo.