Class ClientKeybindings

actions

activeKeys

bindings

get

• get(namespace: string, action: string): KeybindingActionBinding[]

  Get the current Bindings of a given namespace's Keybinding Action

  Parameters

  • namespace: string

    The namespace under which the setting is registered

  • action: string

    The keybind action to retrieve

  Returns KeybindingActionBinding[]

  Example: Retrieve the current Keybinding Action Bindings

  game.keybindings.get("myModule", "showNotification");
  Copy

initialize

• initialize(): void

  Initializes the keybinding values for all registered actions

  Returns void

register

• register(namespace: string, action: string, data: KeybindingActionConfig): void

  Register a new keybinding

  Parameters

  • namespace: string

    The namespace the Keybinding Action belongs to

  • action: string

    A unique machine-readable id for the Keybinding Action

  • data: KeybindingActionConfig

    Configuration for keybinding data

  Returns void

  Example: Define a keybinding which shows a notification

  game.keybindings.register("myModule", "showNotification", {
    name: "My Settings Keybinding",
    hint: "A description of what will occur when the Keybinding is executed.",
    uneditable: [
      {
        key: "Digit1",
        modifiers: ["Control"]
      }
    ],
    editable: [
      {
        key: "F1"
      }
    ],
    onDown: () => { ui.notifications.info("Pressed!") },
    onUp: () => {},
    restricted: true,             // Restrict this Keybinding to gamemaster only?
    reservedModifiers: ["Alt"],  // On ALT, the notification is permanent instead of temporary
    precedence: CONST.KEYBINDING_PRECEDENCE.NORMAL
  });
  Copy

resetDefaults

• resetDefaults(): Promise<any>

  Reset all client keybindings back to their default configuration.

  Returns Promise<any>

set

• set(
      namespace: string,
      action: string,
      bindings: KeybindingActionBinding[],
  ): Promise<any>

  Set the editable Bindings of a Keybinding Action for a certain namespace and Action

  Parameters

  • namespace: string

    The namespace under which the Keybinding is registered

  • action: string

    The Keybinding action to set

  • bindings: KeybindingActionBinding[]

    The Bindings to assign to the Keybinding

  Returns Promise<any>

  Example: Update the current value of a keybinding

  game.keybindings.set("myModule", "showNotification", [
      {
        key: "F2",
        modifiers: [ "CONTROL" ]
      }
  ]);
  Copy