Interface IDisplayOptions

Options for positioning and styling an object or array of objects.

Hierarchy

  • IDisplayOptions

Properties

anchor? arrangement? childOptions? fontColor? fontScale? hiddenFor? invisibleFor? label? position? revealedFor? rotation? visibleFor?

Properties

Optional anchor

anchor?: Vector3 | {
    x?: number;
    y?: number;
    z?: number;
}

Location of the origin in local space, relative to the parent's bounds. Each component is between 0 and 1, where 0 is the parent bounds minimum, and 1 is the maximum. Defaults to (0.5, 0.5, 1), representing the center of the top of the parent.

Type declaration

  • Optional x?: number
  • Optional y?: number
  • Optional z?: number

Optional arrangement

arrangement?: Arrangement

For displaying an array of objects, strategy to use when arranging. Defaults to RenderContext.DEFAULT_ARRANGEMENT.

Optional childOptions

childOptions?: IDisplayOptions | IDisplayOptions[]

For displaying an array of objects, either a single IDisplayOptions that will be used with every child object, or an array containing separate options for each child.

Optional fontColor

fontColor?: Color

For displayed text, specifies a color to use. Defaults to white.

Optional fontScale

fontScale?: number

For displayed text, specifies a font scale to apply. Defaults to 1.

Optional hiddenFor

hiddenFor?: readonly Player[]

Set of players for which the identity of this object should be hidden. Opposite of revealedFor. This mainly affects cards, making them display their "hidden" face rather than "front" face.

Optional invisibleFor

invisibleFor?: readonly Player[]

Set of players for which this object is fully invisible. Opposite of visibleFor.

Optional label

label?: string

For objects that support it, this text will be displayed next to the object on the table.

Optional position

position?: Vector3 | {
    x?: number;
    y?: number;
    z?: number;
}

Offset in centimeters, relative to the parent transform.

Type declaration

  • Optional x?: number
  • Optional y?: number
  • Optional z?: number

Optional revealedFor

revealedFor?: readonly Player[]

Set of players for which the identity of this object is revealed. Opposite of hiddenFor. Defaults to everyone, unless hiddenFor is given.

Optional rotation

rotation?: number | Rotation

Euler angles in degrees, relative to the parent rotation.

Optional visibleFor

visibleFor?: readonly Player[]

Set of players for which this object is visible. Opposite of invisibleFor. Defaults to everyone, unless invisibleFor is given.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc