Label

Inherits: Control < CanvasItem < Node < Object

Muestra un texto simple en una línea o envuelto dentro de un rectángulo. Para texto formateado, use RichTextLabel.

Descripción

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.

Note: Unicode characters after 0xffff (such as most emoji) are not supported on Windows. They will display as unknown characters instead. This will be resolved in Godot 4.0.

Tutoriales

• 2D Dodge The Creeps Demo

Propiedades

Align	align	0
bool	autowrap	false
bool	clip_text	false
int	lines_skipped	0
int	max_lines_visible	-1
MouseFilter	mouse_filter	2 (overrides Control)
float	percent_visible	1.0
int	size_flags_vertical	4 (overrides Control)
String	text	""
bool	uppercase	false
VAlign	valign	0
int	visible_characters	-1

Métodos

int	get_line_count ( ) const
int	get_line_height ( ) const
int	get_total_character_count ( ) const
int	get_visible_line_count ( ) const

Propiedades del Theme

Color	font_color	Color( 1, 1, 1, 1 )
Color	font_color_shadow	Color( 0, 0, 0, 0 )
Color	font_outline_modulate	Color( 1, 1, 1, 1 )
int	line_spacing	3
int	shadow_as_outline	0
int	shadow_offset_x	1
int	shadow_offset_y	1
Font	font
StyleBox	normal

Enumeraciones

enum Align:

• ALIGN_LEFT = 0 --- Alinea las filas a la izquierda (por defecto).

• ALIGN_CENTER = 1 --- Alinea las filas centradas.

• ALIGN_RIGHT = 2 --- Alinea las filas a la derecha.

• ALIGN_FILL = 3 --- Ampliar los espacios en blanco de las filas para que se ajusten al ancho.

---

enum VAlign:

• VALIGN_TOP = 0 --- Alinea todo el texto en la parte superior.

• VALIGN_CENTER = 1 --- Alinea todo el texto al centro.

• VALIGN_BOTTOM = 2 --- Alinea todo el texto al fondo.

• VALIGN_FILL = 3 --- Alinear todo el texto extendiendo las filas.

Descripciones de Propiedades

• Align align

Default	0
Setter	set_align(value)
Getter	get_align()

Controla la alineación horizontal del texto. Apoya la izquierda, el centro, la derecha, y el relleno, o la justificación. Ponlo en una de las constantes Align.

---

• bool autowrap

Default	false
Setter	set_autowrap(value)
Getter	has_autowrap()

Si true, envuelve el texto dentro del rectángulo delimitador del nodo. Si cambias el tamaño del nodo, éste cambiará su altura automáticamente para mostrar todo el texto.

---

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

---

• int lines_skipped

Default	0
Setter	set_lines_skipped(value)
Getter	get_lines_skipped()

El nodo ignora las primeras líneas lines_skipped antes de empezar a mostrar el texto.

---

• int max_lines_visible

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

Limita las líneas de texto que el nodo muestra en la pantalla.

---

• float percent_visible

Default	1.0
Setter	set_percent_visible(value)
Getter	get_percent_visible()

Limita la cantidad de caracteres visibles. Si establece percent_visible en 0,5, sólo se mostrará en pantalla hasta la mitad de los caracteres del texto. Es útil para animar el texto en un cuadro de diálogo.

---

• String text

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

El texto a mostrar en la pantalla.

---

• bool uppercase

Default	false
Setter	set_uppercase(value)
Getter	is_uppercase()

Si true, todo el texto se muestra como MAYÚSCULAS.

---

• VAlign valign

Default	0
Setter	set_valign(value)
Getter	get_valign()

Controla la alineación vertical del texto. Soporta la parte superior, el centro, la parte inferior y el relleno. Ponlo en una de las constantes VAlign.

---

• int visible_characters

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

Restringe el número de caracteres a mostrar. Ponlo en -1 para desactivarlo.

Descripciones de Métodos

• int get_line_count ( ) const

Devuelve la cantidad de líneas de texto que tiene la etiqueta.

---

• int get_line_height ( ) const

Devuelve el tamaño de la fuente en píxeles.

---

• int get_total_character_count ( ) const

Devuelve el número total de caracteres imprimibles en el texto (excluyendo espacios y líneas nuevas).

---

• int get_visible_line_count ( ) const

Devuelve el número de líneas mostradas. Es útil si la altura de la Label no puede mostrar actualmente todas las líneas.

Theme Property Descriptions

• Color font_color

Default

Color( 1, 1, 1, 1 )

Color del texto predeterminado de la Label.

---

• Color font_color_shadow

Default

Color( 0, 0, 0, 0 )

Color del efecto de sombra del texto.

---

• Color font_outline_modulate

Default

Color( 1, 1, 1, 1 )

El tinte del contorno de Font. Ver DynamicFont.outline_color.

---

• int line_spacing

Default

3

Espacio vertical entre líneas en multilínea Label.

---

• int shadow_as_outline

Default

0

Valor booleano. Si se ajusta a 1 (true), la sombra se mostrará alrededor de todo el texto como un contorno.

---

• int shadow_offset_x

Default

1

El desplazamiento horizontal de la sombra del texto.

---

• int shadow_offset_y

Default

1

El desplazamiento vertical de la sombra del texto.

---

• Font font

Font que se usa para el texto de las Label.

---

• StyleBox normal

Fondo StyleBox para la Label.