The length of the arrow's head/tip.

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.

endLocation: Vector3

The end location of the line segment. The final line will spawn between location and endLocation.

hasDuration: boolean

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

headLength: number

Adds a new debug shape to the world.

headRadius: number

The radius of the arrow's head/tip.

headSegments: number

The number of segments for the base circle of the arrow's head/tip (default: 4).

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