s&
About
The Project
infoAbout s&box mapRoadmap monitoringMetricsEngine startup and usage numbers
Updates
newspaperLatest News published_with_changesChangesRelease-by-release changelog
Games
Browse Games Discover Games
gamejamslive now

Game Jam III

Ends Fri 25 Sep
ThemeOne More Round

The jam is running. Build something, or play the entries.

£50,000
prizepool
View the jam
Workshop
Playable
sports_esportsGamesStandalone games and gamemodes
Assets
landscapeMaps view_in_arModels textureMaterials apparelClothing
appsEverythingEvery asset type in one list
Forum
Learn
Documentation
rocket_launchGetting Started docsDocumentation apiAPI Reference
Resources
schoolTutorials manage_searchCode Search
inputLog in with Steam
Api
Classes
TextRenderer
chevron_left Classes
class
TextRenderer

Constructors

functionsTextRenderer

Properties

data_objectBillboarddata_objectBlendModedata_objectColordata_objectComponentVersiondata_objectFogStrengthdata_objectFontFamilydata_objectFontSizedata_objectFontWeightdata_objectHorizontalAlignmentdata_objectScaledata_objectTextdata_objectTextScopedata_objectVerticalAlignment
TextRenderer
Renders text in the world
class Sandbox .account_tree extends Renderer
sealedSandbox.Engine

build Constructors 1

TextRenderer ()

data_object Properties 13

Billboard
BillboardMode
Controls how the text orients itself toward the camera.
BlendMode
BlendMode
The blend mode of the text. This determines how the text is rendered over the world.
Color
Color
The color of the text from the TextScope.
ComponentVersion
int
FogStrength
float
The strength of the fog effect applied to the text. This determines how much the text blends with any fog in the scene.
FontFamily
string
FontSize
float
The font size of the text from the TextScope. This is different from the Scale, which determines how large the text appears in the world.
FontWeight
int
HorizontalAlignment
HAlignment
The horizontal alignment of the text in the world.
Scale
float
The size of the text in the world. This is different from the font size, which is defined in the TextScope and determines resolution of the rendered text.
Text
string
TextScope
Scope
The text scope defines what text to render and it's visual properties (such as font, color, outline, etc.)
VerticalAlignment
VAlignment
The vertical alignment of the text in the world.

Inheritance

Component
Renderer
TextRenderer
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.
Facepunch
  • News
  • Docs
  • Metrics
  • FAQ
  • Forum
  • Discord
  • Twitter