interface KeybindingActionConfig {
    namespace: string;
    name: string;
    hint: string;
    uneditable: KeybindingActionBinding[];
    editable: KeybindingActionBinding[];
    onDown: Function;
    onUp: Function;
    repeat: boolean;
    restricted: boolean;
    reservedModifiers: string[];
    precedence: number;
    order: number;
}

Properties

namespace: string

The namespace within which the action was registered

name: string

The human-readable name

hint: string

An additional human-readable hint

The default bindings that can never be changed nor removed.

The default bindings that can be changed by the user.

onDown: Function

A function to execute when a key down event occurs. If True is returned, the event is consumed and no further keybinds execute.

onUp: Function

A function to execute when a key up event occurs. If True is returned, the event is consumed and no further keybinds execute.

repeat: boolean

If True, allows Repeat events to execute the Action's onDown. Defaults to false.

restricted: boolean

If true, only a GM can edit and execute this Action

reservedModifiers: string[]

Modifiers such as [ "CONTROL" ] that can be also pressed when executing this Action. Prevents using one of these modifiers as a Binding.

precedence: number

The preferred precedence of running this Keybinding Action

order: number

The recorded registration order of the action