The base class for all debug shapes. Represents an object in the world and its base properties.

Hierarchy (View Summary)

Constructors

Properties

attachedTo?: Entity

The entity this shape is attached to. When set, this shape will copy the root location of the attached entity and the shape's position will be used as an offset.

color: RGB

The color of the shape.

dimension: Dimension

The dimension the shape is visible within. If the dimension is undefined, it will display in all dimensions.

hasDuration: boolean

Returns true if the shape has a limited time span before being removed.

location: Vector3

The location of the shape. For most shapes the location is the centre of the shape, except DebugLine and DebugArrow where this represents the start point of the line.

rotation: Vector3

The rotation of the shape (Euler angles - [Pitch, Yaw, Roll]).

scale: number

The scale of the shape. This does not apply to DebugLine or DebugArrow.

timeLeft?: number

The time left (in seconds) until this shape is automatically removed. Returns undefined if the shape does not have a limited life-span.

totalTimeLeft?: number

The total initial time-span (in seconds) until this shape is automatically removed. Returns undefined if the shape does not have a limited life-span.

visibleTo: Player[]

The list of players that this shape will be visible to. If left empty, the shape will be visible to all players.

Methods