RichTextLabel

Hereda: Control < CanvasItem < Node < Object

Un control para mostrar texto que puede contener diferentes estilos de fuente, imágenes y formato básico.

Descripción

Un control para mostrar texto que puede contener fuentes personalizadas, imágenes y formato básico. RichTextLabel gestiona estos como una pila de etiquetas interna. También se adapta a los anchos/altos dados.

Nota: newline(), push_paragraph(), "\n", "\r\n", la etiqueta p y las etiquetas de alineación inician un nuevo párrafo. Cada párrafo se procesa de forma independiente, en su propio contexto BiDi. Si deseas forzar el ajuste de línea dentro del párrafo, se puede usar cualquier otro carácter de salto de línea, por ejemplo, Salto de página (U+000C), Línea siguiente (U+0085), Separador de línea (U+2028).

Nota: Las asignaciones a text borran la pila de etiquetas y la reconstruyen a partir del contenido de la propiedad. Cualquier edición realizada en text borrará las ediciones anteriores realizadas desde otras fuentes manuales como append_text() y los métodos push_* / pop().

Nota: RichTextLabel no admite etiquetas BBCode entrelazadas. Por ejemplo, en lugar de usar [b]bold[i]bold italic[/b]italic[/i], usa [b]bold[i]bold italic[/i][/b][i]italic[/i].

Nota: Las funciones push_*/pop_* no afectarán a BBCode.

Nota: Mientras bbcode_enabled esté habilitado, las etiquetas de alineación como [center] tendrán prioridad sobre la configuración horizontal_alignment que determina la alineación de texto predeterminada.

Tutoriales

Propiedades

AutowrapMode	autowrap_mode	`3`
BitField[LineBreakFlag]	autowrap_trim_flags	`192`
bool	bbcode_enabled	`false`
bool	clip_contents	`true` (overrides Control)
bool	context_menu_enabled	`false`
Array	custom_effects	`[]`
bool	deselect_on_focus_loss_enabled	`true`
bool	drag_and_drop_selection_enabled	`true`
bool	fit_content	`false`
FocusMode	focus_mode	`3` (overrides Control)
bool	hint_underlined	`true`
HorizontalAlignment	horizontal_alignment	`0`
BitField[JustificationFlag]	justification_flags	`163`
String	language	`""`
bool	meta_underlined	`true`
int	progress_bar_delay	`1000`
bool	scroll_active	`true`
bool	scroll_following	`false`
bool	scroll_following_visible_characters	`false`
bool	selection_enabled	`false`
bool	shortcut_keys_enabled	`true`
StructuredTextParser	structured_text_bidi_override	`0`
Array	structured_text_bidi_override_options	`[]`
int	tab_size	`4`
PackedFloat32Array	tab_stops	`PackedFloat32Array()`
String	text	`""`
TextDirection	text_direction	`0`
bool	threaded	`false`
VerticalAlignment	vertical_alignment	`0`
int	visible_characters	`-1`
VisibleCharactersBehavior	visible_characters_behavior	`0`
float	visible_ratio	`1.0`

Métodos

void	add_hr(width: int = 90, height: int = 2, color: Color = Color(1, 1, 1, 1), alignment: HorizontalAlignment = 1, width_in_percent: bool = true, height_in_percent: bool = false)
void	add_image(image: Texture2D, width: int = 0, height: int = 0, color: Color = Color(1, 1, 1, 1), inline_align: InlineAlignment = 5, region: Rect2 = Rect2(0, 0, 0, 0), key: Variant = null, pad: bool = false, tooltip: String = "", width_in_percent: bool = false, height_in_percent: bool = false, alt_text: String = "")
void	add_text(text: String)
void	append_text(bbcode: String)
void	clear()
void	deselect()
int	get_character_line(character: int)
int	get_character_paragraph(character: int)
int	get_content_height() const
int	get_content_width() const
int	get_line_count() const
int	get_line_height(line: int) const
float	get_line_offset(line: int)
Vector2i	get_line_range(line: int)
int	get_line_width(line: int) const
PopupMenu	get_menu() const
int	get_paragraph_count() const
float	get_paragraph_offset(paragraph: int)
String	get_parsed_text() const
String	get_selected_text() const
int	get_selection_from() const
float	get_selection_line_offset() const
int	get_selection_to() const
int	get_total_character_count() const
VScrollBar	get_v_scroll_bar()
Rect2i	get_visible_content_rect() const
int	get_visible_line_count() const
int	get_visible_paragraph_count() const
void	install_effect(effect: Variant)
bool	invalidate_paragraph(paragraph: int)
bool	is_finished() const
bool	is_menu_visible() const
bool	is_ready() const
void	menu_option(option: int)
void	newline()
void	parse_bbcode(bbcode: String)
Dictionary	parse_expressions_for_values(expressions: PackedStringArray)
void	pop()
void	pop_all()
void	pop_context()
void	push_bgcolor(bgcolor: Color)
void	push_bold()
void	push_bold_italics()
void	push_cell()
void	push_color(color: Color)
void	push_context()
void	push_customfx(effect: RichTextEffect, env: Dictionary)
void	push_dropcap(string: String, font: Font, size: int, dropcap_margins: Rect2 = Rect2(0, 0, 0, 0), color: Color = Color(1, 1, 1, 1), outline_size: int = 0, outline_color: Color = Color(0, 0, 0, 0))
void	push_fgcolor(fgcolor: Color)
void	push_font(font: Font, font_size: int = 0)
void	push_font_size(font_size: int)
void	push_hint(description: String)
void	push_indent(level: int)
void	push_italics()
void	push_language(language: String)
void	push_list(level: int, type: ListType, capitalize: bool, bullet: String = "•")
void	push_meta(data: Variant, underline_mode: MetaUnderline = 1, tooltip: String = "")
void	push_mono()
void	push_normal()
void	push_outline_color(color: Color)
void	push_outline_size(outline_size: int)
void	push_paragraph(alignment: HorizontalAlignment, base_direction: TextDirection = 0, language: String = "", st_parser: StructuredTextParser = 0, justification_flags: BitField[JustificationFlag] = 163, tab_stops: PackedFloat32Array = PackedFloat32Array())
void	push_strikethrough(color: Color = Color(0, 0, 0, 0))
void	push_table(columns: int, inline_align: InlineAlignment = 0, align_to_row: int = -1, name: String = "")
void	push_underline(color: Color = Color(0, 0, 0, 0))
void	reload_effects()
bool	remove_paragraph(paragraph: int, no_invalidate: bool = false)
void	scroll_to_line(line: int)
void	scroll_to_paragraph(paragraph: int)
void	scroll_to_selection()
void	select_all()
void	set_cell_border_color(color: Color)
void	set_cell_padding(padding: Rect2)
void	set_cell_row_background_color(odd_row_bg: Color, even_row_bg: Color)
void	set_cell_size_override(min_size: Vector2, max_size: Vector2)
void	set_table_column_expand(column: int, expand: bool, ratio: int = 1, shrink: bool = true)
void	set_table_column_name(column: int, name: String)
void	update_image(key: Variant, mask: BitField[ImageUpdateMask], image: Texture2D, width: int = 0, height: int = 0, color: Color = Color(1, 1, 1, 1), inline_align: InlineAlignment = 5, region: Rect2 = Rect2(0, 0, 0, 0), pad: bool = false, tooltip: String = "", width_in_percent: bool = false, height_in_percent: bool = false)

Propiedades del Tema

Color	default_color	`Color(1, 1, 1, 1)`
Color	font_outline_color	`Color(0, 0, 0, 1)`
Color	font_selected_color	`Color(0, 0, 0, 0)`
Color	font_shadow_color	`Color(0, 0, 0, 0)`
Color	selection_color	`Color(0.1, 0.1, 1, 0.8)`
Color	table_border	`Color(0, 0, 0, 0)`
Color	table_even_row_bg	`Color(0, 0, 0, 0)`
Color	table_odd_row_bg	`Color(0, 0, 0, 0)`
int	line_separation	`0`
int	outline_size	`0`
int	paragraph_separation	`0`
int	shadow_offset_x	`1`
int	shadow_offset_y	`1`
int	shadow_outline_size	`1`
int	strikethrough_alpha	`50`
int	table_h_separation	`3`
int	table_v_separation	`3`
int	text_highlight_h_padding	`3`
int	text_highlight_v_padding	`3`
int	underline_alpha	`50`
Font	bold_font
Font	bold_italics_font
Font	italics_font
Font	mono_font
Font	normal_font
int	bold_font_size
int	bold_italics_font_size
int	italics_font_size
int	mono_font_size
int	normal_font_size
Texture2D	horizontal_rule
StyleBox	focus
StyleBox	normal

Señales

finished() 🔗

Se activa cuando el documento se ha cargado por completo.

Nota: Esto puede ocurrir antes de que el texto se procese para su dibujo. Los valores de desplazamiento pueden no ser válidos hasta que el documento se dibuje por primera vez después de esta señal.

meta_clicked(meta: Variant) 🔗

Triggered when the user clicks on content between meta (URL) tags. If the meta is defined in BBCode, e.g. [url={"key": "value"}]Text[/url], then the parameter for this signal will always be a String type. If a particular type or an object is desired, the push_meta() method must be used to manually insert the data into the tag stack. Alternatively, you can convert the String input to the desired type based on its contents (such as calling JSON.parse() on it).

For example, the following method can be connected to meta_clicked to open clicked URLs using the user's default web browser:

# This assumes RichTextLabel's `meta_clicked` signal was connected to
# the function below using the signal connection dialog.
func _richtextlabel_on_meta_clicked(meta):
    # `meta` is of Variant type, so convert it to a String to avoid script errors at run-time.
    OS.shell_open(str(meta))

meta_hover_ended(meta: Variant) 🔗

Se activa cuando el ratón sale de una meta etiqueta.

meta_hover_started(meta: Variant) 🔗

Se activa cuando el ratón sale de una meta etiqueta.

Enumeraciones

enum ListType: 🔗

ListType LIST_NUMBERS = 0

Cada elemento de la lista tiene un marcador numérico.

ListType LIST_LETTERS = 1

Cada elemento de la lista tiene un marcador de letras.

ListType LIST_ROMAN = 2

Cada elemento de la lista tiene un marcador numérico romano.

ListType LIST_DOTS = 3

Cada elemento de la lista tiene un marcador de círculo lleno.

enum MenuItems: 🔗

MenuItems MENU_COPY = 0

Copia el texto seleccionado.

MenuItems MENU_SELECT_ALL = 1

Selecciona todo el texto del RichTextLabel.

MenuItems MENU_MAX = 2

Representa el tamaño del enum MenuItems.

enum MetaUnderline: 🔗

MetaUnderline META_UNDERLINE_NEVER = 0

La metaetiqueta no muestra un subrayado, incluso si meta_underlined es true.

MetaUnderline META_UNDERLINE_ALWAYS = 1

Si meta_underlined es true, la metaetiqueta siempre muestra un subrayado.

MetaUnderline META_UNDERLINE_ON_HOVER = 2

Si meta_underlined es true, la metaetiqueta muestra un subrayado cuando el cursor del ratón está sobre ella.

flags ImageUpdateMask: 🔗

ImageUpdateMask UPDATE_TEXTURE = 1

Si este bit está activado, update_image() cambia la textura de la imagen.

ImageUpdateMask UPDATE_SIZE = 2

Si este bit está activado, update_image() cambia el tamaño de la imagen.

ImageUpdateMask UPDATE_COLOR = 4

Si este bit está activado, update_image() cambia el color de la imagen.

ImageUpdateMask UPDATE_ALIGNMENT = 8

Si este bit está activado, update_image() cambia la alineación en línea de la imagen.

ImageUpdateMask UPDATE_REGION = 16

Si este bit está activado, update_image() cambia la región de la textura de la imagen.

ImageUpdateMask UPDATE_PAD = 32

Si este bit está activado, update_image() cambia el relleno de la imagen.

ImageUpdateMask UPDATE_TOOLTIP = 64

Si este bit está activado, update_image() cambia la información sobre herramientas de la imagen.

ImageUpdateMask UPDATE_WIDTH_IN_PERCENT = 128

Si este bit está activado, update_image() cambia el ancho de la imagen de/a porcentajes.

Descripciones de Propiedades

AutowrapMode autowrap_mode = 3 🔗

void set_autowrap_mode(value: AutowrapMode)
AutowrapMode get_autowrap_mode()

Si se establece en un valor distinto de TextServer.AUTOWRAP_OFF, el texto se ajusta dentro del rectángulo delimitador del nodo.

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

void set_use_bbcode(value: bool)
bool is_using_bbcode()

Si es true, la etiqueta utiliza formato BBCode.

Nota: Esto solo afecta al contenido de text, no a la pila de etiquetas.

bool context_menu_enabled = false 🔗

void set_context_menu_enabled(value: bool)
bool is_context_menu_enabled()

Si es true, un clic con el botón derecho del ratón muestra el menú contextual.

Array custom_effects = [] 🔗

void set_effects(value: Array)
Array get_effects()

Los efectos personalizados actualmente instalados. Este es un conjunto de RichTextEffect.

Para añadir un efecto personalizado, es más conveniente usar install_effect().

bool deselect_on_focus_loss_enabled = true 🔗

void set_deselect_on_focus_loss_enabled(value: bool)
bool is_deselect_on_focus_loss_enabled()

Si es true, el texto seleccionado se deseleccionará cuando se pierda el foco.

bool drag_and_drop_selection_enabled = true 🔗

void set_drag_and_drop_selection_enabled(value: bool)
bool is_drag_and_drop_selection_enabled()

Si es true, permite arrastrar y soltar el texto seleccionado.

bool fit_content = false 🔗

void set_fit_content(value: bool)
bool is_fit_content_enabled()

Si es true, el tamaño mínimo de la etiqueta se actualizará automáticamente para ajustarse a su contenido, coincidiendo con el comportamiento de Label.

bool hint_underlined = true 🔗

void set_hint_underline(value: bool)
bool is_hint_underlined()

Si es true, la etiqueta subraya las etiquetas de sugerencia como [hint=description]{text}[/hint].

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, o 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.

String language = "" 🔗

void set_language(value: String)
String get_language()

Código de idioma utilizado para los algoritmos de salto de línea y forma del texto, si se deja vacío se utiliza la configuración regional actual.

bool meta_underlined = true 🔗

void set_meta_underline(value: bool)
bool is_meta_underlined()

Si es true, la etiqueta subraya las metaetiquetas como [url]{text}[/url]. Estas etiquetas pueden llamar a una función cuando se hace clic si meta_clicked está conectado a una función.

int progress_bar_delay = 1000 🔗

void set_progress_bar_delay(value: int)
int get_progress_bar_delay()

El retardo después del cual se muestra la barra de progreso de carga, en milisegundos. Establecer en -1 para desactivar la barra de progreso por completo.

Nota: La barra de progreso se muestra solo si threaded está habilitado.

bool scroll_active = true 🔗

void set_scroll_active(value: bool)
bool is_scroll_active()

Si es true, la barra de desplazamiento es visible. Ponerla en false no bloquea completamente el desplazamiento. Véase scroll_to_line().

bool scroll_following = false 🔗

void set_scroll_follow(value: bool)
bool is_scroll_following()

Si es true, la ventana se desplaza hacia abajo para mostrar automáticamente el nuevo contenido.

bool scroll_following_visible_characters = false 🔗

void set_scroll_follow_visible_characters(value: bool)
bool is_scroll_following_visible_characters()

Si es true, la ventana se desplaza para mostrar la última línea visible cuando se cambia visible_characters o visible_ratio.

bool selection_enabled = false 🔗

void set_selection_enabled(value: bool)
bool is_selection_enabled()

Si es true, la etiqueta permite la selección de texto.

bool shortcut_keys_enabled = true 🔗

void set_shortcut_keys_enabled(value: bool)
bool is_shortcut_keys_enabled()

Si es true, las teclas de atajo para los elementos del menú contextual están habilitadas, incluso si el menú contextual está desactivado.

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.

int tab_size = 4 🔗

void set_tab_size(value: int)
int get_tab_size()

El número de espacios asociados a una sola pestaña de longitud. No afecta al \t en las etiquetas de texto, sólo a las etiquetas con indentado.

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()

The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited.

Note: If bbcode_enabled is true, it is unadvised to use the += operator with text (e.g. text += "some string") as it replaces the whole text and can cause slowdowns. It will also erase all BBCode that was added to stack using push_* methods. Use append_text() for adding text instead, unless you absolutely need to close a tag that was opened in an earlier method call.

TextDirection text_direction = 0 🔗

void set_text_direction(value: TextDirection)
TextDirection get_text_direction()

Dirección base de escritura del texto.

bool threaded = false 🔗

void set_threaded(value: bool)
bool is_threaded()

Si es true, el procesamiento del texto se realiza en un hilo secundario.

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()

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.

Note: Characters are counted as Unicode codepoints. A single visible grapheme may contain multiple codepoints (e.g. certain emoji use three codepoints). A single codepoint may contain two UTF-16 characters, which are used in C# strings.

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

void add_hr(width: int = 90, height: int = 2, color: Color = Color(1, 1, 1, 1), alignment: HorizontalAlignment = 1, width_in_percent: bool = true, height_in_percent: bool = false) 🔗

Agrega una regla horizontal que se puede usar para separar el contenido.

Si width_in_percent está establecido, los valores de width son porcentajes del ancho del control en lugar de píxeles.

Si height_in_percent está establecido, los valores de height son porcentajes del ancho del control en lugar de píxeles.

void add_image(image: Texture2D, width: int = 0, height: int = 0, color: Color = Color(1, 1, 1, 1), inline_align: InlineAlignment = 5, region: Rect2 = Rect2(0, 0, 0, 0), key: Variant = null, pad: bool = false, tooltip: String = "", width_in_percent: bool = false, height_in_percent: bool = false, alt_text: String = "") 🔗

Añade las etiquetas de apertura y cierre de una imagen a la pila de etiquetas, opcionalmente proporcionando un width y un height para redimensionar la imagen, un color para teñir la imagen y una region para usar solo partes de la imagen.

Si width o height se establece en 0, el tamaño de la imagen se ajustará para mantener la relación de aspecto original.

Si width y height no están establecidos, pero region sí lo está, se usará el rectángulo de la región.

key es un identificador opcional, que se puede usar para modificar la imagen a través de update_image().

Si pad está establecido, y la imagen es más pequeña que el tamaño especificado por width y height, el relleno de la imagen se agrega para que coincida con el tamaño en lugar de aumentar la escala.

Si width_in_percent está establecido, los valores de width son porcentajes del ancho del control en lugar de píxeles.

Si height_in_percent está establecido, los valores de height son porcentajes del ancho del control en lugar de píxeles.

alt_text se usa como la descripción de la imagen para las aplicaciones de asistencia.

void add_text(text: String) 🔗

Añade texto crudo no preparado por BBCode a la pila de etiquetas.

void append_text(bbcode: String) 🔗

Analiza bbcode y agrega etiquetas a la pila de etiquetas según sea necesario.

Nota: Usando este método, no puedes cerrar una etiqueta que se abrió en una llamada anterior a append_text(). Esto se hace para mejorar el rendimiento, especialmente al actualizar RichTextLabels grandes, ya que reconstruir todo el BBCode cada vez sería más lento. Si absolutamente necesitas cerrar una etiqueta en una llamada de método futura, agrega text en lugar de usar append_text().

void clear() 🔗

Borra la pila de etiquetas, haciendo que la etiqueta no muestre nada.

Nota: Este método no afecta a text, y su contenido se mostrará de nuevo si la etiqueta se vuelve a dibujar. Sin embargo, establecer text en una String vacía también borra la pila.

void deselect() 🔗

Borra la selección actual.

int get_character_line(character: int) 🔗

Devuelve el número de línea de la posición del carácter proporcionada. Los números de línea y de carácter están indexados en cero.