Interface KeybindingActionConfig

A Client Keybinding Action Configuration

interface KeybindingActionConfig {
    editable?: KeybindingActionBinding[];
    hint?: string;
    name: string;
    namespace?: string;
    onDown?: (context: KeyboardEventContext) => boolean | void;
    onUp?: (context: KeyboardEventContext) => boolean | void;
    order?: number;
    precedence?: number;
    repeat?: boolean;
    reservedModifiers?: string[];
    restricted?: boolean;
    uneditable?: KeybindingActionBinding[];
}

Properties

editable? hint? name namespace? onDown? onUp? order? precedence? repeat? reservedModifiers? restricted? uneditable?

Properties

Optionaleditable

editable?: KeybindingActionBinding[]

The default bindings that can be changed by the user.

Optionalhint

hint?: string

An additional human-readable hint.

name

name: string

The human-readable name.

Optionalnamespace

namespace?: string

The namespace within which the action was registered

OptionalonDown

onDown?: (context: KeyboardEventContext) => boolean | void

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

OptionalonUp

onUp?: (context: KeyboardEventContext) => boolean | void

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

Optionalorder

order?: number

The recorded registration order of the action.

Optionalprecedence

precedence?: number

The preferred precedence of running this Keybinding Action.

Optionalrepeat

repeat?: boolean

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

OptionalreservedModifiers

reservedModifiers?: string[]

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

Optionalrestricted

restricted?: boolean

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

Optionaluneditable

uneditable?: KeybindingActionBinding[]

The default bindings that can never be changed nor removed.

Settings

Member Visibility

On This Page

Properties