Label¶

Inherits: Control < CanvasItem < Node < Object

Displays plain text in a line or wrapped inside a rectangle. For formatted text, use RichTextLabel.

Description¶

Label displays plain text on the screen. 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 formatting. For that, use RichTextLabel instead.

Note: Contrarily to most other Controls, Label's Control.mouse_filter defaults to Control.MOUSE_FILTER_IGNORE (i.e. it doesn't react to mouse input events). This implies that a label won't display any configured Control.hint_tooltip, unless you change its mouse filter.

Tutorials¶

2D Dodge The Creeps Demo

Properties¶

Align	align	`0`
AutowrapMode	autowrap_mode	`0`
bool	clip_text	`false`
String	language	`""`
int	lines_skipped	`0`
int	max_lines_visible	`-1`
MouseFilter	mouse_filter	`2` (parent override)
float	percent_visible	`1.0`
int	size_flags_vertical	`4` (parent override)
StructuredTextParser	structured_text_bidi_override	`0`
Array	structured_text_bidi_override_options	`[]`
String	text	`""`
TextDirection	text_direction	`0`
OverrunBehavior	text_overrun_behavior	`0`
bool	uppercase	`false`
VAlign	valign	`0`
int	visible_characters	`-1`

Methods¶

void	clear_opentype_features ( )
int	get_line_count ( ) const
int	get_line_height ( int line=-1 ) const
int	get_opentype_feature ( String tag ) const
int	get_total_character_count ( ) const
int	get_visible_line_count ( ) const
void	set_opentype_feature ( String tag, int value )

Theme Properties¶

Font	font
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	font_size
int	line_spacing	`3`
StyleBox	normal
int	outline_size	`0`
int	shadow_offset_x	`1`
int	shadow_offset_y	`1`
int	shadow_outline_size	`1`

Enumerations¶

enum Align:

ALIGN_LEFT = 0 --- Align rows to the left (default).
ALIGN_CENTER = 1 --- Align rows centered.
ALIGN_RIGHT = 2 --- Align rows to the right.
ALIGN_FILL = 3 --- Expand row to fit the width.

enum VAlign:

VALIGN_TOP = 0 --- Align the whole text to the top.
VALIGN_CENTER = 1 --- Align the whole text to the center.
VALIGN_BOTTOM = 2 --- Align the whole text to the bottom.
VALIGN_FILL = 3 --- Align the whole text by spreading the rows.

enum AutowrapMode:

AUTOWRAP_OFF = 0 --- Autowrap is disabled.
AUTOWRAP_ARBITRARY = 1 --- Wraps the text inside the node's bounding rectangle by allowing to break lines at arbitrary positions, which is useful when very limited space is available.
AUTOWRAP_WORD = 2 --- Wraps the text inside the node's bounding rectangle by soft-breaking between words.
AUTOWRAP_WORD_SMART = 3 --- Behaves similarly to AUTOWRAP_WORD, but force-breaks a word if that single word does not fit in one line.

enum OverrunBehavior:

OVERRUN_NO_TRIMMING = 0 --- No text trimming is performed.
OVERRUN_TRIM_CHAR = 1 --- Trims the text per character.
OVERRUN_TRIM_WORD = 2 --- Trims the text per word.
OVERRUN_TRIM_ELLIPSIS = 3 --- Trims the text per character and adds an ellipsis to indicate that parts are hidden.
OVERRUN_TRIM_WORD_ELLIPSIS = 4 --- Trims the text per word and adds an ellipsis to indicate that parts are hidden.

Property Descriptions¶

Align align

Default	`0`
Setter	set_align(value)
Getter	get_align()

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

AutowrapMode autowrap_mode

Default	`0`
Setter	set_autowrap_mode(value)
Getter	get_autowrap_mode()

If set to something other than 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

Default	`false`
Setter	set_clip_text(value)
Getter	is_clipping_text()

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

String language

Default	`""`
Setter	set_language(value)
Getter	get_language()

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

int lines_skipped

Default	`0`
Setter	set_lines_skipped(value)
Getter	get_lines_skipped()

The node ignores the first lines_skipped lines before it starts to display text.

int max_lines_visible

Default	`-1`
Setter	set_max_lines_visible(value)
Getter	get_max_lines_visible()

Limits the lines of text the node shows on screen.

float percent_visible

Default	`1.0`
Setter	set_percent_visible(value)
Getter	get_percent_visible()

Limits the amount of visible characters. If you set percent_visible to 0.5, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box.

StructuredTextParser structured_text_bidi_override

Default	`0`
Setter	set_structured_text_bidi_override(value)
Getter	get_structured_text_bidi_override()

Set BiDi algorithm override for the structured text.

Array structured_text_bidi_override_options

Default	`[]`
Setter	set_structured_text_bidi_override_options(value)
Getter	get_structured_text_bidi_override_options()

Set additional options for BiDi override.

String text

Default	`""`
Setter	set_text(value)
Getter	get_text()

The text to display on screen.

TextDirection text_direction

Default	`0`
Setter	set_text_direction(value)
Getter	get_text_direction()

Base text writing direction.

OverrunBehavior text_overrun_behavior

Default	`0`
Setter	set_text_overrun_behavior(value)
Getter	get_text_overrun_behavior()

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

bool uppercase

Default	`false`
Setter	set_uppercase(value)
Getter	is_uppercase()

If true, all the text displays as UPPERCASE.

VAlign valign

Default	`0`
Setter	set_valign(value)
Getter	get_valign()

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

int visible_characters

Default	`-1`
Setter	set_visible_characters(value)
Getter	get_visible_characters()

Restricts the number of characters to display. Set to -1 to disable.

Method Descriptions¶

void clear_opentype_features ( )

Removes all OpenType features.

int get_line_count ( ) const

Returns the amount of lines of text the Label has.

int get_line_height ( int line=-1 ) const

Returns the height of the line line.

If line is set to -1, returns the biggest line height.

If there're no lines returns font size in pixels.

int get_opentype_feature ( String tag ) const

Returns OpenType feature tag.

int get_total_character_count ( ) const

Returns the total number of printable characters in the text (excluding spaces and newlines).

int get_visible_line_count ( ) const

Returns the number of lines shown. Useful if the Label's height cannot currently display all lines.

void set_opentype_feature ( String tag, int value )

Returns OpenType feature tag. More info: OpenType feature tags.

Theme Property Descriptions¶

Font font

Font used for the Label's text.

Color font_color

Default

Color(1, 1, 1, 1)

Default text Color of the Label.

Color font_outline_color

Default

Color(1, 1, 1, 1)

The tint of Font's outline.

Color font_shadow_color

Default

Color(0, 0, 0, 0)

Color of the text's shadow effect.

int font_size

Font size of the Label's text.

int line_spacing

Default

3

Vertical space between lines in multiline Label.

StyleBox normal

Background StyleBox for the Label.

int outline_size

Default

0

Text outline size.

int shadow_offset_x

Default

1

The horizontal offset of the text's shadow.

int shadow_offset_y

Default

1

The vertical offset of the text's shadow.

int shadow_outline_size

Default

1

Shadow outline size. If set to 1 or greater, the shadow will be displayed around the whole text as an outline.