Overview
Electron APIs / overlay
APIs for controlling and creating overlays in games. Overlay is the ability to show windows on top of the current game window.
Standard mode
Standard mode is used in games where the mouse is visible while playing the game. For example, in MOBA games such as League of Legends, Dota 2, and others, the mouse cursor is visible during gameplay, 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 used in games where the mouse is not visible while playing the game. For example, in FPS games such as Apex Legends, Fortnite and others, the mouse cursor is not visible during gameplay, so the only way to interact with the Overwolf app window is by entering 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 | Info about the currently running 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 game is launched. |
| GameLaunchEventOptions | Configuration options for controlling the type of overlay we inject. |
| GamesFilter | Filter object for game overlays. |
| GameWindowInfo | Information about a running game's window. |
| InjectionError | Error handler for the overlay injection process. |
| IOverlayHotkey | Represents an overlay hotkey configuration. |
| IOverlayHotkeys | Manages the registration, update, and removal of overlay hotkeys. |
| IOverwolfOverlayApi | APIs for managing Overwolf overlay windows, hotkeys, input modes, and game integration. |
| OverlayBrowserWindow | Represents an overlay window instance. |
| OverlayOptions | Overlay 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 | Type of input passthrough behavior for overlay windows. |
| ZOrderType | Type of overlay window stacking behavior. |