Class Zone

Represents a rectangular region on the table, with an outline and optional label. Child objects can be dynamically added or removed with children, or in a deriving class with display annotated properties.

Hierarchy

Constructors

  • Represents a rectangular region on the table, with an outline and optional label.

    Parameters

    • width: number = 10

      Width of the zone in centimeters.

    • height: number = 10

      Height of the zone in centimeters.

    Returns Zone

Properties

_lastActionIndex: number
children: DisplayContainer = ...

Contains child objects that are displayed inside this zone. This will also contain objects from display annotated properties, using the property keys as names.

height: number

Height of the zone in centimeters.

hiddenName?: string

Optional display name for this object when hidden.

hideIfEmpty: boolean = false

If true, this zone will only be displayed if it contains visible children, or is the target of a prompt for the viewing player.

label?: string

Optional label text to describe this zone to players.

margin: number = 1.5

How much to expand the localBounds by.

name?: string

Optional display name for this object.

outlineColor?: Color

Optional color of the outline around this zone. Defaults to white.

outlineStyle: OutlineStyle = OutlineStyle.SOLID

Appearance of the outline around this zone.

promptOutlineStyle: OutlineStyle = OutlineStyle.SOLID_FILLED

Appearance of the outline around this zone when it is the target of a prompt.

width: number

Width of the zone in centimeters.

Accessors

  • get localBounds(): Bounds
  • How much space does this object take up.

    Returns Bounds

Methods

  • Builds a view of this object from the perspective of a player.

    Parameters

    • ctx: RenderContext

      Information about where the object is in the scene, and who's viewing it.

    Returns IView

Generated using TypeDoc