Skip to main content

ActiveGameInfo

Electron APIs / Overlay / ActiveGameInfo

Current state of an actively running and detected game.

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

Example

const activeGame = overlay.getActiveGameInfo();
if (activeGame?.gameInputInfo.canInterceptInput) {
console.log(`Overlay input active for ${activeGame.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.