A control for displaying plain text.
A control for displaying plain text. It gives you control over the horizontal and vertical alignment and can wrap the text inside the node's bounding rectangle. It doesn't support bold, italics, or other rich text formatting. For that, use [RichTextLabel] instead.
https://godotengine.org/asset-library/asset/2712
Returns the bounding rectangle of the character at position [param pos] in the label's local coordinate system. If the character is a non-visual character or [param pos] is outside the valid range, an empty [Rect2] is returned. If the character is a part of a composite grapheme, the bounding rectangle of the whole grapheme is returned.
Returns the number of lines of text the Label has.
Returns the height of the line [param line]. If [param line] is set to [code]-1[/code], returns the biggest line height. If there are no lines, returns font size in pixels.
Returns the total number of printable characters in the text (excluding spaces and newlines).
Returns the number of lines shown. Useful if the [Label]'s height cannot currently display all lines.
- If set to something other than [constant 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 [enum TextServer.AutowrapMode].
- If [code]true[/code], the Label only shows the text that fits inside its bounding rectangle and will clip text horizontally.
- Ellipsis character used for text clipping.
- Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the [enum HorizontalAlignment] constants.
- Line fill alignment rules. See [enum TextServer.JustificationFlag] for more information.
- A [LabelSettings] resource that can be shared between multiple [Label] nodes. Takes priority over theme properties.
- Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
- The number of the lines ignored and not displayed from the start of the [member text] value.
- Limits the lines of text the node shows on screen.
- String used as a paragraph separator. Each paragraph is processed independently, in its own BiDi context.
- Set BiDi algorithm override for the structured text.
- Set additional options for BiDi override.
- Aligns text to the given tab-stops.
- The text to display on screen.
- Base text writing direction.
- Sets the clipping behavior when the text exceeds the node's bounding rectangle. See [enum TextServer.OverrunBehavior] for a description of all modes.
- If [code]true[/code], all the text displays as UPPERCASE.
- Controls the text's vertical alignment. Supports top, center, bottom, and fill. Set it to one of the [enum VerticalAlignment] constants.
- The number of characters to display. If set to [code]-1[/code], all characters are displayed. This can be useful when animating the text appearing in a dialog box. [b]Note:[/b] Setting this property updates [member visible_ratio] accordingly.
- Sets the clipping behavior when [member visible_characters] or [member visible_ratio] is set. See [enum TextServer.VisibleCharactersBehavior] for more info.
- The fraction of characters to display, relative to the total number of characters (see [method get_total_character_count]). If set to [code]1.0[/code], all characters are displayed. If set to [code]0.5[/code], only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box. [b]Note:[/b] Setting this property updates [member visible_characters] accordingly.
Default text [Color] of the [Label].
The color of text outline.
[Color] of the text's shadow effect.
Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative.
Text outline size. [b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended. [b]Note:[/b] Using a value that is larger than half the font size is not recommended, as the font outline may fail to be fully closed in this case.
Vertical space between paragraphs. Added on top of [theme_item line_spacing].
The horizontal offset of the text's shadow.
The vertical offset of the text's shadow.
The size of the shadow outline.
[Font] used for the [Label]'s text.
Font size of the [Label]'s text.
Background [StyleBox] for the [Label].