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

    Class TextPrimitiveBeta

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

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

    Methods

    remove setLocation setText

    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.

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

    backfaceVisible: boolean

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

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

    backgroundColorOverride?: RGBA

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

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

    color: RGBA

    The color of the shape.

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

    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).

    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.

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

    maximumRenderDistance?: number

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

    Minimum Value: 0

    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.

    Bounds: [-1000, 1000]

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

    Readonlytext

    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.

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

    textBackfaceVisible: boolean

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

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

    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.

    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 undefined if the shape does not have a limited life-span.

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

    useRotation: boolean

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

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

    visibleTo: Player[]

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

    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 PrimitiveShapesManager's addText method.

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods