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

    Interface SceneViewOptions

    interface SceneViewOptions {
        activeHUD?: string;
        activeLayer?: string;
        controlledTokens?: string[];
        level?: string;
        panToken?: string | null;
        targetedTokens?: string[];
        transition?: { duration?: number; type?: string };
    }
    Index

    Properties

    activeHUD? activeLayer? controlledTokens? level? panToken? targetedTokens? transition?

    Properties

    activeHUD?: string

    The object ID of the placeable that is bound to the HUD, e.g. "Token.0123456789abcdef"

    activeLayer?: string

    The name of the canvas layer to activate

    controlledTokens?: string[]

    The IDs of initially controlled tokens

    level?: string

    The ID of the Level to view

    panToken?: string | null

    The ID of token to pan to, or null if no token should be panned to

    targetedTokens?: string[]

    The IDs of initially targeted tokens

    transition?: { duration?: number; type?: string }

    The transition animation to used when viewing the scene

    Type Declaration

    • Optionalduration?: number

      The duration of the transition animation

    • Optionaltype?: string

      The type of the transition animation

    Settings

    Member Visibility

    On This Page

    Properties