Label | Godot Docs 4.3 | ROKOJORI Labs

class-description

NEWS

COMMUNITY

STORE

LABS

LOGOUT

LOGOUT

Object

Label

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.

AutowrapMode

autowrap_mode

()

:AutowrapMode

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 AutowrapMode.

bool

clip_text

()

:bool

If true, the Label only shows the text that fits inside its bounding rectangle and will clip text horizontally.

String

ellipsis_char

()

:String

Ellipsis character used for text clipping.

HorizontalAlignment

horizontal_alignment

()

:HorizontalAlignment

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

BitField

JustificationFlag

()

:BitField

Line fill alignment rules. For more info see JustificationFlag.

LabelSettings

label_settings

()

:LabelSettings

A LabelSettings resource that can be shared between multiple Label nodes. Takes priority over theme properties.

String

language

()

:String

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

int

lines_skipped

()

:int

The number of the lines ignored and not displayed from the start of the text value.

int

max_lines_visible

()

:int

Limits the lines of text the node shows on screen.

StructuredTextParser

structured_text_bidi_override

()

:StructuredTextParser

Set BiDi algorithm override for the structured text.

Array

structured_text_bidi_override_options

()

:Array

Set additional options for BiDi override.

PackedFloat32Array

tab_stops

()

:PackedFloat32Array

Aligns text to the given tab-stops.

String

text

()

:String

The text to display on screen.

TextDirection

text_direction

()

:TextDirection

Base text writing direction.

OverrunBehavior

text_overrun_behavior

()

:OverrunBehavior

Sets the clipping behavior when the text exceeds the node's bounding rectangle. See OverrunBehavior for a description of all modes.

bool

uppercase

()

:bool

If true, all the text displays as UPPERCASE.

VerticalAlignment

vertical_alignment

()

:VerticalAlignment

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

int

visible_characters

()

:int

The number of characters to display. If set to -1, all characters are displayed. This can be useful when animating the text appearing in a dialog box.

Note: Setting this property updates visible_ratio accordingly.

VisibleCharactersBehavior

visible_characters_behavior

()

:VisibleCharactersBehavior

Sets the clipping behavior when visible_characters or visible_ratio is set. See VisibleCharactersBehavior for more info.

float

visible_ratio

()

:float

The fraction of characters to display, relative to the total number of characters (see get_total_character_count). If set to 1.0, all characters are displayed. If set to 0.5, only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box.

Note: Setting this property updates visible_characters accordingly.

Rect2

get_character_bounds

(

int

pos

:int

)

:Rect2

Returns the bounding rectangle of the character at position pos. If the character is a non-visual character or 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.

int

get_line_count

()

:int

Returns the number of lines of text the Label has.

int

get_line_height

(

int

)

:int

Returns the height of the line line.