Inheritance #

TextMesh #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

Generate an PrimitiveMesh from the text.

Generate an PrimitiveMesh from the text.

TextMesh can be generated only when using dynamic fonts with vector glyph contours. Bitmap fonts (including bitmap data in the TrueType/OpenType containers, like color emoji fonts) are not supported.

The UV layout is arranged in 4 horizontal strips, top to bottom: 40% of the height for the front face, 40% for the back face, 10% for the outer edges and 10% for the inner edges.

Members #

var autowrap_mode = AUTOWRAP_OFF#

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. To see how each mode behaves, see TextServer.AutowrapMode.

var curve_step: float = 0.5#

Step (in pixels) used to approximate Bézier curves.

var depth: float = 0.05#

Depths of the mesh, if set to 0.0 only front surface, is generated, and UV layout is changed to use full texture for the front face only.

var font: Font#

Font configuration used to display text.

var font_size: int = 16#

Font size of the TextMesh's text.

var horizontal_alignment: int = 1#

Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the HorizontalAlignment constants.

var justification_flags: int = 163#

Line fill alignment rules. See TextServer.JustificationFlag for more information.

var language: String = ""#

Language code used for text shaping algorithms, if left empty current locale is used instead.

var line_spacing: float = 0.0#

Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative.

var offset: Vector2 = Vector2(0, 0)#

The text drawing offset (in pixels).

var pixel_size: float = 0.01#

The size of one pixel's width on the text to scale it in 3D.

var structured_text_bidi_override = STRUCTURED_TEXT_DEFAULT#

Set BiDi algorithm override for the structured text.

var structured_text_bidi_override_options: Array = []#

Set additional options for BiDi override.

var text: String = ""#

The text to generate mesh from.

Note: Due to being a Resource, it doesn't follow the rules of Node.auto_translate_mode. If disabling translation is desired, it should be done manually with Object.set_message_translation.

var text_direction = DIRECTION_AUTO#

Base text writing direction.

var uppercase: bool = false#

If true, all the text displays as UPPERCASE.

var vertical_alignment: int = 1#

Controls the text's vertical alignment. Supports top, center, bottom. Set it to one of the VerticalAlignment constants.

var width: float = 500.0#

Text width (in pixels), used for fill alignment.

Methods #

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

Theme Items #

Tutorials #