Inheritance #

Object
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
Node
- AnimationMixer (2)
- AudioStreamPlayer
- CanvasItem (2)
- CanvasLayer (1)
- EditorFileSystem
- EditorPlugin (1)
- EditorResourcePreview
- HTTPRequest
- InstancePlaceholder
- MissingNode
- MultiplayerSpawner
- MultiplayerSynchronizer
- NavigationAgent2D
- NavigationAgent3D
- Node3D (31)
- ResourcePreloader
- ShaderGlobalsOverride
- StatusIndicator
- Timer
- Viewport (2)
- WorldEnvironment
CanvasItem
- Control (19)
- Node2D (37)
Control
- BaseButton (3)
- ColorRect
- Container (13)
- GraphEdit
- ItemList
- Label
- LineEdit
- MenuBar
- NinePatchRect
- Panel
- Range (6)
- ReferenceRect
- RichTextLabel
- Separator (2)
- TabBar
- TextEdit (1)
- TextureRect
- Tree
- VideoStreamPlayer
RichTextLabel
Table of contents

RichTextLabel #

is_instantiable, Node, core, not_builtin_classes

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

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, use [code skip-lint]boldbold italicitalic.

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 [code skip-lint]center tag as follows: [code skip-lint]centerExample[/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.

Members #

var autowrap_mode = AUTOWRAP_WORD_SMART#

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 TextServer.AutowrapMode.

var bbcode_enabled: bool = false#

If true, the label uses BBCode formatting.

Note: This only affects the contents of text, not the tag stack.

var clip_contents: bool = true#

var context_menu_enabled: bool = false#

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

var custom_effects: Array = []#

The currently installed custom effects. This is an array of RichTextEffects.

To add a custom effect, it's more convenient to use install_effect.

var deselect_on_focus_loss_enabled: bool = true#

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

var drag_and_drop_selection_enabled: bool = true#

If true, allow drag and drop of selected text.

var fit_content: bool = false#

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

var hint_underlined: bool = true#

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

var horizontal_alignment: int = 0#

Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the HorizontalAlignment constants.

var justification_flags: int = 163#

Line fill alignment rules. See TextServer.JustificationFlag for more information.

var language: String = ""#

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

var meta_underlined: bool = true#

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

var progress_bar_delay: int = 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.

var scroll_active: bool = true#

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

var scroll_following: bool = false#

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

var selection_enabled: bool = false#

If true, the label allows text selection.

var shortcut_keys_enabled: bool = true#

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

var structured_text_bidi_override = STRUCTURED_TEXT_DEFAULT#

Set BiDi algorithm override for the structured text.

var structured_text_bidi_override_options: Array = []#

Set additional options for BiDi override.

var tab_size: int = 4#

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

var tab_stops: PackedFloat32Array = PackedFloat32Array()#

Aligns text to the given tab-stops.

var text: String = ""#

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.

var text_direction = TEXT_DIRECTION_AUTO#

Base text writing direction.

var threaded: bool = false#

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

var vertical_alignment: int = 0#

Controls the text's vertical alignment. Supports top, center, bottom, and fill. Set it to one of the VerticalAlignment constants.

var visible_characters: int = -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.

var visible_characters_behavior = VC_CHARS_BEFORE_SHAPING#

Sets the clipping behavior when visible_characters or visible_ratio is set. See TextServer.VisibleCharactersBehavior for more info.

var visible_ratio: float = 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 #

func add_image(size_in_percent: bool = false) -> void#

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 size_in_percent is set, width and height values are percentages of the control width instead of pixels.

func add_text(text: String) -> void#

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

func append_text(bbcode: String) -> void#

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.

func clear() -> void#

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.

func deselect() -> void#

Clears the current selection.

func get_character_line(character: int) -> int#

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.

func get_character_paragraph(character: int) -> int#

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.

const func get_content_height() -> int#

Returns the height of the content.

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.

const func get_content_width() -> int#

Returns the width of the content.

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.

const func get_line_count() -> int#

Returns the total number of lines in the text. Wrapped text is counted as multiple lines.

Note: If visible_characters_behavior is set to TextServer.VC_CHARS_BEFORE_SHAPING only visible wrapped lines are counted.

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.

func get_line_offset(line: int) -> float#

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.

func get_line_range(line: int) -> Vector2i#

Returns the indexes of the first and last visible characters for the given line, as a Vector2i.

Note: If visible_characters_behavior is set to TextServer.VC_CHARS_BEFORE_SHAPING only visible wrapped lines are counted.

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.

const func get_menu() -> PopupMenu#

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:

GDScript

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

C#

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.

const func get_paragraph_count() -> int#

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

func get_paragraph_offset(paragraph: int) -> float#

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.

const func get_parsed_text() -> String#

Returns the text without BBCode mark-up.

const func get_selected_text() -> String#

Returns the current selection text. Does not include BBCodes.

const func get_selection_from() -> int#

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

const func get_selection_line_offset() -> float#

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

const func get_selection_to() -> int#

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

const func get_total_character_count() -> int#

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

func get_v_scroll_bar() -> VScrollBar#

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.

const func get_visible_line_count() -> int#

Returns the number of visible 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.

const func get_visible_paragraph_count() -> int#

Returns the number of visible paragraphs. A paragraph is considered visible if at least one of its lines is visible.

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.

func install_effect(effect: Variant) -> void#

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

func invalidate_paragraph(paragraph: int) -> bool#

Invalidates paragraph and all subsequent paragraphs cache.

const func is_finished() -> bool#

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

const func is_menu_visible() -> bool#

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

const func is_ready() -> bool#

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

Executes a given action as defined in the MenuItems enum.

func newline() -> void#

Adds a newline tag to the tag stack.

func parse_bbcode(bbcode: String) -> void#

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

func parse_expressions_for_values(expressions: PackedStringArray) -> Dictionary#

Parses BBCode parameter expressions into a dictionary.

func pop() -> void#

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

func pop_all() -> void#

Terminates all tags opened by push_* methods.

func pop_context() -> void#

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

func push_bgcolor(bgcolor: Color) -> void#

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

func push_bold() -> void#

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

func push_bold_italics() -> void#

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

func push_cell() -> void#

Adds a [code skip-lint]cell tag to the tag stack. Must be inside a [code skip-lint]table tag. See push_table for details. Use set_table_column_expand to set column expansion ratio, set_cell_border_color to set cell border, set_cell_row_background_color to set cell background, set_cell_size_override to override cell size, and set_cell_padding to set padding.

func push_color(color: Color) -> void#

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

func push_context() -> void#

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

func push_customfx(env: Dictionary) -> void#

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.

func push_dropcap(outline_color: Color = Color(0, 0, 0, 0)) -> void#

Adds a [code skip-lint]dropcap 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.

func push_fgcolor(fgcolor: Color) -> void#

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

func push_font(font_size: int = 0) -> void#

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

Passing 0 to font_size will use the existing default font size.

func push_font_size(font_size: int) -> void#

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

func push_hint(description: String) -> void#

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

func push_indent(level: int) -> void#

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

func push_italics() -> void#

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

func push_language(language: String) -> void#

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

func push_list(bullet: String = "•") -> void#

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

func push_meta(tooltip: String = "") -> void#

Adds a meta tag to the tag stack. Similar to the BBCode [code skip-lint]{text}, 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.

func push_mono() -> void#

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

func push_normal() -> void#

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

func push_outline_color(color: Color) -> void#

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

func push_outline_size(outline_size: int) -> void#

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

func push_paragraph(tab_stops: PackedFloat32Array = PackedFloat32Array()) -> void#

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

func push_strikethrough() -> void#

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

func push_table(align_to_row: int = -1) -> void#

Adds a [code skip-lint][table=columns,inline_align] tag to the tag stack. Use set_table_column_expand to set column expansion ratio. Use push_cell to add cells.

func push_underline() -> void#

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

func remove_paragraph(no_invalidate: bool = false) -> bool#

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.

func scroll_to_line(line: int) -> void#

Scrolls the window's top line to match line.

func scroll_to_paragraph(paragraph: int) -> void#

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

func scroll_to_selection() -> void#

Scrolls to the beginning of the current selection.

func select_all() -> void#

Select all the text.

If selection_enabled is false, no selection will occur.

func set_cell_border_color(color: Color) -> void#

Sets color of a table cell border.

func set_cell_padding(padding: Rect2) -> void#

Sets inner padding of a table cell.

func set_cell_row_background_color(even_row_bg: Color) -> void#

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

func set_cell_size_override(max_size: Vector2) -> void#

Sets minimum and maximum size overrides for a table cell.

func set_table_column_expand(shrink: bool = true) -> void#

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.

func update_image(size_in_percent: bool = false) -> void#

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

Annotations #

Constants #

const LIST_NUMBERS = 0 enum ListType#

Each list item has a number marker.

const LIST_LETTERS = 1 enum ListType#

Each list item has a letter marker.

const LIST_ROMAN = 2 enum ListType#

Each list item has a roman number marker.

const LIST_DOTS = 3 enum ListType#

Each list item has a filled circle marker.

Copies the selected text.

Selects the whole RichTextLabel text.

Represents the size of the MenuItems enum.

const META_UNDERLINE_NEVER = 0 enum MetaUnderline#

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

const META_UNDERLINE_ALWAYS = 1 enum MetaUnderline#

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

const META_UNDERLINE_ON_HOVER = 2 enum MetaUnderline#

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

const UPDATE_TEXTURE = 1 enum ImageUpdateMask
Bitfield
#

If this bit is set, update_image changes image texture.

const UPDATE_SIZE = 2 enum ImageUpdateMask
Bitfield
#

If this bit is set, update_image changes image size.

const UPDATE_COLOR = 4 enum ImageUpdateMask
Bitfield
#

If this bit is set, update_image changes image color.

const UPDATE_ALIGNMENT = 8 enum ImageUpdateMask
Bitfield
#

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

const UPDATE_REGION = 16 enum ImageUpdateMask
Bitfield
#

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

const UPDATE_PAD = 32 enum ImageUpdateMask
Bitfield
#

If this bit is set, update_image changes image padding.

const UPDATE_TOOLTIP = 64 enum ImageUpdateMask
Bitfield
#

If this bit is set, update_image changes image tooltip.

const UPDATE_WIDTH_IN_PERCENT = 128 enum ImageUpdateMask
Bitfield
#

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

Constructors #

Enums #

ListType#

enum ListType { LIST_NUMBERS = 0, LIST_LETTERS = 1, LIST_ROMAN = 2, LIST_DOTS = 3, }enum MenuItems { MENU_COPY = 0, MENU_SELECT_ALL = 1, MENU_MAX = 2, }

MetaUnderline#

enum MetaUnderline { META_UNDERLINE_NEVER = 0, META_UNDERLINE_ALWAYS = 1, META_UNDERLINE_ON_HOVER = 2, }

ImageUpdateMask#

enum ImageUpdateMask { UPDATE_TEXTURE = 1, UPDATE_SIZE = 2, UPDATE_COLOR = 4, UPDATE_ALIGNMENT = 8, UPDATE_REGION = 16, UPDATE_PAD = 32, UPDATE_TOOLTIP = 64, UPDATE_WIDTH_IN_PERCENT = 128, }

Operators #

Signals #

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

signal meta_clicked(meta: Variant)#

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

signal meta_hover_ended(meta: Variant)#

Triggers when the mouse exits a meta tag.

signal meta_hover_started(meta: Variant)#

Triggers when the mouse enters a meta tag.

Theme Items #

self["theme_override_colors/default_color"] = Color(1, 1, 1, 1) as Color#

The default text color.

self["theme_override_colors/font_outline_color"] = Color(0, 0, 0, 1) as Color#

The default tint of text outline.

self["theme_override_colors/font_selected_color"] = Color(0, 0, 0, 0) as Color#

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

self["theme_override_colors/font_shadow_color"] = Color(0, 0, 0, 0) as Color#

The color of the font's shadow.

self["theme_override_colors/selection_color"] = Color(0.1, 0.1, 1, 0.8) as Color#

The color of the selection box.

self["theme_override_colors/table_border"] = Color(0, 0, 0, 0) as Color#

The default cell border color.

self["theme_override_colors/table_even_row_bg"] = Color(0, 0, 0, 0) as Color#

The default background color for even rows.

self["theme_override_colors/table_odd_row_bg"] = Color(0, 0, 0, 0) as Color#

The default background color for odd rows.

self["theme_override_constants/line_separation"] = 0 as int#

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

self["theme_override_constants/outline_size"] = 0 as int#

The size of the text outline.

Note: If using a font with FontFile.multichannel_signed_distance_field enabled, its FontFile.msdf_pixel_range must be set to at least twice the value of outline_size for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.

self["theme_override_constants/shadow_offset_x"] = 1 as int#

The horizontal offset of the font's shadow.

self["theme_override_constants/shadow_offset_y"] = 1 as int#

The vertical offset of the font's shadow.

self["theme_override_constants/shadow_outline_size"] = 1 as int#

The size of the shadow outline.

self["theme_override_constants/table_h_separation"] = 3 as int#

The horizontal separation of elements in a table.

self["theme_override_constants/table_v_separation"] = 3 as int#

The vertical separation of elements in a table.

self["theme_override_constants/text_highlight_h_padding"] = 3 as int#

The horizontal padding around boxes drawn by the fgcolor and bgcolor tags. This does not affect the appearance of text selection.

self["theme_override_constants/text_highlight_v_padding"] = 3 as int#

The vertical padding around boxes drawn by the fgcolor and bgcolor tags. This does not affect the appearance of text selection.

self["theme_override_fonts/bold_font"] = font as Font#

The font used for bold text.

self["theme_override_fonts/bold_italics_font"] = font as Font#

The font used for bold italics text.

self["theme_override_fonts/italics_font"] = font as Font#

The font used for italics text.

self["theme_override_fonts/mono_font"] = font as Font#

The font used for monospace text.

self["theme_override_fonts/normal_font"] = font as Font#

The default text font.

self["theme_override_font_sizes/bold_font_size"] = font_size as int#

The font size used for bold text.

self["theme_override_font_sizes/bold_italics_font_size"] = font_size as int#

The font size used for bold italics text.

self["theme_override_font_sizes/italics_font_size"] = font_size as int#

The font size used for italics text.

self["theme_override_font_sizes/mono_font_size"] = font_size as int#

The font size used for monospace text.

self["theme_override_font_sizes/normal_font_size"] = font_size as int#

The default text font size.

self["theme_override_styles/focus"] = style as StyleBox#

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.

self["theme_override_styles/normal"] = style as StyleBox#

The normal background for the RichTextLabel.

Tutorials #