@minecraft/debug-utilities
    Preparing search index...

    Class DebugTextBeta

    A debug shape class that represents a text label in the world with a background.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    attachedTo? backfaceVisible backgroundColorOverride? color defaultVisibleToAll depthTest dimension hasDuration hiddenFrom lineGapHeight location maximumRenderDistance? rotation scale text textBackfaceVisible timeLeft? totalTimeLeft? useRotation visibleTo

    Methods

    remove setLocation setText

    Constructors

    • Beta

      Parameters

      • location: Vector3 | DimensionLocation
      • text: string | RawMessage

      Returns DebugText

    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.

    backfaceVisible: boolean

    If set to true, the debug text will render the back-face of the background. Defaults to true but will always be false if 'useRotation' is set to false.

    backgroundColorOverride?: RGBA

    The color of the background plate of the text. If set to undefined, it will use the default color.

    color: RGBA

    The color of the shape.

    defaultVisibleToAll: boolean

    Defaults to true. If set to true, we default to being visible to all players if visibleTo is empty - hiddenFrom still applies afterwards. If set to false, we default to hiding the shape from all players if visibleTo is empty.

    depthTest: boolean

    If set to true, the text will be hidden behind blocks or entities. By default this is set to false (will always render).

    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.

    hiddenFrom: Player[]

    The list of players that this shape will be hidden from. If a player is listed in both this and visibleTo, this takes priority (it will be hidden from the player).

    lineGapHeight: number

    This value determines the gap between lines for the debug text. By default the line gap height is 0.

    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.

    maximumRenderDistance?: number

    If defined, this distance will be used to determine how far away this shape will be rendered for each client. By default the distance will match the client's render distance setting.

    Minimum Value: 0

    rotation: Vector3

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

    scale: number

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

    Readonly Betatext

    text: string | RawMessage

    Get the text of the debug text shape. Returns the RawText of the debug text if setText was called with a RawMessage or a RawText object, otherwise returns a string.

    textBackfaceVisible: boolean

    If set to true, the debug text will render the back-face of the text. Defaults to true but will always be false if 'useRotation' is set to false.

    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.

    useRotation: boolean

    If set to true, the text will not face the camera and instead will use the rotation from the shape.

    visibleTo: Player[]

    The list of players that this shape will be visible to. If left empty and defaultVisibleToAll is true, the shape will be visible to all players, otherwise it will be hidden from all players.

    Methods

    • Beta

      Returns void

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

    • Beta

      Parameters

      • location: Vector3 | DimensionLocation

      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.

    • Beta

      Parameters

      • text: string | RawMessage

      Returns void

      Sets the text to display.

      This function can throw errors.

      minecraftcommon.ArgumentOutOfBoundsError

      minecraftserver.RawMessageError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods