Skip to main content

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.

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 Default TranslucentDepth one!

SetMaterial("helix::M_Default_Translucent_Lit_Depth").

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

Nametagsgetting-started/code-examples/name-tags

Constructors

Default Constructor

local my_textrender = TextRender(location, rotation, text, scale?, color?, font_type?, align_camera?)
TypeNameDefaultDescription
Vectorlocation
Rotatorrotation
stringtext
VectorscaleVector(1, 1, 1)
ColorcolorColor(1, 1, 1, 1)
FontTypefont_typeFontType.Roboto
TextRenderAlignCameraalign_cameraTextRenderAlignCamera.Unaligned

Static Functions

Inherited Entity Static Functions
Base Entityscripting-reference/classes/base-classes/Entity
ReturnsNameDescription
table of Base EntityGetAllReturns a table containing all Entities of the class this is called on
Base EntityGetByIndexReturns a specific Entity of this class at an index
integerGetCountReturns how many Entities of this class exist
iteratorGetPairsReturns an iterator with all Entities of this class to be used with pairs()
tableInheritInherits this class with the Inheriting System
table of tableGetInheritedClassesGets a list of all directly inherited classes from this Class created with the Inheriting System
table or nilGetParentClassGets the parent class if this Class was created with the Inheriting System
booleanIsChildOfGets if this Class is child of another class if this Class was created with the Inheriting System
functionSubscribeSubscribes to an Event for all entities of this Class
functionSubscribeRemoteSubscribes to a custom event called from server
UnsubscribeUnsubscribes all callbacks from this Event in this Class within this Package, or only the callback passed
This entity doesn't have own static functions.

Functions

Inherited Entity Functions
Base Entityscripting-reference/classes/base-classes/Entity
ReturnsNameDescription
integerGetIDGets the universal network ID of this Entity (same on both client and server)
tableGetClassGets the class of this entity
booleanIsARecursively checks if this entity is inherited from a Class
functionSubscribeSubscribes to an Event on this specific entity
functionSubscribeRemoteSubscribes to a custom event called from server on this specific entity
UnsubscribeUnsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed
SetValueSets a Value in this Entity
anyGetValueGets a Value stored on this Entity at the given key
DestroyDestroys this Entity
booleanIsValidReturns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
CallRemoteEventCalls a custom remote event directly on this entity to a specific Player
CallRemoteEventCalls a custom remote event directly on this entity
BroadcastRemoteEventCalls a custom remote event directly on this entity to all Players
Inherited Actor Functions
Base Actorscripting-reference/classes/base-classes/Actor
ReturnsNameDescription
AddImpulseApplies a force in world world to this Actor
AttachToAttaches this Actor to any other Actor, optionally at a specific bone
DetachDetaches this Actor from AttachedTo Actor
SetCollisionSets this Actor's collision type
SetDimensionSets this Actor's Dimension
SetForceAdds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
SetGravityEnabledSets whether gravity is enabled on this Actor
SetVisibilitySets whether the actor is visible or not
SetHighlightEnabledSets whether the highlight is enabled on this Actor, and which highlight index to use
SetOutlineEnabledSets whether the outline is enabled on this Actor, and which outline index to use
SetLifeSpanSets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
SetLocationSets this Actor's location in the game world
SetRotationSets this Actor's rotation in the game world
SetRelativeLocationSets this Actor's relative location in local space (only if this actor is attached)
SetRelativeRotationSets this Actor's relative rotation in local space (only if this actor is attached)
SetScaleSets this Actor's scale
SetNetworkAuthoritySets the Player to have network authority over this Actor
SetNetworkAuthorityAutoDistributedSets if this Actor will auto distribute the network authority between players
TranslateToSmoothly moves this actor to a location over a certain time
RotateToSmoothly rotates this actor to an angle over a certain time
booleanIsBeingDestroyedReturns true if this Actor is being destroyed
booleanIsVisibleReturns true if this Actor is visible
booleanIsGravityEnabledReturns true if gravity is enabled on this Actor
booleanIsInWaterReturns true if this Actor is in water
booleanIsNetworkDistributedReturns true if this Actor is currently network distributed
table of Base ActorGetAttachedEntitiesGets all Actors attached to this Actor
Base Actor or nilGetAttachedToGets the Actor this Actor is attached to
tableGetBoundsGets this Actor's bounds
CollisionTypeGetCollisionGets this Actor's collision type
VectorGetLocationGets this Actor's location in the game world
VectorGetRelativeLocationGets this Actor's Relative Location if it's attached
Player or nilGetNetworkAuthorityGets this Actor's Network Authority Player
RotatorGetRotationGets this Actor's angle in the game world
RotatorGetRelativeRotationGets this Actor's Relative Rotation if it's attached
VectorGetForceGets this Actor's force (set by SetForce())
integerGetDimensionGets this Actor's dimension
booleanHasNetworkAuthorityReturns true if the local Player is currently the Network Authority of this Actor
booleanHasAuthorityGets if this Actor was spawned by the client side
VectorGetScaleGets this Actor's scale
VectorGetVelocityGets this Actor's current velocity
AddActorTagAdds an Unreal Actor Tag to this Actor
RemoveActorTagRemoves an Unreal Actor Tag from this Actor
table of stringGetActorTagsGets all Unreal Actor Tags on this Actor
booleanWasRecentlyRenderedGets if this Actor was recently rendered on screen
floatGetDistanceFromCameraGets the distance of this Actor from the Camera
floatGetScreenPercentageGets the percentage of this Actor size in the screen
Inherited Paintable Functions
Base Paintablescripting-reference/classes/base-classes/Paintable
ReturnsNameDescription
SetMaterialSets the material at the specified index of this Actor
SetMaterialFromCanvasSets the material at the specified index of this Actor to a Canvas object
SetMaterialFromSceneCaptureSets the material at the specified index of this Actor to a SceneCapture object
SetMaterialFromWebUISets the material at the specified index of this Actor to a WebUI object
ResetMaterialResets the material from the specified index to the original one
SetMaterialColorParameterSets a Color parameter in this Actor's material
SetMaterialScalarParameterSets a Scalar parameter in this Actor's material
SetMaterialTextureParameterSets a texture parameter in this Actor's material to an image on disk
SetMaterialVectorParameterSets a Vector parameter in this Actor's material
SetPhysicalMaterialOverrides this Actor's Physical Material with a new one
ReturnsNameDescription
SetColorSets the Color
SetFontSets the Font
SetFreezeFreeze mesh rebuild, to avoid unnecessary mesh rebuilds when setting a few properties together
SetGlyphSettingsSets the Glyph representation settings to generate the 3D Mesh for this text render
SetMaxSizeSets the Max Size of the TextRender, optionally scaling it proportionally
SetTextSets the Text
SetTextSettingsSets 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

SetFont

Sets the Font

my_textrender:SetFont(font_type)
TypeParameterDefaultDescription
FontTypefont_type

SetFreeze

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

my_textrender:SetFreeze(freeze)
TypeParameterDefaultDescription
booleanfreeze

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
floatextrude?0
floatlevel?0
TextRenderBevelTypebevel_type?TextRenderBevelType.Convex
integerbevel_segments?8
booleanoutline?false

SetMaxSize

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

my_textrender:SetMaxSize(max_width?, max_height?, scale_proportionally?)
TypeParameterDefaultDescription
integermax_width?0
integermax_height?0
booleanscale_proportionally?true

SetText

Sets the Text

my_textrender:SetText(text)
TypeParameterDefaultDescription
stringtext

SetTextSettings

Sets the Text & Font settings for this text render

my_textrender:SetTextSettings(kerning?, line_spacing?, word_spacing?, horizontal_alignment?, vertical_alignment?)
TypeParameterDefaultDescription
floatkerning?0
floatline_spacing?0
floatword_spacing?0
TextRenderHorizontalAlignmenthorizontal_alignment?TextRenderHorizontalAlignment.Center
TextRenderVerticalAlignmentvertical_alignment?0TextRenderVerticalAlignment.Center

Events

Inherited Entity Events
Base Entityscripting-reference/classes/base-classes/Entity
NameDescription
SpawnTriggered when an Entity is spawned/created
DestroyTriggered when an Entity is destroyed
ValueChangeTriggered when an Entity has a value changed with :SetValue()
ClassRegisterTriggered when a new Class is registered with the Inheriting System
Inherited Actor Events
Base Actorscripting-reference/classes/base-classes/Actor
NameDescription
SpawnTriggered when an Entity is spawned/created
DestroyTriggered when an Entity is destroyed
ValueChangeTriggered when an Entity has a value changed with :SetValue()
ClassRegisterTriggered when a new Class is registered with the Inheriting System
This entity doesn't have own events.