Skip to main content
Version: latest - a1.65.x βš–οΈ

πŸ†’ 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.

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

πŸ›  Constructors​

Default Constructor

local my_textrender = TextRender(location, rotation, text, scale?, color?, font_type?, align_camera?)
TypeNameDefaultDescription
Vectorlocation Required parameter No description provided
Rotatorrotation Required parameter No description provided
text Required parameter No description provided
VectorscaleVector(1, 1, 1)No description provided
ColorcolorColor(1, 1, 1, 1)No description provided
font_typeFontType.RobotoNo description provided
align_cameraTextRenderAlignCamera.UnalignedNo 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
ReturnsNameDescription
of Base EntityReturns a table containing all Entities of the class this is called on
Base EntityReturns a specific Entity of this class at an index
Returns how many Entities of this class exist
of Gets a list of all directly inherited classes from this Class created with the Inheriting System
Returns an iterator with all Entities of this class to be used with pairs()
or Gets the parent class if this Class was created with the Inheriting System
Inherits this class with the Inheriting System
Gets if this Class is child of another class if this Class was created with the Inheriting System
Subscribes to an Event for all entities of this Class
Subscribes to a custom event called from server
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
ReturnsNameDescription
Calls a custom remote event directly on this entity to all Players
Calls a custom remote event directly on this entity to a specific Player
Calls a custom remote event directly on this entity
Destroys this Entity
of Gets a list of all values keys
Gets the class of this entity
Gets the universal network ID of this Entity (same on both client and server)
Gets a Value stored on this Entity at the given key
Recursively checks if this entity is inherited from a Class
Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
Sets a Value in this Entity
Subscribes to an Event on this specific entity
Subscribes to a custom event called from server on this specific entity
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
ReturnsNameDescription
Adds an Unreal Actor Tag to this Actor
Applies a force in world world to this Actor
Attaches this Actor to any other Actor, optionally at a specific bone
Detaches this Actor from AttachedTo Actor
of Gets all Unreal Actor Tags on this Actor
of Base ActorGets all Actors attached to this Actor
Base Actor or Gets the Actor this Actor is attached to
Gets this Actor's bounds
Gets this Actor's collision type
Gets this Actor's dimension
Gets the distance of this Actor from the Camera
VectorGets this Actor's force (set by SetForce())
VectorGets this Actor's location in the game world
Player or Gets this Actor's Network Authority Player
VectorGets this Actor's Relative Location if it's attached
RotatorGets this Actor's Relative Rotation if it's attached
RotatorGets this Actor's angle in the game world
VectorGets this Actor's scale
Gets the percentage of this Actor size in the screen
VectorGets this Actor's current velocity
Gets if this Actor was spawned by the client side
Returns true if the local Player is currently the Network Authority of this Actor
Returns true if this Actor is being destroyed
Returns true if gravity is enabled on this Actor
Returns true if this Actor is in water
Returns true if this Actor is currently network distributed
Returns true if this Actor is visible
Removes an Unreal Actor Tag from this Actor
Smoothly rotates this actor to an angle over a certain time
Sets this Actor's collision type
Sets this Actor's Dimension
Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
Sets whether gravity is enabled on this Actor
Sets whether the highlight is enabled on this Actor, and which highlight index to use
Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
Sets this Actor's location in the game world
Sets the Player to have network authority over this Actor
Sets if this Actor will auto distribute the network authority between players
Sets whether the outline is enabled on this Actor, and which outline index to use
Sets this Actor's relative location in local space (only if this actor is attached)
Sets this Actor's relative rotation in local space (only if this actor is attached)
Sets this Actor's rotation in the game world
Sets this Actor's scale
Sets whether the actor is visible or not
Smoothly moves this actor to a location over a certain time
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
ReturnsNameDescription
Resets the material from the specified index to the original one
Sets the material at the specified index of this Actor
Sets a Color parameter in this Actor's material
Sets the material at the specified index of this Actor to a Canvas object
Sets the material at the specified index of this Actor to a SceneCapture object
Sets the material at the specified index of this Actor to a WebUI object
Sets a Scalar parameter in this Actor's material
Sets a texture parameter in this Actor's material to an image on disk
Sets a Vector parameter in this Actor's material
Overrides this Actor's Physical Material with a new one
ReturnsNameDescription
Sets the Color
Sets the Font
Freeze mesh rebuild, to avoid unnecessary mesh rebuilds when setting a few properties together
Sets the Glyph representation settings to generate the 3D Mesh for this text render
Sets the Max Size of the TextRender, optionally scaling it proportionally
Sets the Text
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)
TypeParameterDefaultDescription
Colorcolor Required parameter No description provided

SetFont

Sets the Font

my_textrender:SetFont(font_type)
TypeParameterDefaultDescription
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)
TypeParameterDefaultDescription
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?)
TypeParameterDefaultDescription
extrude?0No description provided
level?0No description provided
bevel_type?TextRenderBevelType.ConvexNo description provided
bevel_segments?8No description provided
outline?falseNo description provided

SetMaxSize

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

my_textrender:SetMaxSize(max_width?, max_height?, scale_proportionally?)
TypeParameterDefaultDescription
max_width?0No description provided
max_height?0No description provided
scale_proportionally?trueNo description provided

SetText

Sets the Text

my_textrender:SetText(text)
TypeParameterDefaultDescription
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?)
TypeParameterDefaultDescription
kerning?0No description provided
line_spacing?0No description provided
word_spacing?0No description provided
horizontal_alignment?TextRenderHorizontalAlignment.CenterNo description provided
vertical_alignment?0TextRenderVerticalAlignment.CenterNo description provided

πŸš€ Events​

Inherited Entity Events
TextRender inherits from Base Entity Class, sharing it's events:
Base Entityscripting-reference/classes/base-classes/Entity
NameDescription
Triggered when a new Class is registered with the Inheriting System
Triggered when an Entity is destroyed
Triggered when an Entity is spawned/created
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
NameDescription
Triggered when an Actor changes it's dimension
This class doesn't have own events.