Script API - v1.21.130.20
    Preparing search index...

    Class DebugBox

    A debug shape class that represents a box or cuboid.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    bound color dimension hasDuration location rotation scale timeLeft? totalTimeLeft?

    Methods

    remove setLocation

    Constructors

    Properties

    bound: Vector3

    The bounding box of the shape. The final box will be this bound multiplied by the shape's scale.

    This property can't be read in early-execution mode.

    color: RGB

    The color of the shape.

    This property can't be read in early-execution mode.

    dimension: Dimension

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

    This property can't be read in early-execution mode.

    hasDuration: boolean

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

    This property can't be read in early-execution mode.

    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.

    This property can't be read in early-execution mode.

    rotation: Vector3

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

    This property can't be read in early-execution mode.

    scale: number

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

    This property can't be read in early-execution mode.

    timeLeft?: number

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

    This property can't be read in early-execution mode.

    totalTimeLeft?: number

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

    This property can't be read in early-execution mode.

    Methods

    • Returns void

      Removes this shape from the world. The shape can be re-added via the DebugDrawer's addShape method.

      This function can't be called in early-execution mode.

    • Parameters

      Returns void

      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.

      This function can't be called in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods