Runtime classServer APIGenerated

TextLabel

Defined in: server/api.d.ts:4329

Server-created replicated world-space text label.

Extends

Entity

Constructors

Constructor

new TextLabel(id): TextLabel

Defined in: server/api.d.ts:4334

Creates a wrapper for an existing text label; use TextLabel.create to spawn one.

Parameters

id

number

Existing text-label network entity identifier.

Returns

TextLabel

Inherited from

Entity.constructor

Methods

attachTo()

attachTo(target, offset?): void

Defined in: server/api.d.ts:4432

Follows another live entity instead of staying at the label’s own position. It streams from where the target is, moves into its virtual world and is destroyed with it.

Parameters

target

number | Entity

The entity to follow, or its network id.

offset?

Vector3 | { x: number; y: number; z: number; }

Where to draw relative to it; the game decides the reference point (a player’s head, say).

Returns

void

destroy()

destroy(): void

Defined in: server/api.d.ts:4375

Destroys this replicated label; stale wrappers no longer resolve afterward.

Returns

void

detach()

detach(): void

Defined in: server/api.d.ts:4410

Stops following an entity; the label returns to its own position.

Returns

void

getOptions()

getOptions(): TextLabelOptions

Defined in: server/api.d.ts:4437

The label’s current look and placement, in the shape update() takes.

Returns

TextLabelOptions

setColor()

setColor(colorOrR, g?, b?, a?): void

Defined in: server/api.d.ts:4419

Changes the label’s packed ARGB color from a Color or byte components.

Parameters

colorOrR

number | Color

A Color, or the red byte (0-255) when passing components.

g?

number

Green byte (0-255) when passing components.

b?

number

Blue byte (0-255) when passing components.

a?

number

Alpha byte (0-255) when passing components; defaults to 255.

Returns

void

setDrawDistance()

setDrawDistance(distance): void

Defined in: server/api.d.ts:4393

Changes how far away clients can render the label.

Parameters

distance

number

Maximum rendering distance in world units, clamped from 1 to 1000 metres’ worth.

Returns

void

setFadeDistance()

setFadeDistance(distance): void

Defined in: server/api.d.ts:4399

Changes where the label starts fading out.

Parameters

distance

number

Distance in world units where fading starts; 0 starts it at 75% of the draw distance.

Returns

void

setFontSize()

setFontSize(size): void

Defined in: server/api.d.ts:4387

Changes the rendered font size.

Parameters

size

number

Font size in pixels, clamped from 1 to 512.

Returns

void

setStyle()

setStyle(style): void

Defined in: server/api.d.ts:4405

Resets the outline, shadow and background to a preset.

Parameters

style

number

0 none, 1 shadow, 2 outline, 3 box; unsupported values are ignored.

Returns

void

setText()

setText(text): void

Defined in: server/api.d.ts:4381

Changes the label’s displayed text.

Parameters

text

string

Replacement text replicated to clients; at most 1024 bytes.

Returns

void

setVirtualWorld()

setVirtualWorld(world): void

Defined in: server/api.d.ts:4154

Moves this entity into another virtual world.

Parameters

world

number

Virtual-world identifier used to partition replication and visibility.

Returns

void

Inherited from

Entity.setVirtualWorld

setVisibleTo()

setVisibleTo(player): void

Defined in: server/api.d.ts:4160

Restricts replication of this entity to one owning connection while preserving normal range and visibility checks.

Parameters

player

Entity | null

Player-owned entity whose connection should exclusively receive this entity, or null to clear the restriction.

Returns

void

Inherited from

Entity.setVisibleTo

toString()

toString(): string

Defined in: server/api.d.ts:4370

Formats this label for logging and debugging.

Returns

string

Text containing the label ID and current text.

Inherited from

Entity.toString

update()

update(options): void

Defined in: server/api.d.ts:4425

Changes any part of the label at once. A bad key throws and changes nothing.

Parameters

options

TextLabelOptions

Only the keys given change; outline, shadow and background are replaced whole.

Returns

void

create()

static create(x, y, z, text, fontSizeOrOptions?, drawDistance?, virtualWorld?): TextLabel

Defined in: server/api.d.ts:4450

Creates and replicates a world-space text label, up to the server-wide limit of 512. A bad option throws and creates nothing.

Parameters

x

number

World-space X coordinate.

y

number

World-space Y coordinate.

z

number

World-space Z coordinate.

text

string

Initial displayed text.

fontSizeOrOptions?

number | TextLabelOptions

Look and placement, or (the older form) the font size from 1 to 512.

drawDistance?

number

Older form only: the draw distance in world units.

virtualWorld?

number

Older form only: the virtual-world identifier.

Returns

TextLabel

Handle for the newly created label.

Properties

color

readonly color: number

Defined in: server/api.d.ts:4344

Current packed ARGB color.

drawDistance

readonly drawDistance: number

Defined in: server/api.d.ts:4354

Current maximum rendering distance in world units.

fadeDistance

readonly fadeDistance: number

Defined in: server/api.d.ts:4359

Distance in world units where fading starts.

id

readonly id: number

Defined in: server/api.d.ts:4122

Immutable network entity identifier.

Inherited from

Entity.id

position

position: Vector3

Defined in: server/api.d.ts:4132

Authoritative world-space position; assignment forces replicated state.

Inherited from

Entity.position

rotation

rotation: Vector3 | Quaternion

Defined in: server/api.d.ts:4137

Authoritative rotation; reads return a quaternion and assignments accept a quaternion or Euler angles in degrees.

Inherited from

Entity.rotation

state

readonly state: StateBag

Defined in: server/api.d.ts:4142

Arbitrary key/value state carried by this entity. The server writes it and every client that can see the entity receives it; see StateBag.

Inherited from

Entity.state

style

readonly style: number

Defined in: server/api.d.ts:4364

The preset nearest the current look: 0 none, 1 shadow, 2 outline, 3 box.

text

readonly text: string

Defined in: server/api.d.ts:4339

Current replicated label text.

virtualWorld

readonly virtualWorld: number

Defined in: server/api.d.ts:4127

Current virtual-world identifier.

Inherited from

Entity.virtualWorld