IOverlayHotkey

Electron APIs / overlay / IOverlayHotkey

Represents an overlay hotkey configuration.

Defines:

• Unique name.
• Main keycode.
• Optional modifier keys.
• Passthrough behavior.

Example

const screenshotHotkey: IOverlayHotkey = {
  name: "take-screenshot",
  keyCode: 80, // p
  modifiers: { ctrl: true, alt: true },
  passthrough: false,
};

Properties

Property	Type	Description
keyCode	number	Primary key code for the hotkey. Use standard keyboard codes.
modifiers?	object	Modifier keys that must be pressed along with the main key.
modifiers.alt?	boolean	Used for alt ket.
modifiers.ctrl?	boolean	Used for ctrl key.
modifiers.custom?	number	Custom key binding. Use key code.
modifiers.meta?	boolean	Use for the windows or command key.
modifiers.shift?	boolean	Used for shift key.
name	string	Unique name of the hotkey.
passthrough?	boolean	Controls whether the hotkey will be passed through to the underlying game. - If true, the hotkey will be captured by the overlay and pass to the game. - If false, the hotkey will be captured exclusively by the overlay. Default false