Text Render

A Text Render class is useful for spawning Texts in 3D world, you can even attach to other entities.

Note

This is a Client only Class.

Usage

Lua

local MyTextRender = TextRender(
    Vector(-100, 200, 300),
    Rotator(),
    "My Awesome Text",
    Color(1, 0, 0),
    1, -- Horizontal Alignment
    0, -- Vertical Alignment
    32, -- Size
    false, -- Emissive
    false -- Align to Camera
)

Constructor Parameters

Type	Name	Default
Vector	Location	Vector(0, 0, 0)
Rotator	Rotation	Rotator(0, 0, 0)
string	Text
Color	Color	Color(1, 1, 1, 1)
number	Horizontal Alignment (0 - Left, 1 - Center, 2 - Right)	0
number	Vertical Alignment (0 - Top, 1 - Center, 2 - Bottom, 3 - Quad Top)	0
number	Size	26
number	Type (0 - Lit, 1 - Unlit, 2 - Unlit & Always Visible)	0
boolean	Align To Camera (ajudsts the rotation automatically to always looks at the camera)	false

Functions

Returns	Name	Description
	SetText(string Text)	Sets the Text
	SetColor(Color Color)	Sets the Color
	SetSize(number Size)	Sets the Size

Functions (Inherited from Actor)

	Returns	Name	Description
		AddImpulse(Vector Force)	Applies a Force in world coordinate on this Actor (the force is applied on Client side, by the (in most of cases) the closest player of this object)
		AttachTo(Actor Other, string BoneName, Vector RelativeLocation, Rotator RelativeRotation)	Attaches this Actor to any other Actor with a Relative Offset/Rotation
		Destroy()	Destroys this Actor
		SetCollision(number CollisionType)	Sets the actor’s collision (0 - Normal, 1 - Static Only, 2 - No Collision)
		SetGravityEnabled(boolean NewGravity)	Sets the actor’s gravity enabled
		SetHighlightEnabled(boolean Enabled)	Sets if this Actors is Highlighting
		SetInitialLocation(Vector NewInitialLocation)	Sets the initial location
		SetLocation(Vector NewLocation)	Sets the actor’s location in the game world
		SetRotation(Rotator NewRotation)	Sets the actor’s rotation in the game world
		SetScale(Vector Scale)	Sets the actor’s scale
		SetTintColor(Color NewTintColor)	Sets the tint color, for completely paint an object, multiply the color by 10 or 100
		SetValue(string Key, any Value)	Sets a value in this entity, which can be accessed by any package (local only)
	boolean	IsGravityEnabled()	Gets the actor’s gravity enabled
	boolean	IsValid()	Returns if this is Valid
	number	GetCollision()	Gets the current actor’s collision
	number	GetID()	Gets the network ID of this entity (same in both client and server)
	Vector	GetLocation()	Get the actor’s position in the game world
	Vector	GetInitialLocation()	Gets the initial location
	Rotator	GetRotation()	Gets the actor’s rotation in the game world
	Vector	GetScale()	Gets the actor’s scale
	Color	GetTintColor()	Gets the Tint Color
	string	GetType()	Returns the type of this Actor
	any	GetValue(string Key)	Gets a value given a key

Events

Events (Inherited from Actor)

	Name	Arguments	Description
	Destroy	Entity actor	Triggered when an Entity is Destroyed
	Spawn	Entity actor	Triggered when an Entity is Spawned/Created

Related Tutorials