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.
Betacolor
color:RGB
Remarks
The color of the shape.
ReadonlyBetadimension
dimension:Dimension
Remarks
The dimension the shape is visible within. If the dimension
is undefined, it will display in all dimensions.
ReadonlyBetahasDuration
hasDuration:boolean
Remarks
Returns true if the shape has a limited time span before
being removed.
ReadonlyBetalocation
location:Vector3
Remarks
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.
Betarotation
rotation:Vector3
Remarks
The rotation of the shape (Euler angles - [Pitch, Yaw,
Roll]).
Betascale
scale:number
Remarks
The scale of the shape. This does not apply to DebugLine or
DebugArrow.
Betatext
text:string
Remarks
The text of the shape to display.
OptionalBetatimeLeft
timeLeft?:number
Remarks
The time left (in seconds) until this shape is automatically
removed. Returns undefined if the shape does not have a
limited life-span.
OptionalReadonlyBetatotalTimeLeft
totalTimeLeft?:number
Remarks
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.
BetavisibleTo
visibleTo:Player[]
Remarks
The list of players that this shape will be visible to. If
left empty, the shape will be visible to all players.
Methods
remove
remove():void
Beta
Returns void
Remarks
Removes this shape from the world. The shape can be re-added
via the DebugDrawer's addShape method.
Set the location and dimension of the shape. If the
dimension is undefined, it will display in all dimensions.
For most shapes the location is the centre of the shape,
except DebugLine and DebugArrow where this represents the
start point of the line.
A debug shape class that a text label. The text label automatically faces the screen.