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

    Interface RegionData

    interface RegionData {
        _id: string | null;
        _shapeConstraints: number[][] | null;
        attachment?: RegionAttachmentData;
        behaviors?: RegionBehaviorData[];
        color?: string;
        displayMeasurements?: boolean;
        elevation?: RegionElevationData;
        flags: DocumentFlags;
        hidden?: boolean;
        highlightMode?: "shapes" | "coverage";
        levels?: string[];
        locked?: boolean;
        name: string;
        ownership?: object;
        restriction?: RegionRestrictionData;
        shapes?: BaseShapeData[];
        visibility?: number;
    }
    Index

    Properties

    _id _shapeConstraints attachment? behaviors? color? displayMeasurements? elevation? flags hidden? highlightMode? levels? locked? name ownership? restriction? shapes? visibility?

    Properties

    _id

    _id: string | null

    The Region _id which uniquely identifies it within its parent Scene.

    _shapeConstraints

    _shapeConstraints: number[][] | null
    attachment?: RegionAttachmentData

    The configuration of the attachment of the Region to a placeable.

    behaviors?: RegionBehaviorData[]

    A collection of embedded RegionBehavior objects.

    color?: string

    The color used to highlight the Region. A random color by default.

    displayMeasurements?: boolean

    Are measurements displayed for the Region?

    elevation?: RegionElevationData

    The elevation range of the Region.

    flags: DocumentFlags

    An object of optional key/value flags.

    hidden?: boolean

    Is the Region currently hidden from player view?

    highlightMode?: "shapes" | "coverage"

    Whether the true shapes of the Region or the grid spaces that it covers are highlighted.

    levels?: string[]

    The IDs of the Scene levels that the Region is part of.

    locked?: boolean

    Whether this region is locked.

    name: string

    The name used to describe the Region.

    ownership?: object

    An object which configures ownership of this Region.

    restriction?: RegionRestrictionData

    The configuration of the constraint that walls impose on the shapes of the Region.

    shapes?: BaseShapeData[]

    The shapes that make up the Region.

    visibility?: number

    The visibility of the Region, from CONST.REGION_VISIBILITY.

    Settings

    Member Visibility

    On This Page

    Properties