Class reference

RichTextLabel

Inherits Control

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: newline(), push_paragraph(), "\n", "\r\n", p tag, and alignment tags start a new paragraph. Each paragraph is processed independently, in its own BiDi context. If you want to force line wrapping within paragraph, any other line breaking character can be used, for example, Form Feed (U+000C), Next Line (U+0085), Line Separator (U+2028). 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 [code skip-lint]boldbold italicitalic[/code], use [code skip-lint]boldbold italicitalic[/code]. Note: push_*/pop_* functions won't affect BBCode. Note: While bbcode_enabled is enabled, alignment tags such as [code skip-lint][/code] will take priority over the horizontal_alignment setting which determines the default text alignment.

Properties

int autowrap_mode = 3

If set to something other than TextServer.AUTOWRAP_OFF, the text gets wrapped inside the node's bounding rectangle.

bool bbcode_enabled = false

If true, the label uses BBCode formatting. Note: This only affects the contents of text, not the tag stack.

bool clip_contents = true

bool context_menu_enabled = false

If true, a right-click displays the context menu.

bool deselect_on_focus_loss_enabled = true

If true, the selected text will be deselected when focus is lost.

bool drag_and_drop_selection_enabled = true

If true, allow drag and drop of selected text.

bool fit_content = false

If true, the label's minimum size will be automatically updated to fit its content, matching the behavior of Label.

int focus_mode = 3

bool hint_underlined = true

If true, the label underlines hint tags such as [code skip-lint][hint=description]{text}[/hint][/code].

int horizontal_alignment = 0

Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify.

int justification_flags = 163

Line fill alignment rules.

String language = ""

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

bool meta_underlined = true

If true, the label underlines meta tags such as [code skip-lint]{text}[/code]. These tags can call a function when clicked if meta_clicked is connected to a function.

int progress_bar_delay = 1000

The delay after which the loading progress bar is displayed, in milliseconds. Set to -1 to disable progress bar entirely. Note: Progress bar is displayed only if threaded is enabled.

bool scroll_active = true

If true, the scrollbar is visible. Setting this to false does not block scrolling completely. See scroll_to_line().

bool scroll_following = false

If true, the window scrolls down to display new content automatically.

bool selection_enabled = false

If true, the label allows text selection.

bool shortcut_keys_enabled = true

If true, shortcut keys for context menu items are enabled, even if the context menu is disabled.

int structured_text_bidi_override = 0

Set BiDi algorithm override for the structured text.

Array structured_text_bidi_override_options = []

Set additional options for BiDi override.

int tab_size = 4

The number of spaces associated with a single tab length. Does not affect \t in text tags, only indent tags.

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

int text_direction = 0

Base text writing direction.

bool threaded = false

If true, text processing is done in a background thread.

int vertical_alignment = 0

Controls the text's vertical alignment. Supports top, center, bottom, and fill.

int visible_characters = -1

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.

float visible_ratio = 1.0

The fraction of characters to display, relative to the total number of characters (see get_total_character_count()). If set to 1.0, all characters are displayed. If set to 0.5, only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box. Note: Setting this property updates visible_characters accordingly.

Methods

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

Adds a horizontal rule that can be used to separate content. If width_in_percent is set, width values are percentages of the control width instead of pixels. If height_in_percent is set, height values are percentages of the control width instead of pixels.

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

Adds an image's opening and closing tags to the tag stack, optionally providing a width and height to resize the image, a color to tint the image and a region to only use parts of the image. If width or height is set to 0, the image size will be adjusted in order to keep the original aspect ratio. If width and height are not set, but region is, the region's rect will be used. key is an optional identifier, that can be used to modify the image via update_image(). If pad is set, and the image is smaller than the size specified by width and height, the image padding is added to match the size instead of upscaling. If width_in_percent is set, width values are percentages of the control width instead of pixels. If height_in_percent is set, height values are percentages of the control width instead of pixels. alt_text is used as the image description for assistive apps.

void add_text(String text)

Adds raw non-BBCode-parsed text to the tag stack.

void append_text(String bbcode)

Parses bbcode and adds tags to the tag stack as needed. Note: Using this method, you can't close a tag that was opened in a previous append_text() 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 text instead of using append_text().

void clear()

Clears the tag stack, causing the label to display nothing. Note: This method does not affect text, and its contents will show again if the label is redrawn. However, setting text to an empty String also clears the stack.

void deselect()

Clears the current selection.

int get_character_line(int character)

Returns the line number of the character position provided. Line and character numbers are both zero-indexed. Note: If threaded is enabled, this method returns a value for the loaded part of the document. Use is_finished() or finished to determine whether document is fully loaded.

int get_character_paragraph(int character)

Returns the paragraph number of the character position provided. Paragraph and character numbers are both zero-indexed. Note: If threaded is enabled, this method returns a value for the loaded part of the document. Use is_finished() or finished to determine whether document is fully loaded.

int get_line_count() const

Returns the total number of lines in the text. Wrapped text is counted as multiple lines. Note: If threaded is enabled, this method returns a value for the loaded part of the document. Use is_finished() or finished to determine whether document is fully loaded.

int get_line_height(int line) const

Returns the height of the line found at the provided index. Note: If threaded is enabled, this method returns a value for the loaded part of the document. Use is_finished() or finished to determine whether the document is fully loaded.

float get_line_offset(int line)

Returns the vertical offset of the line found at the provided index. Note: If threaded is enabled, this method returns a value for the loaded part of the document. Use is_finished() or finished to determine whether document is fully loaded.

int get_line_width(int line) const

Returns the width of the line found at the provided index. Note: If threaded is enabled, this method returns a value for the loaded part of the document. Use is_finished() or finished to determine whether the document is fully loaded.

PopupMenu get_menu() const

Returns the PopupMenu of this RichTextLabel. By default, this menu is displayed when right-clicking on the RichTextLabel. You can add custom menu items or remove standard ones. Make sure your IDs don't conflict with the standard ones (see MenuItems). For example:

				func _ready():
					var menu = get_menu()
					# Remove "Select All" item.
					menu.remove_item(MENU_SELECT_ALL)
					# Add custom items.
					menu.add_separator()
					menu.add_item("Duplicate Text", MENU_MAX + 1)
					# Connect callback.
					menu.id_pressed.connect(_on_item_pressed)

				func _on_item_pressed(id):
					if id == MENU_MAX + 1:
						add_text("\n" + get_parsed_text())
				
				public override void _Ready()
				{
					var menu = GetMenu();
					// Remove "Select All" item.
					menu.RemoveItem(RichTextLabel.MenuItems.SelectAll);
					// Add custom items.
					menu.AddSeparator();
					menu.AddItem("Duplicate Text", RichTextLabel.MenuItems.Max + 1);
					// Add event handler.
					menu.IdPressed += OnItemPressed;
				}

				public void OnItemPressed(int id)
				{
					if (id == TextEdit.MenuItems.Max + 1)
					{
						AddText("\n" + GetParsedText());
					}
				}
				

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 Window.visible property.

int get_paragraph_count() const

Returns the total number of paragraphs (newlines or p tags in the tag stack's text tags). Considers wrapped text as one paragraph.

float get_paragraph_offset(int paragraph)

Returns the vertical offset of the paragraph found at the provided index. Note: If threaded is enabled, this method returns a value for the loaded part of the document. Use is_finished() or finished to determine whether document is fully loaded.

String get_parsed_text() const

Returns the text without BBCode mark-up.

String get_selected_text() const

Returns the current selection text. Does not include BBCodes.

int get_selection_from() const

Returns the current selection first character index if a selection is active, -1 otherwise. Does not include BBCodes.

float get_selection_line_offset() const

Returns the current selection vertical line offset if a selection is active, -1.0 otherwise.

int get_selection_to() const

Returns the current selection last character index if a selection is active, -1 otherwise. Does not include BBCodes.

int get_total_character_count() const

Returns the total number of characters from text tags. Does not include BBCodes.

VScrollBar get_v_scroll_bar()

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.

Rect2i get_visible_content_rect() const

Returns the bounding rectangle of the visible content. Note: This method returns a correct value only after the label has been drawn.

				extends RichTextLabel

				@export var background_panel: Panel

				func _ready():
					await draw
					background_panel.position = get_visible_content_rect().position
					background_panel.size = get_visible_content_rect().size
				
				public partial class TestLabel : RichTextLabel
				{
					[Export]
					public Panel BackgroundPanel { get; set; }

					public override async void _Ready()
					{
						await ToSignal(this, Control.SignalName.Draw);
						BackgroundGPanel.Position = GetVisibleContentRect().Position;
						BackgroundPanel.Size = GetVisibleContentRect().Size;
					}
				}
				

int get_visible_line_count() const

Returns the number of visible lines. Note: This method returns a correct value only after the label has been drawn. Note: If threaded is enabled, this method returns a value for the loaded part of the document. Use is_finished() or finished to determine whether document is fully loaded.

int get_visible_paragraph_count() const

Returns the number of visible paragraphs. A paragraph is considered visible if at least one of its lines is visible. Note: This method returns a correct value only after the label has been drawn. Note: If threaded is enabled, this method returns a value for the loaded part of the document. Use is_finished() or finished to determine whether document is fully loaded.

void install_effect(Variant effect)

Installs a custom effect. This can also be done in the Inspector through the custom_effects property. effect should be a valid RichTextEffect. Example: With the following script extending from RichTextEffect:

				# effect.gd
				class_name MyCustomEffect
				extends RichTextEffect

				var bbcode = "my_custom_effect"

				# ...
				

The above effect can be installed in RichTextLabel from a script:

				# rich_text_label.gd
				extends RichTextLabel

				func _ready():
					install_effect(MyCustomEffect.new())

					# Alternatively, if not using `class_name` in the script that extends RichTextEffect:
					install_effect(preload("res://effect.gd").new())
				

bool invalidate_paragraph(int paragraph)

Invalidates paragraph and all subsequent paragraphs cache.

bool is_finished() const

If threaded is enabled, returns true if the background thread has finished text processing, otherwise always return true.

bool is_menu_visible() const

Returns whether the menu is visible. Use this instead of get_menu().visible to improve performance (so the creation of the menu is avoided).

bool is_ready() const

Deprecated.

Use is_finished() instead.

If threaded is enabled, returns true if the background thread has finished text processing, otherwise always return true.

void menu_option(int option)

Executes a given action as defined in the MenuItems enum.

void newline()

Adds a newline tag to the tag stack.

void parse_bbcode(String bbcode)

The assignment version of append_text(). Clears the tag stack and inserts the new content.

void pop()

Terminates the current tag. Use after push_* methods to close BBCodes manually. Does not need to follow add_* methods.

void pop_all()

Terminates all tags opened by push_* methods.

void pop_context()

Terminates tags opened after the last push_context() call (including context marker), or all tags if there's no context marker on the stack.

void push_bgcolor(Color bgcolor)

Adds a [code skip-lint][bgcolor][/code] tag to the tag stack. Note: The background color has padding applied by default, which is controlled using text_highlight_h_padding and text_highlight_v_padding. This can lead to overlapping highlights if background colors are placed on neighboring lines/columns, so consider setting those theme items to 0 if you want to avoid this.

void push_bold()

Adds a [code skip-lint]font[/code] tag with a bold font to the tag stack. This is the same as adding a [code skip-lint][/code] tag if not currently in a [code skip-lint][/code] tag.

void push_bold_italics()

Adds a [code skip-lint]font[/code] tag with a bold italics font to the tag stack.

void push_color(Color color)

Adds a [code skip-lint]color[/code] tag to the tag stack.

void push_context()

Adds a context marker to the tag stack. See pop_context().

void push_customfx(RichTextEffect effect, Dictionary env)

Adds a custom effect tag to the tag stack. The effect does not need to be in custom_effects. The environment is directly passed to the effect.

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

Adds a [code skip-lint][dropcap][/code] tag to the tag stack. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text.

void push_fgcolor(Color fgcolor)

Adds a [code skip-lint][fgcolor][/code] tag to the tag stack. Note: The foreground color has padding applied by default, which is controlled using text_highlight_h_padding and text_highlight_v_padding. This can lead to overlapping highlights if foreground colors are placed on neighboring lines/columns, so consider setting those theme items to 0 if you want to avoid this.

void push_font(Font font, int font_size = 0)

Adds a [code skip-lint]font[/code] tag to the tag stack. Overrides default fonts for its duration. Passing 0 to font_size will use the existing default font size.

void push_font_size(int font_size)

Adds a [code skip-lint][font_size][/code] tag to the tag stack. Overrides default font size for its duration.

void push_hint(String description)

Adds a [code skip-lint][hint][/code] tag to the tag stack. Same as BBCode [code skip-lint][hint=something]{text}[/hint][/code].

void push_indent(int level)

Adds an [code skip-lint][indent][/code] tag to the tag stack. Multiplies level by current tab_size to determine new margin length.

void push_italics()

Adds a [code skip-lint]font[/code] tag with an italics font to the tag stack. This is the same as adding an [code skip-lint][/code] tag if not currently in a [code skip-lint][/code] tag.

void push_language(String language)

Adds language code used for text shaping algorithm and Open-Type font features.

void push_list(int level, int type, bool capitalize, String bullet = "•")

Adds [code skip-lint][ol][/code] or [code skip-lint][ul][/code] tag to the tag stack. Multiplies level by current tab_size to determine new margin length.

void push_meta(Variant data, int underline_mode = 1, String tooltip = "")

Adds a meta tag to the tag stack. Similar to the BBCode [code skip-lint]{text}[/code], but supports non-String metadata types. If meta_underlined is true, meta tags display an underline. This behavior can be customized with underline_mode. Note: Meta tags do nothing by default when clicked. To assign behavior when clicked, connect meta_clicked to a function that is called when the meta tag is clicked.

void push_mono()

Adds a [code skip-lint]font[/code] tag with a monospace font to the tag stack.

void push_normal()

Adds a [code skip-lint]font[/code] tag with a normal font to the tag stack.

void push_outline_color(Color color)

Adds a [code skip-lint][outline_color][/code] tag to the tag stack. Adds text outline for its duration.

void push_outline_size(int outline_size)

Adds a [code skip-lint][outline_size][/code] tag to the tag stack. Overrides default text outline size for its duration.

void push_paragraph(int alignment, int base_direction = 0, String language = "", int st_parser = 0, int justification_flags = 163, PackedFloat32Array tab_stops = PackedFloat32Array())

Adds a [code skip-lint][p][/code] tag to the tag stack.

void push_strikethrough(Color color = Color(0, 0, 0, 0))

Adds a [code skip-lint][/code] tag to the tag stack. If color alpha value is zero, current font color with alpha multiplied by strikethrough_alpha is used.

void push_table(int columns, int inline_align = 0, int align_to_row = -1, String name = "")

Adds a [code skip-lint][table=columns,inline_align][/code] tag to the tag stack. Use set_table_column_expand() to set column expansion ratio. Use push_cell() to add cells. name is used as the table name for assistive apps.

void push_underline(Color color = Color(0, 0, 0, 0))

Adds a [code skip-lint][/code] tag to the tag stack. If color alpha value is zero, current font color with alpha multiplied by underline_alpha is used.

void reload_effects()

Reloads custom effects. Useful when custom_effects is modified manually.

bool remove_paragraph(int paragraph, bool no_invalidate = false)

Removes a paragraph of content from the label. Returns true if the paragraph exists. The paragraph argument is the index of the paragraph to remove, it can take values in the interval [0, get_paragraph_count() - 1]. If no_invalidate is set to true, cache for the subsequent paragraphs is not invalidated. Use it for faster updates if deleted paragraph is fully self-contained (have no unclosed tags), or this call is part of the complex edit operation and invalidate_paragraph() will be called at the end of operation.

void scroll_to_line(int line)

Scrolls the window's top line to match line.

void scroll_to_paragraph(int paragraph)

Scrolls the window's top line to match first line of the paragraph.

void scroll_to_selection()

Scrolls to the beginning of the current selection.

void select_all()

Select all the text. If selection_enabled is false, no selection will occur.

void set_cell_border_color(Color color)

Sets color of a table cell border.

void set_cell_padding(Rect2 padding)

Sets inner padding of a table cell.

void set_cell_row_background_color(Color odd_row_bg, Color even_row_bg)

Sets color of a table cell. Separate colors for alternating rows can be specified.

void set_cell_size_override(Vector2 min_size, Vector2 max_size)

Sets minimum and maximum size overrides for a table cell.

void set_table_column_expand(int column, bool expand, int ratio = 1, bool shrink = true)

Edits the selected column's expansion options. If expand is true, the column expands in proportion to its expansion ratio versus the other columns' ratios. For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width would expand 30 and 40 pixels, respectively. If expand is false, the column will not contribute to the total ratio.

void set_table_column_name(int column, String name)

Sets table column name for assistive apps.

void update_image(Variant key, int mask, Texture2D image, int width = 0, int height = 0, Color color = Color(1, 1, 1, 1), int inline_align = 5, Rect2 region = Rect2(0, 0, 0, 0), bool pad = false, String tooltip = "", bool width_in_percent = false, bool height_in_percent = false)

Updates the existing images with the key key. Only properties specified by mask bits are updated. See add_image().

Signals

finished()

Triggered when the document is fully loaded. Note: This can happen before the text is processed for drawing. Scrolling values may not be valid until the document is drawn for the first time after this signal.

meta_clicked(Variant meta)

Triggered when the user clicks on content between meta (URL) tags. If the meta is defined in BBCode, e.g. [code skip-lint]Text[/code], 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(Variant meta)

Triggers when the mouse exits a meta tag.

meta_hover_started(Variant meta)

Triggers when the mouse enters a meta tag.

Constants

LIST_NUMBERS = 0

Enum: ListType

Each list item has a number marker.

LIST_LETTERS = 1

Enum: ListType

Each list item has a letter marker.

LIST_ROMAN = 2

Enum: ListType

Each list item has a roman number marker.

LIST_DOTS = 3

Enum: ListType

Each list item has a filled circle marker.

MENU_COPY = 0

Enum: MenuItems

Copies the selected text.

MENU_SELECT_ALL = 1

Enum: MenuItems

Selects the whole RichTextLabel text.

MENU_MAX = 2

Enum: MenuItems

Represents the size of the MenuItems enum.

META_UNDERLINE_NEVER = 0

Enum: MetaUnderline

Meta tag does not display an underline, even if meta_underlined is true.

META_UNDERLINE_ALWAYS = 1

Enum: MetaUnderline

If meta_underlined is true, meta tag always display an underline.

META_UNDERLINE_ON_HOVER = 2

Enum: MetaUnderline

If meta_underlined is true, meta tag display an underline when the mouse cursor is over it.

UPDATE_TEXTURE = 1

Enum: ImageUpdateMask

If this bit is set, update_image() changes image texture.

UPDATE_SIZE = 2

Enum: ImageUpdateMask

If this bit is set, update_image() changes image size.

UPDATE_COLOR = 4

Enum: ImageUpdateMask

If this bit is set, update_image() changes image color.

UPDATE_ALIGNMENT = 8

Enum: ImageUpdateMask

If this bit is set, update_image() changes image inline alignment.

UPDATE_REGION = 16

Enum: ImageUpdateMask

If this bit is set, update_image() changes image texture region.

UPDATE_PAD = 32

Enum: ImageUpdateMask

If this bit is set, update_image() changes image padding.

UPDATE_TOOLTIP = 64

Enum: ImageUpdateMask

If this bit is set, update_image() changes image tooltip.

UPDATE_WIDTH_IN_PERCENT = 128

Enum: ImageUpdateMask

If this bit is set, update_image() changes image width from/to percents.

Theme properties

Color default_color = Color(1, 1, 1, 1)

The default text color.

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

The default tint of text outline.

Color font_selected_color = Color(0, 0, 0, 0)

The color of selected text, used when selection_enabled is true. If equal to Color(0, 0, 0, 0), it will be ignored.

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

The color of the font's shadow.

Color selection_color = Color(0.1, 0.1, 1, 0.8)

The color of the selection box.

Color table_border = Color(0, 0, 0, 0)

The default cell border color.

Color table_even_row_bg = Color(0, 0, 0, 0)

The default background color for even rows.

Color table_odd_row_bg = Color(0, 0, 0, 0)

The default background color for odd rows.

int line_separation = 0

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

int paragraph_separation = 0

Additional vertical spacing between paragraphs (in pixels). Spacing is added after the last line. This value can be negative.

int shadow_offset_x = 1

The horizontal offset of the font's shadow.

int shadow_offset_y = 1

The vertical offset of the font's shadow.

int shadow_outline_size = 1

The size of the shadow outline.

int strikethrough_alpha = 50

The default strikethrough color transparency (percent). For strikethroughs with a custom color, this theme item is only used if the custom color's alpha is 0.0 (fully transparent).

int table_h_separation = 3

The horizontal separation of elements in a table.

int table_v_separation = 3

The vertical separation of elements in a table.

int text_highlight_h_padding = 3

The horizontal padding around boxes drawn by the [fgcolor] and [bgcolor] tags. This does not affect the appearance of text selection. To avoid any risk of neighboring highlights overlapping each other, set this to 0 to disable padding.

int text_highlight_v_padding = 3

The vertical padding around boxes drawn by the [fgcolor] and [bgcolor] tags. This does not affect the appearance of text selection. To avoid any risk of neighboring highlights overlapping each other, set this to 0 to disable padding.

int underline_alpha = 50

The default underline color transparency (percent). For underlines with a custom color, this theme item is only used if the custom color's alpha is 0.0 (fully transparent).

Font bold_font

The font used for bold text.

Font bold_italics_font

The font used for bold italics text.

Font italics_font

The font used for italics text.

Font mono_font

The font used for monospace text.

Font normal_font

The default text font.

int bold_font_size

The font size used for bold text.

int bold_italics_font_size

The font size used for bold italics text.

int italics_font_size

The font size used for italics text.

int mono_font_size

The font size used for monospace text.

int normal_font_size

The default text font size.

Texture2D horizontal_rule

The horizontal rule texture.

StyleBox focus

The background used when the RichTextLabel is focused. The focus StyleBox is displayed over the base StyleBox, so a partially transparent StyleBox should be used to ensure the base StyleBox remains visible. A StyleBox that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a StyleBoxEmpty resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.

Tutorials

Source revision 4f5b14abade2
Connection interrupted. Reload×

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.