🆒 TextRender

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

---

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

👪Inheritance

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

🧑‍💻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",
    Vector(1, 1, 1), -- Scale
    Color(1, 0, 0), -- Red Color
    FontType.OpenSans,
    TextRenderAlignCamera.FaceCamera
)

info

If you desire your TextRender to be visible through walls, replace it's material with the nanos Default TranslucentDepth one!

SetMaterial("nanos-world::M_Default_Translucent_Lit_Depth").

You can also tweak it's color and other properties using the Material methods.

Étiquettesgetting-started/tutorials-and-examples/name-tags

🛠 Constructors

Default Constructor

local my_textrender = TextRender(location, rotation, text, scale?, color?, font_type?, align_camera?)

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
Vector	scale	Vector(1, 1, 1)	No description provided
Color	color	Color(1, 1, 1, 1)	No description provided
FontType	font_type	FontType.Roboto	No description provided
TextRenderAlignCamera	align_camera	TextRenderAlignCamera.Unaligned	No description provided

🗿 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
		AddImpulse	Applies a force in world world to this Actor
		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
	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
		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)
		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

Inherited Paintable Functions

TextRender inherits from Base Paintable Class, sharing it's methods and functions:
Base Paintablescripting-reference/classes/base-classes/Paintable

	Returns	Name	Description
		ResetMaterial	Resets the material from the specified index to the original one
		SetMaterial	Sets the material at the specified index of this Actor
		SetMaterialColorParameter	Sets a Color parameter in this Actor's material
		SetMaterialFromCanvas	Sets the material at the specified index of this Actor to a Canvas object
		SetMaterialFromSceneCapture	Sets the material at the specified index of this Actor to a SceneCapture object
		SetMaterialFromWebUI	Sets the material at the specified index of this Actor to a WebUI object
		SetMaterialScalarParameter	Sets a Scalar parameter in this Actor's material
		SetMaterialTextureParameter	Sets a texture parameter in this Actor's material to an image on disk
		SetMaterialVectorParameter	Sets a Vector parameter in this Actor's material
		SetPhysicalMaterial	Overrides this Actor's Physical Material with a new one

	Returns	Name	Description
		SetColor	Sets the Color
		SetFont	Sets the Font
		SetFreeze	Freeze mesh rebuild, to avoid unnecessary mesh rebuilds when setting a few properties together
		SetGlyphSettings	Sets the Glyph representation settings to generate the 3D Mesh for this text render
		SetMaxSize	Sets the Max Size of the TextRender, optionally scaling it proportionally
		SetText	Sets the Text
		SetTextSettings	Sets the Text & Font settings for this text render

---

SetColor

Sets the Color (Internally this will call the SetMaterialColorParameter("Tint", color) method)

my_textrender:SetColor(color)

Type	Parameter	Default	Description
Color	color	Required parameter	No description provided

---

SetFont

Sets the Font

my_textrender:SetFont(font_type)

Type	Parameter	Default	Description
FontType	font_type	Required parameter	No description provided

---

SetFreeze

Freeze mesh rebuild, to avoid unnecessary mesh rebuilds when setting a few properties together

my_textrender:SetFreeze(freeze)

Type	Parameter	Default	Description
boolean	freeze	Required parameter	No description provided

---

SetGlyphSettings

Sets the Glyph representation settings to generate the 3D Mesh for this text render

my_textrender:SetGlyphSettings(extrude?, level?, bevel_type?, bevel_segments?, outline?)

Type	Parameter	Default	Description
float	extrude?	0	No description provided
float	level?	0	No description provided
TextRenderBevelType	bevel_type?	TextRenderBevelType.Convex	No description provided
integer	bevel_segments?	8	No description provided
boolean	outline?	false	No description provided

---

SetMaxSize

Sets the Max Size of the TextRender, optionally scaling it proportionally

my_textrender:SetMaxSize(max_width?, max_height?, scale_proportionally?)

Type	Parameter	Default	Description
integer	max_width?	0	No description provided
integer	max_height?	0	No description provided
boolean	scale_proportionally?	true	No description provided

---

SetText

Sets the Text

my_textrender:SetText(text)

Type	Parameter	Default	Description
string	text	Required parameter	No description provided

---

SetTextSettings

Sets the Text & Font settings for this text render

my_textrender:SetTextSettings(kerning?, line_spacing?, word_spacing?, horizontal_alignment?, vertical_alignment?)

Type	Parameter	Default	Description
float	kerning?	0	No description provided
float	line_spacing?	0	No description provided
float	word_spacing?	0	No description provided
TextRenderHorizontalAlignment	horizontal_alignment?	TextRenderHorizontalAlignment.Center	No description provided
TextRenderVerticalAlignment	vertical_alignment?	0TextRenderVerticalAlignment.Center	No description provided

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