IOverlayHotkeys

Electron APIs / overlay / IOverlayHotkeys

Manages the registration, update, and removal of overlay hotkeys.

Handling of user-defined or programmatically assigned hotkeys that interact with the overlay during gameplay.

Hotkeys are identified by unique names and support modifier keys and passthrough options.

Methods

all()

all(): IOverlayHotkey[];

Get all active hotkeys.

Returns

IOverlayHotkey[]

---

register()

register(hotKey: IOverlayHotkey, callback: HotkeyCallback): void;

Register a new hotkey.

Parameters

Parameter	Type
hotKey	IOverlayHotkey
callback	HotkeyCallback

Returns

void

Example

const hotkey: IOverlayHotkey = {
  name: "toggleOverlay",
  keyCode: 192, // `
  modifiers: { ctrl: true },
  passthrough: false,
};

overlay.hotkeys.register(hotkey, (hotKey, state) => {
  if (state === "pressed") {
    toggleOverlay();
  }
});

---

unregister()

unregister(name: string): boolean;

Remove hotkey by name. Return false if doesn't exits.

Parameters

Parameter	Type
name	string

Returns

boolean

Example

overlay.hotkeys.unregister("toggleOverlay");

---

unregisterAll()

unregisterAll(): void;

Clear all hotkeys.

Returns

void

---

update()

update(hotKey: IOverlayHotkey): boolean;

Update an existing hotkey. Return false if hotkey doesn't exist.

Parameters

Parameter	Type
hotKey	IOverlayHotkey

Returns

boolean

Example

const updatedHotkey: IOverlayHotkey = {
  name: "toggleOverlay",
  keyCode: 192, // `
  modifiers: { ctrl: true, alt: true },
  passthrough: false,
};

overlay.hotkeys.update(updatedHotkey);