Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HotkeyConfigRefMut

The configuration to use for a Hotkey System. It describes with keys to use as hotkeys for the different actions.

Hierarchy

Index

Constructors

constructor

Properties

ptr

ptr: number

Methods

asJson

  • asJson(): any
  • Encodes the hotkey configuration as JSON.

    Returns any

setValue

  • Sets a setting's value by its index to the given value.

    false is returned if a hotkey is already in use by a different action.

    This panics if the type of the value to be set is not compatible with the type of the setting's value. A panic can also occur if the index of the setting provided is out of bounds.

    Parameters

    Returns boolean

settingsDescriptionAsJson

  • settingsDescriptionAsJson(): any
  • Encodes generic description of the settings available for the hotkey configuration and their current values as JSON.

    Returns any

Generated using TypeDoc