🆒 TextRender

A Text Render class is useful for spawning Texts in 3D world.

---

💂Authority

This class can be spawned on both 🟧 Client and 🟦 Server side (if you spawn it on client, it won't be synchronized with other players).

🔁Network Authority Distribution

This class can't be Network Authority distributed.

👪Inheritance

This class shares methods and events from Base Entity, Base Actor.

🧑‍💻API Source

This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!

---

🎒 Examples

local my_text_render = TextRender(
    Vector(-100, 200, 300),
    Rotator(),
    "My Awesome Text",
    40, -- Text Size
    Color.RED
)

Nametagsgetting-started/tutorials-and-examples/name-tags

🛠 Constructors

Default Constructor

No description provided

local my_textrender = TextRender(location, rotation, text, word_size?, color?, horizontal_alignment?, vertical_alignment?, rendering_type?, font_asset?, cast_shadow?)

Type	Name	Default	Description
Vector	location	Required parameter	No description provided
Rotator	rotation	Required parameter	No description provided
string	text	Required parameter	No description provided
float	word_size	26	Text size
Color	color	Color.WHITE	No description provided
TextRenderHorizontalAlignment	horizontal_alignment	TextRenderHorizontalAlignment.Center	No description provided
TextRenderVerticalAlignment	vertical_alignment	TextRenderVerticalAlignment.Center	No description provided
TextRenderRenderingType	rendering_type	TextRenderRenderingType.Lit	To make it unlit, always face the camera or always visible through walls
string	font_asset		The font asset to use for the text. Note the font must be a offline cached, distance field font
boolean	cast_shadow	false	Controls whether it should cast shadow or not

🗿 Static Functions

Inherited Entity Static Functions

TextRender inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/entity

	Returns	Name	Description
	table of Base Entity	GetAll	Returns a table containing all Entities of the class this is called on
	Base Entity	GetByIndex	Returns a specific Entity of this class at an index
	integer	GetCount	Returns how many Entities of this class exist
	table of table	GetInheritedClasses	Gets a list of all directly inherited classes from this Class created with the Inheriting System
	iterator	GetPairs	Returns an iterator with all Entities of this class to be used with pairs()
	table or nil	GetParentClass	Gets the parent class if this Class was created with the Inheriting System
	table	Inherit	Inherits this class with the Inheriting System
	boolean	IsChildOf	Gets if this Class is child of another class if this Class was created with the Inheriting System
	function	Subscribe	Subscribes to an Event for all entities of this Class
	function	SubscribeRemote	Subscribes to a custom event called from server
		Unsubscribe	Unsubscribes all callbacks from this Event in this Class within this Package, or only the callback passed

This class doesn't have own static functions.

🦠 Functions

Inherited Entity Functions

TextRender inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/entity

	Returns	Name	Description
		BroadcastRemoteEvent	Calls a custom remote event directly on this entity to all Players
		CallRemoteEvent	Calls a custom remote event directly on this entity to a specific Player
		CallRemoteEvent	Calls a custom remote event directly on this entity
		Destroy	Destroys this Entity
	table of string	GetAllValuesKeys	Gets a list of all values keys
	table	GetClass	Gets the class of this entity
	integer	GetID	Gets the universal network ID of this Entity (same on both client and server)
	any	GetValue	Gets a Value stored on this Entity at the given key
	boolean	IsA	Recursively checks if this entity is inherited from a Class
	boolean	IsValid	Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
		SetValue	Sets a Value in this Entity
	function	Subscribe	Subscribes to an Event on this specific entity
	function	SubscribeRemote	Subscribes to a custom event called from server on this specific entity
		Unsubscribe	Unsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed

Inherited Actor Functions

TextRender inherits from Base Actor Class, sharing it's methods and functions:
Base Actorscripting-reference/classes/base-classes/actor

	Returns	Name	Description
		AddActorTag	Adds an Unreal Actor Tag to this Actor
		AddAngularImpulse	Add an angular impulse to this Actor. Good for one time instant burst
		AddImpulse	Add an impulse to this Actor. Good for one time instant burst
		AttachTo	Attaches this Actor to any other Actor, optionally at a specific bone
		Detach	Detaches this Actor from AttachedTo Actor
	table of string	GetActorTags	Gets all Unreal Actor Tags on this Actor
	table of Base Actor	GetAttachedEntities	Gets all Actors attached to this Actor
	Base Actor or nil	GetAttachedTo	Gets the Actor this Actor is attached to
	table	GetBounds	Gets this Actor's bounds
	CollisionType	GetCollision	Gets this Actor's collision type
	integer	GetDimension	Gets this Actor's dimension
	float	GetDistanceFromCamera	Gets the distance of this Actor from the Camera
	Vector	GetForce	Gets this Actor's force (set by SetForce())
	Vector	GetLocation	Gets this Actor's location in the game world
	Player or nil	GetNetworkAuthority	Gets this Actor's Network Authority Player
	Vector	GetRelativeLocation	Gets this Actor's Relative Location if it's attached
	Rotator	GetRelativeRotation	Gets this Actor's Relative Rotation if it's attached
	Rotator	GetRotation	Gets this Actor's angle in the game world
	Vector	GetScale	Gets this Actor's scale
	float	GetScreenPercentage	Gets the percentage of this Actor size in the screen
	table	GetSocketTransform	Gets a Socket Transform in world space given a bone or socket name
	Vector	GetVelocity	Gets this Actor's current velocity
	boolean	HasAuthority	Gets if this Actor was spawned by the client side
	boolean	HasNetworkAuthority	Returns true if the local Player is currently the Network Authority of this Actor
	boolean	IsBeingDestroyed	Returns true if this Actor is being destroyed
	boolean	IsGravityEnabled	Returns true if gravity is enabled on this Actor
	boolean	IsInWater	Returns true if this Actor is in water
	boolean	IsNetworkDistributed	Returns true if this Actor is currently network distributed
	boolean	IsVisible	Returns true if this Actor is visible
		RemoveActorTag	Removes an Unreal Actor Tag from this Actor
		RotateTo	Smoothly rotates this actor to an angle over a certain time
		SetCastShadow	Sets this Actor's to cast shadows or not
		SetCollision	Sets this Actor's collision type
		SetDimension	Sets this Actor's Dimension
		SetForce	Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
		SetGravityEnabled	Sets whether gravity is enabled on this Actor
		SetHighlightEnabled	Sets whether the highlight is enabled on this Actor, and which highlight index to use
		SetLifeSpan	Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
		SetLocation	Sets this Actor's location in the game world
		SetNetworkAuthority	Sets the Player to have network authority over this Actor
		SetNetworkAuthorityAutoDistributed	Sets if this Actor will auto distribute the network authority between players
		SetOutlineEnabled	Sets whether the outline is enabled on this Actor, and which outline index to use
		SetRelativeLocation	Sets this Actor's relative location in local space (only if this actor is attached)
		SetRelativeRotation	Sets this Actor's relative rotation in local space (only if this actor is attached)
		SetRenderCullDistance	Sets this Actor's render cull distance
		SetRotation	Sets this Actor's rotation in the game world
		SetScale	Sets this Actor's scale
		SetVisibility	Sets whether the actor is visible or not
		TranslateTo	Smoothly moves this actor to a location over a certain time
	boolean	WasRecentlyRendered	Gets if this Actor was recently rendered on screen

	Returns	Name	Description
	string	GetText	Gets the current Text
	Color	GetTextColor	Gets the current Text Color
	float	GetWordSize	Gets the current Word Size
		SetAlignment	Sets the Text alignment
		SetFont	Sets the Font. The font must be pre-cooked as a offline cached, distance field font.
		SetSpacingAdjust	Sets the horizontal and vertical spacing adjust values
		SetText	Sets the Text
		SetTextColor	Sets the Text Color
		SetWordSize	Sets the Word Size

---

GetText

Gets the current Text

— Returns string (The current Text).

local text = my_textrender:GetText()

See also SetText.

---

GetTextColor

Gets the current Text Color

— Returns Color (The current Text Color).

local text_color = my_textrender:GetTextColor()

See also SetTextColor.

---

GetWordSize

Gets the current Word Size

— Returns float (The current Word Size).

local word_size = my_textrender:GetWordSize()

See also SetWordSize.

---

SetAlignment

Sets the Text alignment

my_textrender:SetAlignment(horizontal_alignment, vertical_alignment)

Type	Parameter	Default	Description
TextRenderHorizontalAlignment	horizontal_alignment	Required parameter	No description provided
TextRenderVerticalAlignment	vertical_alignment	Required parameter	No description provided

---

SetFont

Sets the Font. The font must be pre-cooked as a offline cached, distance field font.

Example working fonts:
- nanos-world::Font_LondrinaSolid_DistanceField
- nanos-world::Font_BoldPixels_DistanceField
- nanos-world::Font_Roboto_DistanceField

my_textrender:SetFont(font_asset)

Type	Parameter	Default	Description
string	font_asset	Required parameter	No description provided

---

SetSpacingAdjust

Sets the horizontal and vertical spacing adjust values

my_textrender:SetSpacingAdjust(horizontal_spacing, vertical_spacing)

Type	Parameter	Default	Description
float	horizontal_spacing	Required parameter	No description provided
float	vertical_spacing	Required parameter	No description provided

---

SetText

Sets the Text

my_textrender:SetText(text)

Type	Parameter	Default	Description
string	text	Required parameter	No description provided

See also GetText.

---

SetTextColor

Sets the Text Color

my_textrender:SetTextColor(text_color)

Type	Parameter	Default	Description
Color	text_color	Required parameter	No description provided

See also GetTextColor.

---

SetWordSize

Sets the Word Size

my_textrender:SetWordSize(word_size)

Type	Parameter	Default	Description
float	word_size	Required parameter	No description provided

See also GetWordSize.

🚀 Events

Inherited Entity Events

TextRender inherits from Base Entity Class, sharing it's events:
Base Entityscripting-reference/classes/base-classes/entity

	Name	Description
	ClassRegister	Triggered when a new Class is registered with the Inheriting System
	Destroy	Triggered when an Entity is destroyed
	Spawn	Triggered when an Entity is spawned/created
	ValueChange	Triggered when an Entity has a value changed with :SetValue()

Inherited Actor Events

TextRender inherits from Base Actor Class, sharing it's events:
Base Actorscripting-reference/classes/base-classes/actor

	Name	Description
	DimensionChange	Triggered when an Actor changes it's dimension

This class doesn't have own events.