Ir para o conteúdo principal
Version: bleeding-edge 🩸

🆒 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 (if you spawn it on client, it won't be synchronized with other players).
👪Inheritance
This class inherits from 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 nanos Default TranslucentDepth one!

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

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

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

🏗️ Constructor

local my_textrender = TextRender(location?, rotation?, text?, scale?, color?, font_type?, align_camera?)
TypeNameDefaultDescription
Vector locationVector(0, 0, 0)
Rotator rotationRotator(0, 0, 0)
string text
Vector scaleVector(1, 1, 1)
Color colorColor(1, 1, 1, 1)
FontTypefont_typeFontType.Roboto
TextRenderAlignCameraalign_cameraTextRenderAlignCamera.Unaligned

🦠 Functions

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
DestroyDestroys this Actor
DetachDetaches this Actor from AttachedTo Actor
SetCollisionSets this Actor's collision type
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
SetValueSets a value in this Actor
TranslateToSmoothly moves this actor to a location over a certain time
RotateToSmoothly rotates this actor to an angle over a certain time
boolean IsBeingDestroyedReturns true if this Actor is being destroyed
boolean IsVisibleReturns true if this Actor is visible
boolean IsGravityEnabledReturns true if gravity is enabled on this Actor
boolean IsInWaterReturns true if this Actor is in water
boolean IsNetworkDistributedReturns true if this Actor is currently network distributed
boolean IsValidReturns true if this Actor is valid (i.e. wasn't destroyed and points to a valid Actor)
table of Base Actor GetAttachedEntitiesGets all Actors attached to this Actor
Base Actor or nilGetAttachedToGets the Actor this Actor is attached to
table GetBoundsGets this Actor's bounds
CollisionTypeGetCollisionGets this Actor's collision type
number GetIDGets the universal network ID of this Actor (same on both client and server)
Vector GetLocationGets this Actor's location in the game world
Rotator GetRotationGets this Actor's angle in the game world
Vector GetForceGets this Actor's force (set by SetForce())
boolean HasNetworkAuthorityReturns true if the local Player is currently the Network Authority of this Actor
boolean HasAuthorityGets if this Actor was spawned by the client side
Vector GetScaleGets this Actor's scale
string GetTypeGets the type of this Actor
any GetValueGets a value stored on this Actor at the given key. Please refer to Entity Values for more information
Vector GetVelocityGets this Actor's current velocity
AddActorTagAdds an Unreal Actor Tag to this Actor
RemoveActorTagRemoves an Unreal Actor Tag from this Actor
table of string GetActorTagsGets all Unreal Actor Tags on this Actor
function SubscribeSubscribes to an Event
UnsubscribeUnsubscribes all callbacks from this Event in this Actor within this Package, or only the callback passed
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_entity:SetColor(color)
TypeParameterDefaultDescription
Color color

SetFont

Sets the Font
my_entity:SetFont(font_type)
TypeParameterDefaultDescription
FontTypefont_type

SetFreeze

Freeze mesh rebuild, to avoid unnecessary mesh rebuilds when setting a few properties together
my_entity:SetFreeze(freeze)
TypeParameterDefaultDescription
boolean freeze

SetGlyphSettings

Sets the Glyph representation settings to generate the 3D Mesh for this text render
my_entity:SetGlyphSettings(extrude?, level?, bevel_type?, bevel_segments?, outline?)
TypeParameterDefaultDescription
number extrude?0
number level?0
TextRenderBevelTypebevel_type?TextRenderBevelType.Convex
number bevel_segments?8
boolean outline?false

SetMaxSize

Sets the Max Size of the TextRender, optionally scaling it proportionally
my_entity:SetMaxSize(max_width?, max_height?, scale_proportionally?)
TypeParameterDefaultDescription
number max_width?0
number max_height?0
boolean scale_proportionally?true

SetText

Sets the Text
my_entity:SetText(text)
TypeParameterDefaultDescription
string text

SetTextSettings

Sets the Text & Font settings for this text render
my_entity:SetTextSettings(kerning?, line_spacing?, word_spacing?, horizontal_alignment?, vertical_alignment?)
TypeParameterDefaultDescription
number kerning?0
number line_spacing?0
number word_spacing?0
TextRenderHorizontalAlignmenthorizontal_alignment?TextRenderHorizontalAlignment.Center
TextRenderVerticalAlignmentvertical_alignment?0TextRenderVerticalAlignment.Center

🚀 Events

Inherited Actor Events
Base Actorscripting-reference/classes/base-classes/actor
NameDescription
DestroyTriggered when an Actor is destroyed
SpawnTriggered when an Actor is spawned/created
ValueChangeTriggered when an Actor has a value changed with :SetValue()
This entity doesn't have own events.