Interface RegionData

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

Properties

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

Properties

_id

_id: null | string

The Region _id which uniquely identifies it within its parent Scene

Optionalbehaviors

behaviors?: RegionBehaviorData[]

A collection of embedded RegionBehavior objects

Optionalcolor

color?: string

The color used to highlight the Region

Optionalelevation

elevation?: number

The elevation

flags

flags: DocumentFlags

An object of optional key/value flags

Optionallocked

locked?: boolean

Whether this region is locked or not

name

name: string

The name used to describe the Region

Optionalshapes

shapes?: BaseShapeData[]

The shapes that make up the Region

Optionalvisibility

visibility?: number

The region visibility

Settings

Member Visibility

On This Page

Properties