RichTextLabel¶
Inherits: Control < CanvasItem < Node < Object
Etiqueta que muestra el texto enriquecido.
Descripción¶
Rich text can contain custom text, fonts, images and some basic formatting. The label manages these as an internal tag stack. It also adapts itself to given width/heights.
Note: Assignments to bbcode_text clear the tag stack and reconstruct it from the property's contents. Any edits made to bbcode_text will erase previous edits made from other manual sources such as append_bbcode and the push_* / pop methods.
Note: RichTextLabel doesn't support entangled BBCode tags. For example, instead of using [b]bold[i]bold italic[/b]italic[/i], use [b]bold[i]bold italic[/i][/b][i]italic[/i].
Note: push_*/pop functions won't affect BBCode.
Note: Unlike Label, RichTextLabel doesn't have a property to horizontally align text to the center. Instead, enable bbcode_enabled and surround the text in a [center] tag as follows: [center]Example[/center]. There is currently no built-in way to vertically align text either, but this can be emulated by relying on anchors/containers and the fit_content_height property.
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¶
Propiedades¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
rect_clip_content |
|
|
|
||
|
||
|
||
|
||
|
||
|
Métodos¶
void |
|
void |
|
append_bbcode ( String bbcode ) |
|
void |
clear ( ) |
get_content_height ( ) const |
|
get_line_count ( ) const |
|
get_total_character_count ( ) const |
|
get_v_scroll ( ) |
|
get_visible_line_count ( ) const |
|
void |
install_effect ( Variant effect ) |
void |
newline ( ) |
parse_bbcode ( String bbcode ) |
|
parse_expressions_for_values ( PoolStringArray expressions ) |
|
void |
pop ( ) |
void |
push_align ( Align align ) |
void |
push_bold ( ) |
void |
|
void |
push_cell ( ) |
void |
push_color ( Color color ) |
void |
|
void |
push_indent ( int level ) |
void |
push_italics ( ) |
void |
|
void |
|
void |
push_mono ( ) |
void |
push_normal ( ) |
void |
|
void |
push_table ( int columns ) |
void |
push_underline ( ) |
remove_line ( int line ) |
|
void |
scroll_to_line ( int line ) |
void |
set_table_column_expand ( int column, bool expand, int ratio ) |
Propiedades del Theme¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Señales¶
meta_clicked ( Variant meta )
Se activa cuando el usuario hace clic en el contenido entre las meta etiquetas. Si el meta se define en texto, por ejemplo, [url={"data"="hi"}]hi[/url], entonces el parámetro para esta señal será del tipo String. Si se desea un tipo o un objeto determinado, se debe utilizar el método push_meta para insertar manualmente los datos en la pila de etiquetas.
meta_hover_ended ( Variant meta )
Se activa cuando el ratón sale de una meta etiqueta.
meta_hover_started ( Variant meta )
Se activa cuando el ratón sale de una meta etiqueta.
Enumeraciones¶
enum Align:
ALIGN_LEFT = 0 --- Hace que el texto se alinee a la izquierda.
ALIGN_CENTER = 1 --- Hace que el texto se centre.
ALIGN_RIGHT = 2 --- Hace que el texto se alinee a la derecha.
ALIGN_FILL = 3 --- Hace que el texto se expanda para rellenar el ancho.
enum ListType:
LIST_NUMBERS = 0 --- Cada elemento de la lista tiene un marcador numérico.
LIST_LETTERS = 1 --- Cada elemento de la lista tiene un marcador de letras.
LIST_DOTS = 2 --- Cada elemento de la lista tiene un marcador de círculo lleno.
enum ItemType:
ITEM_FRAME = 0
ITEM_TEXT = 1
ITEM_IMAGE = 2
ITEM_NEWLINE = 3
ITEM_FONT = 4
ITEM_COLOR = 5
ITEM_UNDERLINE = 6
ITEM_STRIKETHROUGH = 7
ITEM_ALIGN = 8
ITEM_INDENT = 9
ITEM_LIST = 10
ITEM_TABLE = 11
ITEM_FADE = 12
ITEM_SHAKE = 13
ITEM_WAVE = 14
ITEM_TORNADO = 15
ITEM_RAINBOW = 16
ITEM_CUSTOMFX = 18
ITEM_META = 17
Descripciones de Propiedades¶
bool bbcode_enabled
Default |
|
Setter |
set_use_bbcode(value) |
Getter |
is_using_bbcode() |
If true, the label uses BBCode formatting.
Note: Trying to alter the RichTextLabel's text with add_text will reset this to false. Use instead append_bbcode to preserve BBCode formatting.
String bbcode_text
Default |
|
Setter |
set_bbcode(value) |
Getter |
get_bbcode() |
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: It is unadvised to use the += operator with bbcode_text (e.g. bbcode_text += "some string") as it replaces the whole text and can cause slowdowns. Use append_bbcode for adding text instead, unless you absolutely need to close a tag that was opened in an earlier method call.
Array custom_effects
Default |
|
Setter |
set_effects(value) |
Getter |
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 fit_content_height
Default |
|
Setter |
set_fit_content_height(value) |
Getter |
is_fit_content_height_enabled() |
Si true, la altura de la etiqueta se actualizará automáticamente para que se ajuste a su contenido.
Nota: Esta propiedad se utiliza como solución provisional para solucionar los problemas con RichTextLabel en los Containers, pero no es fiable en algunos casos y se eliminará en futuras versiones.
bool meta_underlined
Default |
|
Setter |
set_meta_underline(value) |
Getter |
is_meta_underlined() |
Si true, la etiqueta subraya las metaetiquetas como [url]{text}[/url].
bool override_selected_font_color
Default |
|
Setter |
set_override_selected_font_color(value) |
Getter |
is_overriding_selected_font_color() |
Si true, la etiqueta utiliza el color de fuente personalizado.
float percent_visible
Default |
|
Setter |
set_percent_visible(value) |
Getter |
get_percent_visible() |
El rango de caracteres a mostrar, como un float entre 0.0 y 1.0. Cuando se le asigna un valor fuera de rango, es lo mismo que asignar 1.0.
Nota: Al establecer esta propiedad se actualiza visible_characters en base al get_total_character_count actual.
bool scroll_active
Default |
|
Setter |
set_scroll_active(value) |
Getter |
is_scroll_active() |
Si true, la barra de desplazamiento es visible. Ponerla en false no bloquea completamente el desplazamiento. Ver scroll_to_line.
bool scroll_following
Default |
|
Setter |
set_scroll_follow(value) |
Getter |
is_scroll_following() |
Si true, la ventana se desplaza hacia abajo para mostrar automáticamente el nuevo contenido.
bool selection_enabled
Default |
|
Setter |
set_selection_enabled(value) |
Getter |
is_selection_enabled() |
Si true, la etiqueta permite la selección de texto.
int tab_size
Default |
|
Setter |
set_tab_size(value) |
Getter |
get_tab_size() |
The number of spaces associated with a single tab length. Does not affect \t in text tags, only indent tags.
String text
Default |
|
Setter |
set_text(value) |
Getter |
get_text() |
El texto en bruto de la etiqueta.
Cuando se establece, borra la pila de etiquetas y añade una etiqueta de texto crudo en la parte superior de la misma. No analiza los BBCodes. No modifica bbcode_text.
int visible_characters
Default |
|
Setter |
set_visible_characters(value) |
Getter |
get_visible_characters() |
The restricted number of characters to display in the label. If -1, all characters will be displayed.
Note: Setting this property updates percent_visible based on current get_total_character_count.
Descripciones de Métodos¶
Adds an image's opening and closing tags to the tag stack, optionally providing a width and height to resize the image.
If width or height is set to 0, the image size will be adjusted in order to keep the original aspect ratio.
void add_text ( String text )
Añade texto crudo no preparado por BBCode a la pila de etiquetas.
Parses bbcode and adds tags to the tag stack as needed. Returns the result of the parsing, @GlobalScope.OK if successful.
Note: Using this method, you can't close a tag that was opened in a previous append_bbcode call. This is done to improve performance, especially when updating large RichTextLabels since rebuilding the whole BBCode every time would be slower. If you absolutely need to close a tag in a future method call, append the bbcode_text instead of using append_bbcode.
void clear ( )
Borra la pila de etiquetas y establece bbcode_text en una string vacía.
int get_content_height ( ) const
Devuelve la altura del contenido.
int get_line_count ( ) const
Devuelve el número total de líneas nuevas en las etiquetas de texto de la pila de etiquetas. Considera el texto envuelto como una línea.
int get_total_character_count ( ) const
Devuelve el número total de caracteres de las etiquetas de texto. No incluye los BBCodes.
VScrollBar get_v_scroll ( )
Returns the vertical scrollbar.
Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their CanvasItem.visible property.
int get_visible_line_count ( ) const
Devuelve el número de líneas visibles.
void install_effect ( Variant effect )
Instala un efecto personalizado. El effect debe ser un RichTextEffect válido.
void newline ( )
Añade una etiqueta de nueva línea a la pila de etiquetas.
La versión de asignación de append_bbcode. Borra la pila de etiquetas e inserta el nuevo contenido. Devuelve @GlobalScope.OK si parsea bbcode con éxito.
Dictionary parse_expressions_for_values ( PoolStringArray expressions )
Analiza el parámetro BBCode expressions en un diccionario.
void pop ( )
Termina la etiqueta actual. Utiliza después de push_* métodos para cerrar manualmente los BBCodes. No necesita seguir los métodos add_*.
void push_align ( Align align )
Añade una etiqueta align basada en el valor align dado. Ver Align para los posibles valores.
void push_bold ( )
Añade una etiqueta [font] con una fuente en negrita a la pila de etiquetas. Esto es lo mismo que añadir una etiqueta b si no está actualmente en una etiqueta i.
void push_bold_italics ( )
Añade una etiqueta font con una fuente en negrita y cursiva a la pila de etiquetas.
void push_cell ( )
Añade una etiqueta de cell a la pila de etiquetas. Debe estar dentro de una etiqueta table. Ver push_table para más detalles.
void push_color ( Color color )
Añade una etiqueta de color a la pila de etiquetas.
void push_font ( Font font )
Añade una etiqueta font a la pila de etiquetas. Anula las fuentes predeterminadas para su duración.
void push_indent ( int level )
Añade una etiqueta de indent a la pila de etiquetas. Multiplica el level por el tab_size actual para determinar la nueva longitud del margen.
void push_italics ( )
Añade una etiqueta font con una fuente en cursiva a la pila de etiquetas. Esto es lo mismo que añadir una etiqueta i si no está actualmente en una etiqueta b.
void push_list ( ListType type )
Añade una etiqueta list a la pila de etiquetas. Similar a los BBCodes ol o ul, pero soporta más tipos de listas. No está totalmente implementado!
void push_meta ( Variant data )
Añade una etiqueta meta a la pila de etiquetas. Similar al BBCode [url=algo]{text}[/url], pero soporta tipos de metadatos que no son String.
void push_mono ( )
Añade una etiqueta font con una fuente monoespacio a la pila de etiquetas.
void push_normal ( )
Añade una etiqueta font con una fuente normal a la pila de etiquetas.
void push_strikethrough ( )
Añade una etiqueta de s a la pila de etiquetas.
void push_table ( int columns )
Añade una etiqueta table=columns a la pila de etiquetas.
void push_underline ( )
Añade una etiqueta u a la pila de etiquetas.
Elimina una línea de contenido de la etiqueta. Devuelve true si la línea existe.
El argumento line es el índice de la línea a eliminar, puede tomar valores en el intervalo [0, get_line_count() - 1].
void scroll_to_line ( int line )
Desplaza la línea superior de la ventana para que coincida con la line.
Edita las opciones de expansión de la columna seleccionada. Si expand es true, la columna se expande en proporción a su ratio de expansión frente a los ratios de las otras columnas.
Por ejemplo, 2 columnas con proporciones de 3 y 4 más 70 píxeles de ancho disponible se expandirían 30 y 40 píxeles, respectivamente.
Si expand es false, la columna no contribuirá a la proporción total.
Theme Property Descriptions¶
Color default_color
Default |
|
El color de texto por defecto.
Color font_color_selected
Default |
|
El color del texto seleccionado, utilizado cuando selection_enabled es true.
Color font_color_shadow
Default |
|
El color de la sombra de la fuente.
Color selection_color
Default |
|
El color de la caja de selección.
int line_separation
Default |
|
El espacio vertical entre las líneas.
int shadow_as_outline
Default |
|
Valor booleano. Si 1 (true), la sombra se mostrará alrededor de todo el texto como un contorno.
int shadow_offset_x
Default |
|
El desplazamiento horizontal de la sombra de la fuente.
int shadow_offset_y
Default |
|
El desplazamiento vertical de la sombra de la fuente.
int table_hseparation
Default |
|
La separación horizontal de elementos en una tabla.
int table_vseparation
Default |
|
La separación vertical de elementos en una tabla.
Font bold_font
La fuente usada para el texto en negrita.
Font bold_italics_font
La fuente usada para el texto en negrita y cursiva.
Font italics_font
La fuente usada para el texto en cursiva.
Font mono_font
La fuente usada para el texto monoespacio.
Font normal_font
La fuente por defecto.
StyleBox focus
El fondo utilizado cuando se enfoca el RichTextLabel.
StyleBox normal
El fondo normal para el RichTextLabel.