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

    Interface SceneData

    interface SceneData {
        _id: string | null;
        _stats: DocumentStats;
        active?: boolean;
        backgroundColor?: string | null;
        drawings?: DrawingData[];
        environment: SceneEnvironmentData;
        flags: DocumentFlags;
        fog: {
            colors: { explored: string | null; unexplored: string | null };
            mode: number;
            reset: number | null | undefined;
        };
        folder: string
        | null;
        grid: GridData;
        height?: number;
        initial: { scale: number | null; x: number | null; y: number | null };
        journal: string | null;
        journalEntryPage: string | null;
        lights?: AmbientLightData[];
        name: string;
        navigation?: boolean;
        navName?: string;
        navOrder?: number;
        notes?: NoteData[];
        ownership?: object;
        padding?: number;
        playlist: string | null;
        playlistSound: string | null;
        regions?: RegionData[];
        shiftX?: number;
        shiftY?: number;
        sort?: number;
        sounds?: AmbientSoundData[];
        thumb: string | null;
        tiles?: TileData[];
        tokens?: TokenData[];
        tokenVision?: boolean;
        walls?: WallData[];
        weather?: string;
        width?: number;
    }
    Index

    Properties

    _id _stats active? backgroundColor? drawings? environment flags fog folder grid height? initial journal journalEntryPage lights? name navigation? navName? navOrder? notes? ownership? padding? playlist playlistSound regions? shiftX? shiftY? sort? sounds? thumb tiles? tokens? tokenVision? walls? weather? width?

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this Scene document

    _stats

    _stats: DocumentStats

    An object of creation and access information

    active?: boolean

    Is this scene currently active? Only one scene may be active at a given time

    backgroundColor?: string | null

    The color of the canvas displayed behind the scene background

    drawings?: DrawingData[]

    A collection of embedded Drawing objects.

    environment: SceneEnvironmentData

    The environment data applied to the Scene.

    flags: DocumentFlags

    An object of optional key/value flags

    fog: {
        colors: { explored: string | null; unexplored: string | null };
        mode: number;
        reset: number | null | undefined;
    }

    Fog-exploration settings and other data

    Type Declaration

    • colors: { explored: string | null; unexplored: string | null }

      Fog-exploration coloration data

      • explored: string | null

        A color tint applied to explored regions of fog of war

      • unexplored: string | null

        A color tint applied to unexplored regions of fog of war

    • mode: number

      Fog exploration mode configured for this Scene.

    • reset: number | null | undefined

      The timestamp at which fog of war was last reset for this Scene.

    folder: string | null

    The _id of a Folder which contains this Actor

    grid: GridData

    Grid configuration for the scene

    height?: number

    The height of the scene canvas, normally the height of the background media

    initial: { scale: number | null; x: number | null; y: number | null }

    The initial view coordinates for the scene

    journal: string | null

    A JournalEntry document which provides narrative details about this Scene

    journalEntryPage: string | null

    A JournalEntry document which provides narrative details about this Scene

    lights?: AmbientLightData[]

    A collection of embedded AmbientLight objects.

    name: string

    The name of this scene

    navigation?: boolean

    Is this scene displayed in the top navigation bar?

    navName?: string

    A string which overrides Scene name for display in the navigation bar

    navOrder?: number

    The sorting order of this Scene in the navigation bar relative to siblings

    notes?: NoteData[]

    A collection of embedded Note objects.

    ownership?: object

    An object which configures ownership of this Scene

    padding?: number

    The proportion of canvas padding applied around the outside of the scene dimensions to provide additional buffer space

    playlist: string | null

    A linked Playlist document which should begin automatically playing when this Scene becomes active.

    playlistSound: string | null

    A linked PlaylistSound document from the selected playlist that will begin automatically playing when this Scene becomes active

    regions?: RegionData[]

    A collection of embedded Region objects.

    shiftX?: number

    The shift of the scene rect in x-direction (pixels)

    shiftY?: number

    The shift of the scene rect in y-direction (pixels)

    sort?: number

    The numeric sort value which orders this Actor relative to its siblings

    sounds?: AmbientSoundData[]

    A collection of embedded AmbientSound objects.

    thumb: string | null

    A thumbnail image which depicts the scene at lower resolution

    tiles?: TileData[]

    A collection of embedded Tile objects.

    tokens?: TokenData[]

    A collection of embedded Token objects.

    tokenVision?: boolean

    Do Tokens require vision in order to see the Scene environment?

    walls?: WallData[]

    A collection of embedded Wall objects

    weather?: string

    A named weather effect which should be rendered in this Scene.

    width?: number

    The width of the scene canvas, normally the width of the background media

    Settings

    Member Visibility

    On This Page

    Properties