V5 DocsAthenaShared.interfaces.textLabel.TextLabel ​
shared/interfaces/textLabel.TextLabel
Used to describe a text label. Passed from server to client.
Interface
TextLabel
Properties ​
dimension ​
• Optional dimension: number
The dimension to show this text label in.
Defined in ​
shared/interfaces/textLabel.ts:43
isServerWide ​
• Optional isServerWide: boolean
Always set to true when creating a server-wide text label.
Defined in ​
shared/interfaces/textLabel.ts:51
maxDistance ​
• Optional maxDistance: number
The maximum distance this text label should render at.
Defined in ​
shared/interfaces/textLabel.ts:29
pos ​
• pos: IVector3
The position where to place the TextLabel in a 3D space.
Defined in ​
shared/interfaces/textLabel.ts:15
text ​
• text: string
The 'Text' to show on this text label.
Defined in ​
shared/interfaces/textLabel.ts:22
uid ​
• Optional uid: string
The unique identifier to remove this text label if necessary.