Up to date

This page is up to date for Godot 4.0. If you still find outdated information, please open an issue.

RichTextLabel¶

Inherits: Control < CanvasItem < Node < Object

A control for displaying text that can contain different font styles, images, and basic formatting.

Description¶

A control for displaying text that can contain custom fonts, images, and basic formatting. RichTextLabel manages these as an internal tag stack. It also adapts itself to given width/heights.

Note: Assignments to text clear the tag stack and reconstruct it from the property's contents. Any edits made to text will erase previous edits made from other manual sources such as append_text 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 property.

Tutorials¶

Properties¶

AutowrapMode	autowrap_mode	`3`
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	fit_content	`false`
bool	hint_underlined	`true`
String	language	`""`
bool	meta_underlined	`true`
int	progress_bar_delay	`1000`
bool	scroll_active	`true`
bool	scroll_following	`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`
String	text	`""`
TextDirection	text_direction	`0`
bool	threaded	`false`
int	visible_characters	`-1`
VisibleCharactersBehavior	visible_characters_behavior	`0`
float	visible_ratio	`1.0`

Methods¶

void	add_image ( Texture2D image, int width=0, int height=0, Color color=Color(1, 1, 1, 1), InlineAlignment inline_align=5, Rect2 region=Rect2(0, 0, 0, 0) )
void	add_text ( String text )
void	append_text ( String bbcode )
void	clear ( )
void	deselect ( )
int	get_character_line ( int character )
int	get_character_paragraph ( int character )
int	get_content_height ( ) const
int	get_content_width ( ) const
int	get_line_count ( ) const
float	get_line_offset ( int line )
PopupMenu	get_menu ( ) const
int	get_paragraph_count ( ) const
float	get_paragraph_offset ( int paragraph )
String	get_parsed_text ( ) const
String	get_selected_text ( ) const
int	get_selection_from ( ) const
int	get_selection_to ( ) const
int	get_total_character_count ( ) const
VScrollBar	get_v_scroll_bar ( )
int	get_visible_line_count ( ) const
int	get_visible_paragraph_count ( ) const
void	install_effect ( Variant effect )
bool	is_menu_visible ( ) const
bool	is_ready ( ) const
void	menu_option ( int option )
void	newline ( )
void	parse_bbcode ( String bbcode )
Dictionary	parse_expressions_for_values ( PackedStringArray expressions )
void	pop ( )
void	push_bgcolor ( Color bgcolor )
void	push_bold ( )
void	push_bold_italics ( )
void	push_cell ( )
void	push_color ( Color color )
void	push_customfx ( RichTextEffect effect, Dictionary env )
void	push_dropcap ( String string, Font font, int size, Rect2 dropcap_margins=Rect2(0, 0, 0, 0), Color color=Color(1, 1, 1, 1), int outline_size=0, Color outline_color=Color(0, 0, 0, 0) )
void	push_fgcolor ( Color fgcolor )
void	push_font ( Font font, int font_size )
void	push_font_size ( int font_size )
void	push_hint ( String description )
void	push_indent ( int level )
void	push_italics ( )
void	push_list ( int level, ListType type, bool capitalize )
void	push_meta ( Variant data )
void	push_mono ( )
void	push_normal ( )
void	push_outline_color ( Color color )
void	push_outline_size ( int outline_size )
void	push_paragraph ( HorizontalAlignment alignment, TextDirection base_direction=0, String language="", StructuredTextParser st_parser=0 )
void	push_strikethrough ( )
void	push_table ( int columns, InlineAlignment inline_align=0, int align_to_row=-1 )
void	push_underline ( )
bool	remove_paragraph ( int paragraph )
void	scroll_to_line ( int line )
void	scroll_to_paragraph ( int paragraph )
void	scroll_to_selection ( )
void	select_all ( )
void	set_cell_border_color ( Color color )
void	set_cell_padding ( Rect2 padding )
void	set_cell_row_background_color ( Color odd_row_bg, Color even_row_bg )
void	set_cell_size_override ( Vector2 min_size, Vector2 max_size )
void	set_table_column_expand ( int column, bool expand, int ratio )

Theme Properties¶

Color	default_color	`Color(1, 1, 1, 1)`
Color	font_outline_color	`Color(1, 1, 1, 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	shadow_offset_x	`1`
int	shadow_offset_y	`1`
int	shadow_outline_size	`1`
int	table_h_separation	`3`
int	table_v_separation	`3`
int	text_highlight_h_padding	`3`
int	text_highlight_v_padding	`3`
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
StyleBox	focus
StyleBox	normal

Signals¶

finished ( )

Triggered when the document is fully loaded.

meta_clicked ( Variant meta )

Triggered when the user clicks on content between meta tags. If the meta is defined in text, e.g. [url={"data"="hi"}]hi[/url], then the parameter for this signal will 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.

meta_hover_ended ( Variant meta )

Triggers when the mouse exits a meta tag.

meta_hover_started ( Variant meta )

Triggers when the mouse enters a meta tag.

Enumerations¶

enum ListType:

ListType LIST_NUMBERS = 0

Each list item has a number marker.

ListType LIST_LETTERS = 1

Each list item has a letter marker.

ListType LIST_ROMAN = 2

Each list item has a roman number marker.

ListType LIST_DOTS = 3

Each list item has a filled circle marker.

enum MenuItems:

MenuItems MENU_COPY = 0

Copies the selected text.

MenuItems MENU_SELECT_ALL = 1

Selects the whole RichTextLabel text.

MenuItems MENU_MAX = 2

Represents the size of the MenuItems enum.

Property Descriptions¶

AutowrapMode autowrap_mode = 3

void set_autowrap_mode ( AutowrapMode value )
AutowrapMode get_autowrap_mode ( )

If set to something other than TextServer.AUTOWRAP_OFF, the text gets wrapped inside the node's bounding rectangle. To see how each mode behaves, see AutowrapMode.

bool bbcode_enabled = false

void set_use_bbcode ( bool value )
bool is_using_bbcode ( )

If true, the label uses BBCode formatting.

bool context_menu_enabled = false

void set_context_menu_enabled ( bool value )