Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Label¶

Inherits: Control < CanvasItem < Node < Object

A control for displaying plain text.

Description¶

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.

Tutorials¶

2D Dodge The Creeps Demo

Properties¶

AutowrapMode	autowrap_mode	`0`
bool	clip_text	`false`
HorizontalAlignment	horizontal_alignment	`0`
BitField<JustificationFlag>	justification_flags	`163`
LabelSettings	label_settings
String	language	`""`
int	lines_skipped	`0`
int	max_lines_visible	`-1`
MouseFilter	mouse_filter	`2` (overrides Control)
BitField<SizeFlags>	size_flags_vertical	`4` (overrides Control)
StructuredTextParser	structured_text_bidi_override	`0`
Array	structured_text_bidi_override_options	`[]`
PackedFloat32Array	tab_stops	`PackedFloat32Array()`
String	text	`""`
TextDirection	text_direction	`0`
OverrunBehavior	text_overrun_behavior	`0`
bool	uppercase	`false`
VerticalAlignment	vertical_alignment	`0`
int	visible_characters	`-1`
VisibleCharactersBehavior	visible_characters_behavior	`0`
float	visible_ratio	`1.0`

Methods¶

int	get_line_count ( ) const
int	get_line_height ( int line=-1 ) const
int	get_total_character_count ( ) const
int	get_visible_line_count ( ) const

Theme Properties¶

Color	font_color	`Color(1, 1, 1, 1)`
Color	font_outline_color	`Color(1, 1, 1, 1)`
Color	font_shadow_color	`Color(0, 0, 0, 0)`
int	line_spacing	`3`
int	outline_size	`0`
int	shadow_offset_x	`1`
int	shadow_offset_y	`1`
int	shadow_outline_size	`1`
Font	font
int	font_size
StyleBox	normal

Property Descriptions¶

AutowrapMode autowrap_mode = 0

void set_autowrap_mode ( AutowrapMode value )
AutowrapMode get_autowrap_mode ( )

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 = false

void set_clip_text ( bool value )
bool is_clipping_text ( )

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

HorizontalAlignment horizontal_alignment = 0

void set_horizontal_alignment ( HorizontalAlignment value )
HorizontalAlignment get_horizontal_alignment ( )

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

BitField<JustificationFlag> justification_flags = 163

void set_justification_flags ( BitField<JustificationFlag> value )
BitField<JustificationFlag> get_justification_flags ( )

Line fill alignment rules. For more info see JustificationFlag.

LabelSettings label_settings

void set_label_settings ( LabelSettings value )
LabelSettings get_label_settings ( )

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

String language = ""

void set_language ( String value )
String get_language ( )

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

int lines_skipped = 0

void set_lines_skipped ( int value )
int get_lines_skipped ( )

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

int max_lines_visible = -1

void set_max_lines_visible ( int value )
int get_max_lines_visible ( )

Limits the lines of text the node shows on screen.

StructuredTextParser structured_text_bidi_override = 0

void set_structured_text_bidi_override ( StructuredTextParser value )