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

    Interface TileData

    interface TileData {
        _id: string | null;
        alpha?: number;
        anchorX?: number;
        anchorY?: number;
        elevation?: number;
        flags: DocumentFlags;
        height?: number;
        hidden?: boolean;
        locked?: boolean;
        name?: string;
        occlusion?: TileOcclusionData;
        restrictions?: TileRestrictionsData;
        rotation?: number;
        sort?: number;
        texture?: TextureData;
        video?: TileVideoData;
        width?: number;
        x?: number;
        y?: number;
    }
    Index

    Properties

    _id alpha? anchorX? anchorY? elevation? flags height? hidden? locked? name? occlusion? restrictions? rotation? sort? texture? video? width? x? y?

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this Tile embedded document

    alpha?: number

    The tile opacity

    anchorX?: number

    The x-coordinate of the anchor of the tile

    anchorY?: number

    The y-coordinate of the anchor of the tile

    elevation?: number

    The elevation of the tile

    flags: DocumentFlags

    An object of optional key/value flags

    height?: number

    The pixel height of the tile

    hidden?: boolean

    Is the tile currently hidden?

    locked?: boolean

    Is the tile currently locked?

    name?: string

    An optional name.

    occlusion?: TileOcclusionData

    The tile's occlusion settings

    restrictions?: TileRestrictionsData

    The tile's restrictions settings

    rotation?: number

    The angle of rotation for the tile between 0 and 360

    sort?: number

    The z-index ordering of this tile relative to its siblings

    texture?: TextureData

    An image or video texture which this tile displays.

    video?: TileVideoData

    The tile's video settings

    width?: number

    The pixel width of the tile

    x?: number

    The x-coordinate of the origin of the tile

    y?: number

    The y-coordinate of the origin of the tile

    Settings

    Member Visibility

    On This Page

    Properties