Class Keybind

constructor

• new Keybind(
      keys: KeybindKeys,
      variations?: Record<string, VariationModifier>,
  ): Keybind

  Create a keybind

  Parameters

  • keys: KeybindKeys

    Set up the default keys that need to be pressed

    • Optionalalt?: boolean

    • Optionalctrl?: boolean

    • key: string | number

      Main key, can be a numeric keycode or a lower case character

    • Optionalmeta?: boolean

    • Optionalshift?: boolean

  • Optionalvariations: Record<string, VariationModifier>

  Returns Keybind

Optionalalt

Optionalctrl

key

Readonlylabel

Optionalshift

Optionalvariations

additionalModifierTriggered

• additionalModifierTriggered(event: Event): string

  Test which variation would be triggered by the event. Returns the ID of the variation if triggered

  Parameters

  • event: Event

    The event to test

  Returns string

• additionalModifierTriggered(event: Event, variation: string): boolean

  Test if a variation would be triggered by the event

  Parameters

  • event: Event

    The event to test

  • variation: string

    The variation to test againts

  Returns boolean

clear

• clear(): this

  Unassign the assigned key

  Returns this

getCode

• getCode(key?: string): string

  Get the name of the bound key

  Parameters

  • Optionalkey: string

  Returns string

getText

• getText(formatted?: boolean): string

  Get display text showing the keybind

  Parameters

  • Optionalformatted: boolean

    If true, the return string will include HTML formatting

  Returns string

hasKey

• hasKey(): boolean

  Check if a key is assigned

  Returns boolean

isTriggered

• isTriggered(event: Event): boolean

  Test if the keybind would be triggered by the event

  Parameters

  • event: Event

  Returns boolean

record

• record(): this

  Open a UI to let the user record a new key combination

  Returns this

save

• save(save?: false): this

  Save any changes to local storage

  Parameters

  • Optionalsave: false

    Save all keybinding changes to local storage. Set to fales if updating multiple at once

  Returns this

set

• set(keys: KeybindKeys): this

  Parameters

  • keys: KeybindKeys

  Returns this

setAction

• setAction(id: string, sub_id?: string): Keybind

  Assign an action to the keybind

  Parameters

  • id: string

    ID of the action

  • Optionalsub_id: string

    sub keybind ID

  Returns Keybind

stopRecording

• stopRecording(): this

  Stop recording a new key combination

  Returns this

toString

• toString(): string

  Returns the label of the keybinding

  Returns string

StaticloadKeymap

• loadKeymap(id: string, from_start_screen?: boolean): true | void

  Load an included keymap by ID

  Parameters

  • id: string
  • Optionalfrom_start_screen: boolean

  Returns true | void

Staticno_overlap

• no_overlap(k1: KeybindItem, k2: KeybindItem): boolean

  Check if two KeybindItems are mutually exclusive, so only one can be available at the time. This is only the case if they each have a ConditionResolvable that is structured to support this

  Parameters

  • k1: KeybindItem
  • k2: KeybindItem

  Returns boolean