Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HotkeySystemRefMut

With a Hotkey System the runner can use hotkeys on their keyboard to control the Timer. The hotkeys are global, so the application doesn't need to be in focus. The behavior of the hotkeys depends on the platform and is stubbed out on platforms that don't support hotkeys. You can turn off a Hotkey System temporarily. By default the Hotkey System is activated.

Hierarchy

Index

Constructors

constructor

Properties

ptr

ptr: number

Methods

activate

  • activate(): boolean
  • Activates a previously deactivated Hotkey System. If it's already active, nothing happens.

    Returns boolean

config

deactivate

  • deactivate(): boolean
  • Deactivates the Hotkey System. No hotkeys will go through until it gets activated again. If it's already deactivated, nothing happens.

    Returns boolean

setConfig

  • Applies a new hotkey configuration to the Hotkey System. Each hotkey is changed to the one specified in the configuration. This operation may fail if you provide a hotkey configuration where a hotkey is used for multiple operations. Returns false if the operation failed.

    Parameters

    Returns boolean

Generated using TypeDoc