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

    Interface _SceneControlsRenderOptions

    interface _SceneControlsRenderOptions {
        control?: string;
        event?: Event;
        reset?: boolean;
        toggles?: Record<string, boolean>;
        tool?: string;
    }
    Index

    Properties

    control? event? reset? toggles? tool?

    Properties

    control?: string

    The control set to activate. If undefined, the current control set remains active

    event?: Event

    An event which prompted a re-render

    reset?: boolean

    Re-prepare the possible list of controls

    toggles?: Record<string, boolean>

    Changes to apply to toggles within the control set

    tool?: string

    A specific tool to activate. If undefined the current tool or default tool for the control set becomes active

    Settings

    Member Visibility

    On This Page

    Properties