Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    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[];
    }
    Index

    Properties

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

    Properties

    editable?: KeybindingActionBinding[]

    The default bindings that can be changed by the user.

    hint?: string

    An additional human-readable hint.

    name: string

    The human-readable name.

    namespace?: string

    The namespace within which the action was registered

    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.

    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.

    order?: number

    The recorded registration order of the action.

    precedence?: number

    The preferred precedence of running this Keybinding Action.

    repeat?: boolean

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

    reservedModifiers?: string[]

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

    restricted?: boolean

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

    uneditable?: KeybindingActionBinding[]

    The default bindings that can never be changed nor removed.

    Settings

    Member Visibility

    On This Page

    Properties