A node for displaying plain text in 3D space.
A node for displaying plain text in 3D space. By adjusting various properties of this node, you can configure things such as the text's appearance and whether it always faces the camera.
If set to something other than TextServer.AUTOWRAP_OFF, the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text.
Autowrap space trimming flags. See TextServer.BREAK_TRIM_START_EDGE_SPACES and TextServer.BREAK_TRIM_END_EDGE_SPACES for more info.
If true, text can be seen from the back as well, if false, it is invisible when looking at it from behind.
If true, the label is rendered at the same size regardless of distance. The label's size on screen is the same as if the camera was 1.0 units away from the label's origin, regardless of the actual distance from the camera. The Camera3D's field of view (or Camera3D.size when in orthogonal/frustum mode) still affects the size the label is drawn at.
Font size of the Label3D's text. To make the font look more detailed when up close, increase font_size while decreasing pixel_size at the same time.
Higher font sizes require more time to render new characters, which can cause stuttering during gameplay.
Controls the text's horizontal alignment. Supports left, center, right, and fill (also known as justify).
Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.
Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative.
Sets the render priority for the text outline. Higher priority objects will be sorted in front of lower priority objects.
Note: This only applies if alpha_cut is set to ALPHA_CUT_DISABLED (default value).
Note: This only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority).
The size of one pixel's width on the label to scale it in 3D. To make the font look more detailed when up close, increase font_size while decreasing pixel_size at the same time.
Sets the render priority for the text. Higher priority objects will be sorted in front of lower priority objects.
Note: This only applies if alpha_cut is set to ALPHA_CUT_DISABLED (default value).
Note: This only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority).
Controls the text's vertical alignment. Supports top, center, and bottom.
Returns a TriangleMesh with the label's vertices following its current configuration (such as its pixel_size).
FLAG_SHADED = 0If set, lights in the environment affect the label.
FLAG_DOUBLE_SIDED = 1If set, text can be seen from the back as well. If not, the text is invisible when looking at it from behind.
FLAG_DISABLE_DEPTH_TEST = 2Disables the depth test, so this object is drawn on top of all others. However, objects drawn after it in the draw order may cover it.
FLAG_FIXED_SIZE = 3Label is scaled by depth so that it always appears the same size on screen.
FLAG_MAX = 4Represents the size of the DrawFlags enum.
ALPHA_CUT_DISABLED = 0This mode performs standard alpha blending. It can display translucent areas, but transparency sorting issues may be visible when multiple transparent materials are overlapping. GeometryInstance3D.cast_shadow has no effect when this transparency mode is used; the Label3D will never cast shadows.
ALPHA_CUT_DISCARD = 1This mode only allows fully transparent or fully opaque pixels. Harsh edges will be visible unless some form of screen-space antialiasing is enabled (see ProjectSettings.rendering/anti_aliasing/quality/screen_space_aa). This mode is also known as alpha testing or 1-bit transparency.
Note: This mode might have issues with anti-aliased fonts and outlines, try adjusting alpha_scissor_threshold or using MSDF font.
Note: When using text with overlapping glyphs (e.g., cursive scripts), this mode might have transparency sorting issues between the main text and the outline.
ALPHA_CUT_OPAQUE_PREPASS = 2This mode draws fully opaque pixels in the depth prepass. This is slower than ALPHA_CUT_DISABLED or ALPHA_CUT_DISCARD, but it allows displaying translucent areas and smooth edges while using proper sorting.
Note: When using text with overlapping glyphs (e.g., cursive scripts), this mode might have transparency sorting issues between the main text and the outline.
ALPHA_CUT_HASH = 3This mode draws cuts off all values below a spatially-deterministic threshold, the rest will remain opaque.