TextRenderer
Vaelis 1.0.0 TextRenderer component reference: fields, script API, behavior and examples.
#What it does
Render text either in world space or as screen-space UI.
#How to add and use TextRenderer
Editor path: Select the target entity in the Hierarchy (left side) → look at the Inspector (right side) → click Add Component at the bottom of the Inspector → search for TextRenderer → click the component row. The Add Component picker is a centered modal with a search box; it only lists components not already attached.
For components with a dedicated editor tool, the tool is opened or activated from the location described below. Do not assume that adding the component alone activates its editor; some systems require a separate window, panel, or viewport tool.
#Component setup & editor tools
- Inspector → TextRenderer: edit the text and presentation properties. For runtime changes, use the documented this.text API.
#What you should see after adding it
The component appears as its own section in the Inspector. Its serialized settings are listed in the Component data table below. If a field is conditional, it appears only when the relevant mode/type is selected. If a field is a runtime state field (for example grounded or resolved velocity), treat it as read-only diagnostic state unless the API reference explicitly documents it as writable.
#How to read the settings
For every setting below, the documentation distinguishes type, default, meaning, and tuning direction where behavior is known. When a value represents a direction, use the engine's coordinate convention documented in Coordinate system; do not substitute Unity/Godot conventions.
#Component data
| Field | Type | Purpose | Default |
|---|---|---|---|
value | string | Displayed text. | Text |
fontSize | number | Font size. | 32 |
color | hex string | Text color. | #ffffff |
fontFamily | string | Font family name. | Arial |
bold | boolean | Bold text. | false |
italic | boolean | Italic text. | false |
align | enum | left | center | right. | left |
anchorX | number | Horizontal anchor from 0 to 1. | 0.5 |
anchorY | number | Vertical anchor from 0 to 1. | 0.5 |
opacity | number | Opacity. | 1 |
screenSpace | boolean | Render as fixed UI overlay instead of world-space text. | true |
wordWrap | boolean | Enable wrapping. | false |
wrapWidth | number | Wrap width when enabled. | 300 |
#Tuning behavior
These are the practical direction-of-change rules for the most important controls on this component.
| Setting | What changing it does |
|---|---|
fontSize | Higher = larger text. |
anchorX / anchorY | 0 = top/left pivot, 0.5 = center, 1 = bottom/right pivot for the text block. |
wrapWidth | Only used when wordWrap is enabled; larger width permits longer lines before wrapping. |
#Script API
| Member | Kind | Description |
|---|---|---|
value | Property | Displayed text. |
fontSize | Property | Font size. |
color | Property | Hex text color. |
fontFamily | Property | Font family. |
bold | Property | Bold toggle. |
italic | Property | Italic toggle. |
align | Property | left | center | right. |
anchorX | Property | Horizontal anchor. |
anchorY | Property | Vertical anchor. |
opacity | Property | Opacity. |
screenSpace | Property | Use screen-space UI behavior. |
wordWrap | Property | Enable word wrapping. |
wrapWidth | Property | Wrap width. |
#Examples
this.text.value = "Score: " + score;this.text.screenSpace = true;