Overview
Electron APIs / Overlay
APIs for controlling overlays in apps. Overlay is the ability to show a window on top of the current game window.
Standard mode
Standard mode is available in games where the mouse is enabled when playing the game. For example, in MOBA games such as League of Legends, Dota 2, and others, the mouse cursor is available, and therefore you are able to interact with the app windows without the need to pull keyboard and mouse focus input from the game.
Exclusive mode
Exclusive mode is available in games where the mouse is disabled when playing the game. For example, in FPS games such as CS2, Fortnite and others, there’s no mouse cursor, so the only way to interact with the Overwolf app window is by activating exclusive mode. This will show a semi-transparent window overlaid on the game window and doesn't allow keyboard or mouse input to pass into the game.
Interfaces
| Interface | Description |
|---|---|
| ActiveGameInfo | Current state of an actively running and detected game. |
| ExclusiveInputOptions | Configuration options for entering exclusive input mode in the overlay. |
| GameInputInterception | State of input handling between the game and the overlay system. |
| GameLaunchEvent | Event fired when a supported game is launched. |
| GameLaunchEventOptions | Configuration flags for launching or injecting the overlay into a game process. |
| GamesFilter | Filter used to specify overlay support in games. |
| GameWindowInfo | Information about a running game's window. |
| InjectionError | Error handler for the overlay injection process. |
| IOverlayHotkey | Hotkey configuration used by the overlay. |
| IOverlayHotkeys | Manages the registration, update, and removal of overlay hotkeys. |
| IOverwolfOverlayApi | API managing Overwolf overlay windows, hotkeys, input modes, and game integration. |
| OverlayBrowserWindow | Active overlay window instance. |
| OverlayOptions | Configuration options for creating or modifying an overlay window. |
| OverlayWindowOptions | Configuration options for an overlay window. |
Type Aliases
| Type Alias | Description |
|---|---|
| GameInfo | Information about a detected or running game. |
| GameInfoType | Type of the detected game. |
| GameProcessInfo | Information about a running game process. |
| GameWindowUpdateReason | Reason for a game window update event. |
| HotkeyCallback | Callback for handling hotkey events. |
| HotkeyState | Indicates the state of a hotkey event. |
| InstalledGameInfo | Information about a game installed on the user's system. |
| PassthroughType | Input passthrough settings: |
| ZOrderType | Overlay layering of overlapping windows along the z-axis (depth). |