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

    Interface RegionData

    interface RegionData {
        _id: string | null;
        _shapeConstraints: number[][] | null;
        behaviors?: RegionBehaviorData[];
        color?: string;
        elevation?: number;
        flags: DocumentFlags;
        levels?: string[] | null;
        locked?: boolean;
        name: string;
        shapes?: BaseShapeData[];
        visibility?: number;
    }
    Index

    Properties

    _id _shapeConstraints behaviors? color? elevation? flags levels? locked? name shapes? visibility?

    Properties

    _id

    _id: string | null

    The Region _id which uniquely identifies it within its parent Scene

    _shapeConstraints

    _shapeConstraints: number[][] | null
    behaviors?: RegionBehaviorData[]

    A collection of embedded RegionBehavior objects

    color?: string

    The color used to highlight the Region

    elevation?: number

    The elevation

    flags: DocumentFlags

    An object of optional key/value flags

    levels?: string[] | null

    The level IDs

    locked?: boolean

    Whether this region is locked or not

    name: string

    The name used to describe the Region

    shapes?: BaseShapeData[]

    The shapes that make up the Region

    visibility?: number

    The region visibility

    Settings

    Member Visibility

    On This Page

    Properties