Label

Hereda: Control < CanvasItem < Node < Object

Un control para mostrar texto sin formato.

Descripción

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.

Note: A single Label node is not designed to display huge amounts of text. To display large amounts of text in a single node, consider using RichTextLabel instead as it supports features like an integrated scroll bar and threading. RichTextLabel generally performs better when displaying large amounts of text (several pages or more).

Tutoriales

Demo de Dodge The Creeps en 2D

Propiedades

AutowrapMode	autowrap_mode	`0`
BitField[LineBreakFlag]	autowrap_trim_flags	`192`
bool	clip_text	`false`
String	ellipsis_char	`"…"`
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)
String	paragraph_separator	`"\\n"`
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`

Métodos

Rect2	get_character_bounds(pos: int) const
int	get_line_count() const
int	get_line_height(line: int = -1) const
int	get_total_character_count() const
int	get_visible_line_count() const

Propiedades del Tema

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

Descripciones de Propiedades

AutowrapMode autowrap_mode = 0 🔗

void set_autowrap_mode(value: AutowrapMode)
AutowrapMode get_autowrap_mode()

Si se establece en algo que no sea TextServer.AUTOWRAP_OFF, el texto se ajusta dentro del rectángulo delimitador del nodo. Si cambias el tamaño del nodo, cambiará su altura automáticamente para mostrar todo el texto.

BitField[LineBreakFlag] autowrap_trim_flags = 192 🔗

void set_autowrap_trim_flags(value: BitField[LineBreakFlag])
BitField[LineBreakFlag] get_autowrap_trim_flags()

Flags de recorte de espacio de ajuste automático. Véase TextServer.BREAK_TRIM_START_EDGE_SPACES y TextServer.BREAK_TRIM_END_EDGE_SPACES para más información.

bool clip_text = false 🔗

void set_clip_text(value: bool)
bool is_clipping_text()

Si es true, la etiqueta solo muestra el texto que cabe dentro de su rectángulo delimitador y recortará el texto horizontalmente.

String ellipsis_char = "…" 🔗

void set_ellipsis_char(value: String)
String get_ellipsis_char()

Carácter de elipsis utilizado para el recorte de texto.

HorizontalAlignment horizontal_alignment = 0 🔗

void set_horizontal_alignment(value: HorizontalAlignment)
HorizontalAlignment get_horizontal_alignment()

Controla la alineación horizontal del texto. Admite izquierda, centro, derecha y relleno (también conocido como justificar).

BitField[JustificationFlag] justification_flags = 163 🔗

void set_justification_flags(value: BitField[JustificationFlag])
BitField[JustificationFlag] get_justification_flags()

Reglas de alineación de relleno de línea.

LabelSettings label_settings 🔗

void set_label_settings(value: LabelSettings)
LabelSettings get_label_settings()

Un recurso LabelSettings que puede ser compartido entre múltiples nodos Label. Tiene prioridad sobre las propiedades del tema.

String language = "" 🔗

void set_language(value: String)
String get_language()

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

int lines_skipped = 0 🔗

void set_lines_skipped(value: int)
int get_lines_skipped()

El número de líneas ignoradas y no mostradas desde el principio del valor de text.

int max_lines_visible = -1 🔗

void set_max_lines_visible(value: int)
int get_max_lines_visible()

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

String paragraph_separator = "\\n" 🔗

void set_paragraph_separator(value: String)
String get_paragraph_separator()

Cadena utilizada como separador de párrafos. Cada párrafo se procesa de forma independiente, en su propio contexto BiDi.

StructuredTextParser structured_text_bidi_override = 0 🔗

void set_structured_text_bidi_override(value: StructuredTextParser)
StructuredTextParser get_structured_text_bidi_override()

Establece la sobrescritura del algoritmo BiDi para el texto estructurado.

Array structured_text_bidi_override_options = [] 🔗

void set_structured_text_bidi_override_options(value: Array)
Array get_structured_text_bidi_override_options()

Establece opciones adicionales para la sobrescritura BiDi.

PackedFloat32Array tab_stops = PackedFloat32Array() 🔗

void set_tab_stops(value: PackedFloat32Array)
PackedFloat32Array get_tab_stops()

Alinea el texto con las tabulaciones indicadas.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedFloat32Array for more details.

String text = "" 🔗

void set_text(value: String)
String get_text()

El texto a mostrar en la pantalla.

TextDirection text_direction = 0 🔗

void set_text_direction(value: TextDirection)
TextDirection get_text_direction()

Dirección base de escritura del texto.

OverrunBehavior text_overrun_behavior = 0 🔗

void set_text_overrun_behavior(value: OverrunBehavior)
OverrunBehavior get_text_overrun_behavior()

El comportamiento de recorte cuando el texto excede el rectángulo delimitador del nodo.

bool uppercase = false 🔗

void set_uppercase(value: bool)
bool is_uppercase()

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

VerticalAlignment vertical_alignment = 0 🔗

void set_vertical_alignment(value: VerticalAlignment)
VerticalAlignment get_vertical_alignment()

Controla la alineación vertical del texto. Admite superior, centro, inferior y relleno.

int visible_characters = -1 🔗

void set_visible_characters(value: int)
int get_visible_characters()

El número de caracteres a mostrar. Si se establece en -1, se muestran todos los caracteres. Esto puede ser útil al animar el texto que aparece en un cuadro de diálogo.

Nota: Establecer esta propiedad actualiza visible_ratio en consecuencia.

Nota: Los caracteres se cuentan como puntos de código Unicode. Un solo grafema visible puede contener múltiples puntos de código (por ejemplo, algunos emojis usan tres puntos de código). Un solo punto de código puede contener dos caracteres UTF-16, que se usan en las cadenas de C#.

VisibleCharactersBehavior visible_characters_behavior = 0 🔗

void set_visible_characters_behavior(value: VisibleCharactersBehavior)
VisibleCharactersBehavior get_visible_characters_behavior()

El comportamiento de recorte cuando se establece visible_characters o visible_ratio.

float visible_ratio = 1.0 🔗

void set_visible_ratio(value: float)
float get_visible_ratio()

La fracción de caracteres que se mostrarán, en relación con el número total de caracteres (véase get_total_character_count()). Si se establece en 1.0, se mostrarán todos los caracteres. Si se establece en 0.5, solo se mostrará la mitad de los caracteres. Esto puede ser útil al animar el texto que aparece en un cuadro de diálogo.

Nota: Establecer esta propiedad actualiza visible_characters en consecuencia.

Descripciones de Métodos

Rect2 get_character_bounds(pos: int) const 🔗

Devuelve el rectángulo delimitador del carácter en la posición pos en el sistema de coordenadas local de la etiqueta. Si el carácter es un carácter no visual o pos está fuera del rango válido, se devuelve un Rect2 vacío. Si el carácter es parte de un grafema compuesto, se devuelve el rectángulo delimitador de todo el grafema.

int get_line_count() const 🔗

Devuelve el número de líneas de texto que tiene la etiqueta.

int get_line_height(line: int = -1) const 🔗

Devuelve la altura de la línea line.

Si line se establece en -1, devuelve la altura de línea más grande.

Si no hay líneas, devuelve el tamaño de 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.

Descripciones de las propiedades del tema

Color font_color = Color(1, 1, 1, 1) 🔗

Texto predeterminado Color de la Label.

Color font_outline_color = Color(0, 0, 0, 1) 🔗

El color del contorno del texto.

Color font_shadow_color = Color(0, 0, 0, 0) 🔗

Color del efecto de sombra del texto.

int line_spacing = 3 🔗

Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative.

int outline_size = 0 🔗

Tamaño del contorno del texto.

Nota: Si se utiliza una fuente con FontFile.multichannel_signed_distance_field habilitado, su FontFile.msdf_pixel_range debe establecerse en al menos dos veces el valor de outline_size para que el renderizado del contorno se vea correcto. De lo contrario, el contorno puede parecer que se corta antes de lo previsto.

Nota: No se recomienda utilizar un valor mayor que la mitad del tamaño de la fuente, ya que el contorno de la fuente puede no cerrarse por completo en este caso.

int paragraph_spacing = 0 🔗

Espacio vertical entre párrafos. Se añade sobre line_spacing.

int shadow_offset_x = 1 🔗

El desplazamiento horizontal de la sombra del texto.

int shadow_offset_y = 1 🔗

El desplazamiento vertical de la sombra del texto.

int shadow_outline_size = 1 🔗

El tamaño del contorno de la sombra.

Font font 🔗

Font que se usa para el texto de las Label.

int font_size 🔗

Tamaño de fuente del texto de Label.

StyleBox focus 🔗

StyleBox usado cuando la Label está enfocada (cuando se usa con aplicaciones de asistencia).

StyleBox normal 🔗

Fondo StyleBox para la Label.