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

    Interface AmbientLightData

    interface AmbientLightData {
        _id: string | null;
        config: LightData;
        elevation?: number;
        flags: DocumentFlags;
        hidden?: boolean;
        name?: string;
        rotation?: number;
        vision?: boolean;
        walls?: boolean;
        x: number;
        y: number;
    }
    Index

    Properties

    _id config elevation? flags hidden? name? rotation? vision? walls? x y

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this AmbientLight document

    config: LightData

    Light configuration data

    elevation?: number

    The elevation

    flags: DocumentFlags

    An object of optional key/value flags

    hidden?: boolean

    Is the light source currently hidden?

    name?: string

    An optional name.

    rotation?: number

    The angle of rotation for the tile between 0 and 360

    vision?: boolean

    Whether or not this light source provides a source of vision

    walls?: boolean

    Whether or not this light source is constrained by Walls and surfaces

    x: number

    The x-coordinate position of the origin of the light

    y: number

    The y-coordinate position of the origin of the light

    Settings

    Member Visibility

    On This Page

    Properties