An action that can occur when a key is pressed

interface KeybindingAction {
    action: string;
    key: string;
    name: string;
    requiredModifiers: string[];
    optionalModifiers: string[];
    onDown: Function;
    onUp: Function;
    repeat: boolean;
    restricted: boolean;
    precedence: number;
    order: number;
}

Properties

action: string

The namespaced machine identifier of the Action

key: string

The Keyboard key

name: string

The human-readable name

requiredModifiers: string[]

Required modifiers

optionalModifiers: string[]

Optional (reserved) modifiers

onDown: Function

The handler that executes onDown

onUp: Function

The handler that executes onUp

repeat: boolean

If True, allows Repeat events to execute this Action's onDown

restricted: boolean

If true, only a GM can execute this Action

precedence: number

The registration precedence

order: number

The registration order