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

    Interface TourStep

    A step in a Tour

    interface TourStep {
        content: string;
        id: string;
        layer?: string;
        restricted?: boolean;
        selector?: string;
        sidebarTab?: string;
        title: string;
        tool?: string;
        tooltipDirection?: "CENTER" | "LEFT" | "RIGHT" | "UP" | "DOWN";
    }
    Index

    Properties

    content id layer? restricted? selector? sidebarTab? title tool? tooltipDirection?

    Properties

    content

    content: string

    Raw HTML content displayed during the step

    id: string

    A machine-friendly id of the Tour Step

    layer?: string

    Activates a particular canvas layer and its respective control group. Usable in CanvasTour instances.

    restricted?: boolean

    Whether the Step is restricted to the GM only. Defaults to false.

    selector?: string

    A DOM selector which denotes an element to highlight during this step. If omitted, the step is displayed in the center of the screen.

    sidebarTab?: string

    Activates a particular sidebar tab. Usable in SidebarTour instances.

    title: string

    The title of the step, displayed in the tooltip header

    tool?: string

    Activates a particular tool. Usable in CanvasTour instances.

    tooltipDirection?: "CENTER" | "LEFT" | "RIGHT" | "UP" | "DOWN"

    How the tooltip for the step should be displayed relative to the target element. If omitted, the best direction will be attempted to be auto-selected.

    Settings

    Member Visibility

    On This Page

    Properties