godot-docs/classes/class_richtextlabel.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the RichTextLabel.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_RichTextLabel:

RichTextLabel
=============

**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

Label that displays rich text.

Description
-----------

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 :ref:`text<class_RichTextLabel_property_text>` clear the tag stack and reconstruct it from the property's contents. Any edits made to :ref:`text<class_RichTextLabel_property_text>` will erase previous edits made from other manual sources such as :ref:`append_text<class_RichTextLabel_method_append_text>` and the ``push_*`` / :ref:`pop<class_RichTextLabel_method_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 :ref:`Label<class_Label>`, RichTextLabel doesn't have a *property* to horizontally align text to the center. Instead, enable :ref:`bbcode_enabled<class_RichTextLabel_property_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 :ref:`fit_content_height<class_RichTextLabel_property_fit_content_height>` property.

Tutorials
---------

- :doc:`BBCode in RichTextLabel <../tutorials/ui/bbcode_in_richtextlabel>`

- `GUI Rich Text/BBcode Demo <https://godotengine.org/asset-library/asset/132>`__

- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`__

Properties
----------

+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`AutowrapMode<enum_RichTextLabel_AutowrapMode>`                           | :ref:`autowrap_mode<class_RichTextLabel_property_autowrap_mode>`                                                 | ``3``                                                                     |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                                                        | :ref:`bbcode_enabled<class_RichTextLabel_property_bbcode_enabled>`                                               | ``false``                                                                 |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                                                        | clip_contents                                                                                                    | ``true`` (overrides :ref:`Control<class_Control_property_clip_contents>`) |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`Array<class_Array>`                                                      | :ref:`custom_effects<class_RichTextLabel_property_custom_effects>`                                               | ``[]``                                                                    |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                                                        | :ref:`deselect_on_focus_loss_enabled<class_RichTextLabel_property_deselect_on_focus_loss_enabled>`               | ``true``                                                                  |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                                                        | :ref:`fit_content_height<class_RichTextLabel_property_fit_content_height>`                                       | ``false``                                                                 |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`String<class_String>`                                                    | :ref:`language<class_RichTextLabel_property_language>`                                                           | ``""``                                                                    |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                                                        | :ref:`meta_underlined<class_RichTextLabel_property_meta_underlined>`                                             | ``true``                                                                  |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                                                        | :ref:`override_selected_font_color<class_RichTextLabel_property_override_selected_font_color>`                   | ``false``                                                                 |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>`                                                      | :ref:`percent_visible<class_RichTextLabel_property_percent_visible>`                                             | ``1.0``                                                                   |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                                                        | :ref:`scroll_active<class_RichTextLabel_property_scroll_active>`                                                 | ``true``                                                                  |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                                                        | :ref:`scroll_following<class_RichTextLabel_property_scroll_following>`                                           | ``false``                                                                 |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                                                        | :ref:`selection_enabled<class_RichTextLabel_property_selection_enabled>`                                         | ``false``                                                                 |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`StructuredTextParser<enum_Control_StructuredTextParser>`                 | :ref:`structured_text_bidi_override<class_RichTextLabel_property_structured_text_bidi_override>`                 | ``0``                                                                     |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`Array<class_Array>`                                                      | :ref:`structured_text_bidi_override_options<class_RichTextLabel_property_structured_text_bidi_override_options>` | ``[]``                                                                    |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`int<class_int>`                                                          | :ref:`tab_size<class_RichTextLabel_property_tab_size>`                                                           | ``4``                                                                     |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`String<class_String>`                                                    | :ref:`text<class_RichTextLabel_property_text>`                                                                   | ``""``                                                                    |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`TextDirection<enum_Control_TextDirection>`                               | :ref:`text_direction<class_RichTextLabel_property_text_direction>`                                               | ``0``                                                                     |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`int<class_int>`                                                          | :ref:`visible_characters<class_RichTextLabel_property_visible_characters>`                                       | ``-1``                                                                    |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`VisibleCharactersBehavior<enum_RichTextLabel_VisibleCharactersBehavior>` | :ref:`visible_characters_behavior<class_RichTextLabel_property_visible_characters_behavior>`                     | ``0``                                                                     |
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+

Methods
-------

+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`add_image<class_RichTextLabel_method_add_image>` **(** :ref:`Texture2D<class_Texture2D>` image, :ref:`int<class_int>` width=0, :ref:`int<class_int>` height=0, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1), :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` inline_align=5 **)**                                                                                 |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`add_text<class_RichTextLabel_method_add_text>` **(** :ref:`String<class_String>` text **)**                                                                                                                                                                                                                                                                                      |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`append_text<class_RichTextLabel_method_append_text>` **(** :ref:`String<class_String>` bbcode **)**                                                                                                                                                                                                                                                                              |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`clear<class_RichTextLabel_method_clear>` **(** **)**                                                                                                                                                                                                                                                                                                                             |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`get_character_line<class_RichTextLabel_method_get_character_line>` **(** :ref:`int<class_int>` character **)**                                                                                                                                                                                                                                                                   |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`get_character_paragraph<class_RichTextLabel_method_get_character_paragraph>` **(** :ref:`int<class_int>` character **)**                                                                                                                                                                                                                                                         |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`get_content_height<class_RichTextLabel_method_get_content_height>` **(** **)** |const|                                                                                                                                                                                                                                                                                           |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`get_content_width<class_RichTextLabel_method_get_content_width>` **(** **)** |const|                                                                                                                                                                                                                                                                                             |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`get_line_count<class_RichTextLabel_method_get_line_count>` **(** **)** |const|                                                                                                                                                                                                                                                                                                   |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`           | :ref:`get_line_offset<class_RichTextLabel_method_get_line_offset>` **(** :ref:`int<class_int>` line **)**                                                                                                                                                                                                                                                                              |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`get_paragraph_count<class_RichTextLabel_method_get_paragraph_count>` **(** **)** |const|                                                                                                                                                                                                                                                                                         |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`           | :ref:`get_paragraph_offset<class_RichTextLabel_method_get_paragraph_offset>` **(** :ref:`int<class_int>` paragraph **)**                                                                                                                                                                                                                                                               |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`         | :ref:`get_parsed_text<class_RichTextLabel_method_get_parsed_text>` **(** **)** |const|                                                                                                                                                                                                                                                                                                 |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`         | :ref:`get_selected_text<class_RichTextLabel_method_get_selected_text>` **(** **)** |const|                                                                                                                                                                                                                                                                                             |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`get_selection_from<class_RichTextLabel_method_get_selection_from>` **(** **)** |const|                                                                                                                                                                                                                                                                                           |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`get_selection_to<class_RichTextLabel_method_get_selection_to>` **(** **)** |const|                                                                                                                                                                                                                                                                                               |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`get_total_character_count<class_RichTextLabel_method_get_total_character_count>` **(** **)** |const|                                                                                                                                                                                                                                                                             |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`VScrollBar<class_VScrollBar>` | :ref:`get_v_scroll_bar<class_RichTextLabel_method_get_v_scroll_bar>` **(** **)**                                                                                                                                                                                                                                                                                                       |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`get_visible_line_count<class_RichTextLabel_method_get_visible_line_count>` **(** **)** |const|                                                                                                                                                                                                                                                                                   |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`get_visible_paragraph_count<class_RichTextLabel_method_get_visible_paragraph_count>` **(** **)** |const|                                                                                                                                                                                                                                                                         |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`install_effect<class_RichTextLabel_method_install_effect>` **(** :ref:`Variant<class_Variant>` effect **)**                                                                                                                                                                                                                                                                      |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`newline<class_RichTextLabel_method_newline>` **(** **)**                                                                                                                                                                                                                                                                                                                         |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`parse_bbcode<class_RichTextLabel_method_parse_bbcode>` **(** :ref:`String<class_String>` bbcode **)**                                                                                                                                                                                                                                                                            |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`parse_expressions_for_values<class_RichTextLabel_method_parse_expressions_for_values>` **(** :ref:`PackedStringArray<class_PackedStringArray>` expressions **)**                                                                                                                                                                                                                 |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`pop<class_RichTextLabel_method_pop>` **(** **)**                                                                                                                                                                                                                                                                                                                                 |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_bgcolor<class_RichTextLabel_method_push_bgcolor>` **(** :ref:`Color<class_Color>` bgcolor **)**                                                                                                                                                                                                                                                                             |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_bold<class_RichTextLabel_method_push_bold>` **(** **)**                                                                                                                                                                                                                                                                                                                     |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_bold_italics<class_RichTextLabel_method_push_bold_italics>` **(** **)**                                                                                                                                                                                                                                                                                                     |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_cell<class_RichTextLabel_method_push_cell>` **(** **)**                                                                                                                                                                                                                                                                                                                     |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_color<class_RichTextLabel_method_push_color>` **(** :ref:`Color<class_Color>` color **)**                                                                                                                                                                                                                                                                                   |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_dropcap<class_RichTextLabel_method_push_dropcap>` **(** :ref:`String<class_String>` string, :ref:`Font<class_Font>` font, :ref:`int<class_int>` size, :ref:`Rect2<class_Rect2>` dropcap_margins=Rect2(0, 0, 0, 0), :ref:`Color<class_Color>` color=Color(1, 1, 1, 1), :ref:`int<class_int>` outline_size=0, :ref:`Color<class_Color>` outline_color=Color(0, 0, 0, 0) **)** |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_fgcolor<class_RichTextLabel_method_push_fgcolor>` **(** :ref:`Color<class_Color>` fgcolor **)**                                                                                                                                                                                                                                                                             |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_font<class_RichTextLabel_method_push_font>` **(** :ref:`Font<class_Font>` font **)**                                                                                                                                                                                                                                                                                        |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_font_features<class_RichTextLabel_method_push_font_features>` **(** :ref:`Dictionary<class_Dictionary>` opentype_features **)**                                                                                                                                                                                                                                             |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_font_size<class_RichTextLabel_method_push_font_size>` **(** :ref:`int<class_int>` font_size **)**                                                                                                                                                                                                                                                                           |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_indent<class_RichTextLabel_method_push_indent>` **(** :ref:`int<class_int>` level **)**                                                                                                                                                                                                                                                                                     |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_italics<class_RichTextLabel_method_push_italics>` **(** **)**                                                                                                                                                                                                                                                                                                               |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_list<class_RichTextLabel_method_push_list>` **(** :ref:`int<class_int>` level, :ref:`ListType<enum_RichTextLabel_ListType>` type, :ref:`bool<class_bool>` capitalize **)**                                                                                                                                                                                                  |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_meta<class_RichTextLabel_method_push_meta>` **(** :ref:`Variant<class_Variant>` data **)**                                                                                                                                                                                                                                                                                  |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_mono<class_RichTextLabel_method_push_mono>` **(** **)**                                                                                                                                                                                                                                                                                                                     |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_normal<class_RichTextLabel_method_push_normal>` **(** **)**                                                                                                                                                                                                                                                                                                                 |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_outline_color<class_RichTextLabel_method_push_outline_color>` **(** :ref:`Color<class_Color>` color **)**                                                                                                                                                                                                                                                                   |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_outline_size<class_RichTextLabel_method_push_outline_size>` **(** :ref:`int<class_int>` outline_size **)**                                                                                                                                                                                                                                                                  |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_paragraph<class_RichTextLabel_method_push_paragraph>` **(** :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` alignment, :ref:`TextDirection<enum_Control_TextDirection>` base_direction=0, :ref:`String<class_String>` language="", :ref:`StructuredTextParser<enum_Control_StructuredTextParser>` st_parser=0 **)**                                       |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_strikethrough<class_RichTextLabel_method_push_strikethrough>` **(** **)**                                                                                                                                                                                                                                                                                                   |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_table<class_RichTextLabel_method_push_table>` **(** :ref:`int<class_int>` columns, :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` inline_align=0 **)**                                                                                                                                                                                                           |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`push_underline<class_RichTextLabel_method_push_underline>` **(** **)**                                                                                                                                                                                                                                                                                                           |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`             | :ref:`remove_line<class_RichTextLabel_method_remove_line>` **(** :ref:`int<class_int>` line **)**                                                                                                                                                                                                                                                                                      |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`scroll_to_line<class_RichTextLabel_method_scroll_to_line>` **(** :ref:`int<class_int>` line **)**                                                                                                                                                                                                                                                                                |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`scroll_to_paragraph<class_RichTextLabel_method_scroll_to_paragraph>` **(** :ref:`int<class_int>` paragraph **)**                                                                                                                                                                                                                                                                 |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`set_cell_border_color<class_RichTextLabel_method_set_cell_border_color>` **(** :ref:`Color<class_Color>` color **)**                                                                                                                                                                                                                                                             |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`set_cell_padding<class_RichTextLabel_method_set_cell_padding>` **(** :ref:`Rect2<class_Rect2>` padding **)**                                                                                                                                                                                                                                                                     |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`set_cell_row_background_color<class_RichTextLabel_method_set_cell_row_background_color>` **(** :ref:`Color<class_Color>` odd_row_bg, :ref:`Color<class_Color>` even_row_bg **)**                                                                                                                                                                                                 |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`set_cell_size_override<class_RichTextLabel_method_set_cell_size_override>` **(** :ref:`Vector2<class_Vector2>` min_size, :ref:`Vector2<class_Vector2>` max_size **)**                                                                                                                                                                                                            |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`set_table_column_expand<class_RichTextLabel_method_set_table_column_expand>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` expand, :ref:`int<class_int>` ratio **)**                                                                                                                                                                                               |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Theme Properties
----------------

+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | :ref:`default_color<class_RichTextLabel_theme_color_default_color>`                       | ``Color(1, 1, 1, 1)``       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | :ref:`font_outline_color<class_RichTextLabel_theme_color_font_outline_color>`             | ``Color(1, 1, 1, 1)``       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | :ref:`font_selected_color<class_RichTextLabel_theme_color_font_selected_color>`           | ``Color(0, 0, 0, 1)``       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | :ref:`font_shadow_color<class_RichTextLabel_theme_color_font_shadow_color>`               | ``Color(0, 0, 0, 0)``       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | :ref:`selection_color<class_RichTextLabel_theme_color_selection_color>`                   | ``Color(0.1, 0.1, 1, 0.8)`` |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | :ref:`table_border<class_RichTextLabel_theme_color_table_border>`                         | ``Color(0, 0, 0, 0)``       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | :ref:`table_even_row_bg<class_RichTextLabel_theme_color_table_even_row_bg>`               | ``Color(0, 0, 0, 0)``       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | :ref:`table_odd_row_bg<class_RichTextLabel_theme_color_table_odd_row_bg>`                 | ``Color(0, 0, 0, 0)``       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`           | :ref:`line_separation<class_RichTextLabel_theme_constant_line_separation>`                | ``0``                       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`           | :ref:`outline_size<class_RichTextLabel_theme_constant_outline_size>`                      | ``0``                       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`           | :ref:`shadow_offset_x<class_RichTextLabel_theme_constant_shadow_offset_x>`                | ``1``                       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`           | :ref:`shadow_offset_y<class_RichTextLabel_theme_constant_shadow_offset_y>`                | ``1``                       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`           | :ref:`shadow_outline_size<class_RichTextLabel_theme_constant_shadow_outline_size>`        | ``1``                       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`           | :ref:`table_hseparation<class_RichTextLabel_theme_constant_table_hseparation>`            | ``3``                       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`           | :ref:`table_vseparation<class_RichTextLabel_theme_constant_table_vseparation>`            | ``3``                       |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Font<class_Font>`         | :ref:`bold_font<class_RichTextLabel_theme_font_bold_font>`                                |                             |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Font<class_Font>`         | :ref:`bold_italics_font<class_RichTextLabel_theme_font_bold_italics_font>`                |                             |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Font<class_Font>`         | :ref:`italics_font<class_RichTextLabel_theme_font_italics_font>`                          |                             |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Font<class_Font>`         | :ref:`mono_font<class_RichTextLabel_theme_font_mono_font>`                                |                             |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Font<class_Font>`         | :ref:`normal_font<class_RichTextLabel_theme_font_normal_font>`                            |                             |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`           | :ref:`bold_font_size<class_RichTextLabel_theme_font_size_bold_font_size>`                 |                             |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`           | :ref:`bold_italics_font_size<class_RichTextLabel_theme_font_size_bold_italics_font_size>` |                             |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`           | :ref:`italics_font_size<class_RichTextLabel_theme_font_size_italics_font_size>`           |                             |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`           | :ref:`mono_font_size<class_RichTextLabel_theme_font_size_mono_font_size>`                 |                             |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`           | :ref:`normal_font_size<class_RichTextLabel_theme_font_size_normal_font_size>`             |                             |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_RichTextLabel_theme_style_focus>`                                       |                             |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_RichTextLabel_theme_style_normal>`                                     |                             |
+---------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+

Signals
-------

.. _class_RichTextLabel_signal_meta_clicked:

- **meta_clicked** **(** :ref:`Variant<class_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 :ref:`String<class_String>` type. If a particular type or an object is desired, the :ref:`push_meta<class_RichTextLabel_method_push_meta>` method must be used to manually insert the data into the tag stack.

----

.. _class_RichTextLabel_signal_meta_hover_ended:

- **meta_hover_ended** **(** :ref:`Variant<class_Variant>` meta **)**

Triggers when the mouse exits a meta tag.

----

.. _class_RichTextLabel_signal_meta_hover_started:

- **meta_hover_started** **(** :ref:`Variant<class_Variant>` meta **)**

Triggers when the mouse enters a meta tag.

Enumerations
------------

.. _enum_RichTextLabel_AutowrapMode:

.. _class_RichTextLabel_constant_AUTOWRAP_OFF:

.. _class_RichTextLabel_constant_AUTOWRAP_ARBITRARY:

.. _class_RichTextLabel_constant_AUTOWRAP_WORD:

.. _class_RichTextLabel_constant_AUTOWRAP_WORD_SMART:

enum **AutowrapMode**:

- **AUTOWRAP_OFF** = **0** --- Autowrap is disabled.

- **AUTOWRAP_ARBITRARY** = **1** --- Wraps the text inside the node's bounding rectangle by allowing to break lines at arbitrary positions, which is useful when very limited space is available.

- **AUTOWRAP_WORD** = **2** --- Wraps the text inside the node's bounding rectangle by soft-breaking between words.

- **AUTOWRAP_WORD_SMART** = **3** --- Behaves similarly to :ref:`AUTOWRAP_WORD<class_RichTextLabel_constant_AUTOWRAP_WORD>`, but force-breaks a word if that single word does not fit in one line.

----

.. _enum_RichTextLabel_ListType:

.. _class_RichTextLabel_constant_LIST_NUMBERS:

.. _class_RichTextLabel_constant_LIST_LETTERS:

.. _class_RichTextLabel_constant_LIST_ROMAN:

.. _class_RichTextLabel_constant_LIST_DOTS:

enum **ListType**:

- **LIST_NUMBERS** = **0** --- Each list item has a number marker.

- **LIST_LETTERS** = **1** --- Each list item has a letter marker.

- **LIST_ROMAN** = **2** --- Each list item has a roman number marker.

- **LIST_DOTS** = **3** --- Each list item has a filled circle marker.

----

.. _enum_RichTextLabel_ItemType:

.. _class_RichTextLabel_constant_ITEM_FRAME:

.. _class_RichTextLabel_constant_ITEM_TEXT:

.. _class_RichTextLabel_constant_ITEM_IMAGE:

.. _class_RichTextLabel_constant_ITEM_NEWLINE:

.. _class_RichTextLabel_constant_ITEM_FONT:

.. _class_RichTextLabel_constant_ITEM_FONT_SIZE:

.. _class_RichTextLabel_constant_ITEM_FONT_FEATURES:

.. _class_RichTextLabel_constant_ITEM_COLOR:

.. _class_RichTextLabel_constant_ITEM_OUTLINE_SIZE:

.. _class_RichTextLabel_constant_ITEM_OUTLINE_COLOR:

.. _class_RichTextLabel_constant_ITEM_UNDERLINE:

.. _class_RichTextLabel_constant_ITEM_STRIKETHROUGH:

.. _class_RichTextLabel_constant_ITEM_PARAGRAPH:

.. _class_RichTextLabel_constant_ITEM_INDENT:

.. _class_RichTextLabel_constant_ITEM_LIST:

.. _class_RichTextLabel_constant_ITEM_TABLE:

.. _class_RichTextLabel_constant_ITEM_FADE:

.. _class_RichTextLabel_constant_ITEM_SHAKE:

.. _class_RichTextLabel_constant_ITEM_WAVE:

.. _class_RichTextLabel_constant_ITEM_TORNADO:

.. _class_RichTextLabel_constant_ITEM_RAINBOW:

.. _class_RichTextLabel_constant_ITEM_BGCOLOR:

.. _class_RichTextLabel_constant_ITEM_FGCOLOR:

.. _class_RichTextLabel_constant_ITEM_META:

.. _class_RichTextLabel_constant_ITEM_DROPCAP:

.. _class_RichTextLabel_constant_ITEM_CUSTOMFX:

enum **ItemType**:

- **ITEM_FRAME** = **0**

- **ITEM_TEXT** = **1**

- **ITEM_IMAGE** = **2**

- **ITEM_NEWLINE** = **3**

- **ITEM_FONT** = **4**

- **ITEM_FONT_SIZE** = **5**

- **ITEM_FONT_FEATURES** = **6**

- **ITEM_COLOR** = **7**

- **ITEM_OUTLINE_SIZE** = **8**

- **ITEM_OUTLINE_COLOR** = **9**

- **ITEM_UNDERLINE** = **10**

- **ITEM_STRIKETHROUGH** = **11**

- **ITEM_PARAGRAPH** = **12**

- **ITEM_INDENT** = **13**

- **ITEM_LIST** = **14**

- **ITEM_TABLE** = **15**

- **ITEM_FADE** = **16**

- **ITEM_SHAKE** = **17**

- **ITEM_WAVE** = **18**

- **ITEM_TORNADO** = **19**

- **ITEM_RAINBOW** = **20**

- **ITEM_BGCOLOR** = **21**

- **ITEM_FGCOLOR** = **22**

- **ITEM_META** = **23**

- **ITEM_DROPCAP** = **24**

- **ITEM_CUSTOMFX** = **25**

----

.. _enum_RichTextLabel_VisibleCharactersBehavior:

.. _class_RichTextLabel_constant_VC_CHARS_BEFORE_SHAPING:

.. _class_RichTextLabel_constant_VC_CHARS_AFTER_SHAPING:

.. _class_RichTextLabel_constant_VC_GLYPHS_AUTO:

.. _class_RichTextLabel_constant_VC_GLYPHS_LTR:

.. _class_RichTextLabel_constant_VC_GLYPHS_RTL:

enum **VisibleCharactersBehavior**:

- **VC_CHARS_BEFORE_SHAPING** = **0** --- Trims text before the shaping. e.g, increasing :ref:`visible_characters<class_RichTextLabel_property_visible_characters>` value is visually identical to typing the text.

- **VC_CHARS_AFTER_SHAPING** = **1** --- Displays glyphs that are mapped to the first :ref:`visible_characters<class_RichTextLabel_property_visible_characters>` characters from the beginning of the text.

- **VC_GLYPHS_AUTO** = **2** --- Displays :ref:`percent_visible<class_RichTextLabel_property_percent_visible>` glyphs, starting from the left or from the right, depending on :ref:`Control.layout_direction<class_Control_property_layout_direction>` value.

- **VC_GLYPHS_LTR** = **3** --- Displays :ref:`percent_visible<class_RichTextLabel_property_percent_visible>` glyphs, starting from the left.

- **VC_GLYPHS_RTL** = **4** --- Displays :ref:`percent_visible<class_RichTextLabel_property_percent_visible>` glyphs, starting from the right.

Property Descriptions
---------------------

.. _class_RichTextLabel_property_autowrap_mode:

- :ref:`AutowrapMode<enum_RichTextLabel_AutowrapMode>` **autowrap_mode**

+-----------+--------------------------+
| *Default* | ``3``                    |
+-----------+--------------------------+
| *Setter*  | set_autowrap_mode(value) |
+-----------+--------------------------+
| *Getter*  | get_autowrap_mode()      |
+-----------+--------------------------+

If set to something other than :ref:`AUTOWRAP_OFF<class_RichTextLabel_constant_AUTOWRAP_OFF>`, the text gets wrapped inside the node's bounding rectangle. To see how each mode behaves, see :ref:`AutowrapMode<enum_RichTextLabel_AutowrapMode>`.

----

.. _class_RichTextLabel_property_bbcode_enabled:

- :ref:`bool<class_bool>` **bbcode_enabled**

+-----------+-----------------------+
| *Default* | ``false``             |
+-----------+-----------------------+
| *Setter*  | set_use_bbcode(value) |
+-----------+-----------------------+
| *Getter*  | is_using_bbcode()     |
+-----------+-----------------------+

If ``true``, the label uses BBCode formatting.

----

.. _class_RichTextLabel_property_custom_effects:

- :ref:`Array<class_Array>` **custom_effects**

+-----------+--------------------+
| *Default* | ``[]``             |
+-----------+--------------------+
| *Setter*  | set_effects(value) |
+-----------+--------------------+
| *Getter*  | get_effects()      |
+-----------+--------------------+

The currently installed custom effects. This is an array of :ref:`RichTextEffect<class_RichTextEffect>`\ s.

To add a custom effect, it's more convenient to use :ref:`install_effect<class_RichTextLabel_method_install_effect>`.

----

.. _class_RichTextLabel_property_deselect_on_focus_loss_enabled:

- :ref:`bool<class_bool>` **deselect_on_focus_loss_enabled**

+-----------+-------------------------------------------+
| *Default* | ``true``                                  |
+-----------+-------------------------------------------+
| *Setter*  | set_deselect_on_focus_loss_enabled(value) |
+-----------+-------------------------------------------+
| *Getter*  | is_deselect_on_focus_loss_enabled()       |
+-----------+-------------------------------------------+

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

----

.. _class_RichTextLabel_property_fit_content_height:

- :ref:`bool<class_bool>` **fit_content_height**

+-----------+---------------------------------+
| *Default* | ``false``                       |
+-----------+---------------------------------+
| *Setter*  | set_fit_content_height(value)   |
+-----------+---------------------------------+
| *Getter*  | is_fit_content_height_enabled() |
+-----------+---------------------------------+

If ``true``, the label's height will be automatically updated to fit its content.

\ **Note:** This property is used as a workaround to fix issues with ``RichTextLabel`` in :ref:`Container<class_Container>`\ s, but it's unreliable in some cases and will be removed in future versions.

----

.. _class_RichTextLabel_property_language:

- :ref:`String<class_String>` **language**

+-----------+---------------------+
| *Default* | ``""``              |
+-----------+---------------------+
| *Setter*  | set_language(value) |
+-----------+---------------------+
| *Getter*  | get_language()      |
+-----------+---------------------+

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

----

.. _class_RichTextLabel_property_meta_underlined:

- :ref:`bool<class_bool>` **meta_underlined**

+-----------+---------------------------+
| *Default* | ``true``                  |
+-----------+---------------------------+
| *Setter*  | set_meta_underline(value) |
+-----------+---------------------------+
| *Getter*  | is_meta_underlined()      |
+-----------+---------------------------+

If ``true``, the label underlines meta tags such as ``[url]{text}[/url]``.

----

.. _class_RichTextLabel_property_override_selected_font_color:

- :ref:`bool<class_bool>` **override_selected_font_color**

+-----------+-----------------------------------------+
| *Default* | ``false``                               |
+-----------+-----------------------------------------+
| *Setter*  | set_override_selected_font_color(value) |
+-----------+-----------------------------------------+
| *Getter*  | is_overriding_selected_font_color()     |
+-----------+-----------------------------------------+

If ``true``, the label uses the custom font color.

----

.. _class_RichTextLabel_property_percent_visible:

- :ref:`float<class_float>` **percent_visible**

+-----------+----------------------------+
| *Default* | ``1.0``                    |
+-----------+----------------------------+
| *Setter*  | set_percent_visible(value) |
+-----------+----------------------------+
| *Getter*  | get_percent_visible()      |
+-----------+----------------------------+

The range of characters to display, as a :ref:`float<class_float>` between 0.0 and 1.0. When assigned an out of range value, it's the same as assigning 1.0.

\ **Note:** Setting this property updates :ref:`visible_characters<class_RichTextLabel_property_visible_characters>` based on current :ref:`get_total_character_count<class_RichTextLabel_method_get_total_character_count>`.

----

.. _class_RichTextLabel_property_scroll_active:

- :ref:`bool<class_bool>` **scroll_active**

+-----------+--------------------------+
| *Default* | ``true``                 |
+-----------+--------------------------+
| *Setter*  | set_scroll_active(value) |
+-----------+--------------------------+
| *Getter*  | is_scroll_active()       |
+-----------+--------------------------+

If ``true``, the scrollbar is visible. Setting this to ``false`` does not block scrolling completely. See :ref:`scroll_to_line<class_RichTextLabel_method_scroll_to_line>`.

----

.. _class_RichTextLabel_property_scroll_following:

- :ref:`bool<class_bool>` **scroll_following**

+-----------+--------------------------+
| *Default* | ``false``                |
+-----------+--------------------------+
| *Setter*  | set_scroll_follow(value) |
+-----------+--------------------------+
| *Getter*  | is_scroll_following()    |
+-----------+--------------------------+

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

----

.. _class_RichTextLabel_property_selection_enabled:

- :ref:`bool<class_bool>` **selection_enabled**

+-----------+------------------------------+
| *Default* | ``false``                    |
+-----------+------------------------------+
| *Setter*  | set_selection_enabled(value) |
+-----------+------------------------------+
| *Getter*  | is_selection_enabled()       |
+-----------+------------------------------+

If ``true``, the label allows text selection.

----

.. _class_RichTextLabel_property_structured_text_bidi_override:

- :ref:`StructuredTextParser<enum_Control_StructuredTextParser>` **structured_text_bidi_override**

+-----------+------------------------------------------+
| *Default* | ``0``                                    |
+-----------+------------------------------------------+
| *Setter*  | set_structured_text_bidi_override(value) |
+-----------+------------------------------------------+
| *Getter*  | get_structured_text_bidi_override()      |
+-----------+------------------------------------------+

Set BiDi algorithm override for the structured text.

----

.. _class_RichTextLabel_property_structured_text_bidi_override_options:

- :ref:`Array<class_Array>` **structured_text_bidi_override_options**

+-----------+--------------------------------------------------+
| *Default* | ``[]``                                           |
+-----------+--------------------------------------------------+
| *Setter*  | set_structured_text_bidi_override_options(value) |
+-----------+--------------------------------------------------+
| *Getter*  | get_structured_text_bidi_override_options()      |
+-----------+--------------------------------------------------+

Set additional options for BiDi override.

----

.. _class_RichTextLabel_property_tab_size:

- :ref:`int<class_int>` **tab_size**

+-----------+---------------------+
| *Default* | ``4``               |
+-----------+---------------------+
| *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.

----

.. _class_RichTextLabel_property_text:

- :ref:`String<class_String>` **text**

+-----------+-----------------+
| *Default* | ``""``          |
+-----------+-----------------+
| *Setter*  | set_text(value) |
+-----------+-----------------+
| *Getter*  | 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 :ref:`bbcode_enabled<class_RichTextLabel_property_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 :ref:`append_text<class_RichTextLabel_method_append_text>` for adding text instead, unless you absolutely need to close a tag that was opened in an earlier method call.

----

.. _class_RichTextLabel_property_text_direction:

- :ref:`TextDirection<enum_Control_TextDirection>` **text_direction**

+-----------+---------------------------+
| *Default* | ``0``                     |
+-----------+---------------------------+
| *Setter*  | set_text_direction(value) |
+-----------+---------------------------+
| *Getter*  | get_text_direction()      |
+-----------+---------------------------+

Base text writing direction.

----

.. _class_RichTextLabel_property_visible_characters:

- :ref:`int<class_int>` **visible_characters**

+-----------+-------------------------------+
| *Default* | ``-1``                        |
+-----------+-------------------------------+
| *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 :ref:`percent_visible<class_RichTextLabel_property_percent_visible>` based on current :ref:`get_total_character_count<class_RichTextLabel_method_get_total_character_count>`.

----

.. _class_RichTextLabel_property_visible_characters_behavior:

- :ref:`VisibleCharactersBehavior<enum_RichTextLabel_VisibleCharactersBehavior>` **visible_characters_behavior**

+-----------+----------------------------------------+
| *Default* | ``0``                                  |
+-----------+----------------------------------------+
| *Setter*  | set_visible_characters_behavior(value) |
+-----------+----------------------------------------+
| *Getter*  | get_visible_characters_behavior()      |
+-----------+----------------------------------------+

Sets the clipping behavior when :ref:`visible_characters<class_RichTextLabel_property_visible_characters>` or :ref:`percent_visible<class_RichTextLabel_property_percent_visible>` is set. See :ref:`VisibleCharactersBehavior<enum_RichTextLabel_VisibleCharactersBehavior>` for more info.

Method Descriptions
-------------------

.. _class_RichTextLabel_method_add_image:

- void **add_image** **(** :ref:`Texture2D<class_Texture2D>` image, :ref:`int<class_int>` width=0, :ref:`int<class_int>` height=0, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1), :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` inline_align=5 **)**

Adds an image's opening and closing tags to the tag stack, optionally providing a ``width`` and ``height`` to resize the image and a ``color`` to tint the image.

If ``width`` or ``height`` is set to 0, the image size will be adjusted in order to keep the original aspect ratio.

----

.. _class_RichTextLabel_method_add_text:

- void **add_text** **(** :ref:`String<class_String>` text **)**

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

----

.. _class_RichTextLabel_method_append_text:

- void **append_text** **(** :ref:`String<class_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 :ref:`append_text<class_RichTextLabel_method_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 :ref:`text<class_RichTextLabel_property_text>` instead of using :ref:`append_text<class_RichTextLabel_method_append_text>`.

----

.. _class_RichTextLabel_method_clear:

- void **clear** **(** **)**

Clears the tag stack and sets :ref:`text<class_RichTextLabel_property_text>` to an empty string.

----

.. _class_RichTextLabel_method_get_character_line:

- :ref:`int<class_int>` **get_character_line** **(** :ref:`int<class_int>` character **)**

Returns the line number of the character position provided.

----

.. _class_RichTextLabel_method_get_character_paragraph:

- :ref:`int<class_int>` **get_character_paragraph** **(** :ref:`int<class_int>` character **)**

Returns the paragraph number of the character position provided.

----

.. _class_RichTextLabel_method_get_content_height:

- :ref:`int<class_int>` **get_content_height** **(** **)** |const|

Returns the height of the content.

----

.. _class_RichTextLabel_method_get_content_width:

- :ref:`int<class_int>` **get_content_width** **(** **)** |const|

Returns the width of the content.

----

.. _class_RichTextLabel_method_get_line_count:

- :ref:`int<class_int>` **get_line_count** **(** **)** |const|

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

----

.. _class_RichTextLabel_method_get_line_offset:

- :ref:`float<class_float>` **get_line_offset** **(** :ref:`int<class_int>` line **)**

Returns the vertical offset of the line found at the provided index.

----

.. _class_RichTextLabel_method_get_paragraph_count:

- :ref:`int<class_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.

----

.. _class_RichTextLabel_method_get_paragraph_offset:

- :ref:`float<class_float>` **get_paragraph_offset** **(** :ref:`int<class_int>` paragraph **)**

Returns the vertical offset of the paragraph found at the provided index.

----

.. _class_RichTextLabel_method_get_parsed_text:

- :ref:`String<class_String>` **get_parsed_text** **(** **)** |const|

Returns the text without BBCode mark-up.

----

.. _class_RichTextLabel_method_get_selected_text:

- :ref:`String<class_String>` **get_selected_text** **(** **)** |const|

Returns the current selection text. Does not include BBCodes.

----

.. _class_RichTextLabel_method_get_selection_from:

- :ref:`int<class_int>` **get_selection_from** **(** **)** |const|

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

----

.. _class_RichTextLabel_method_get_selection_to:

- :ref:`int<class_int>` **get_selection_to** **(** **)** |const|

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

----

.. _class_RichTextLabel_method_get_total_character_count:

- :ref:`int<class_int>` **get_total_character_count** **(** **)** |const|

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

----

.. _class_RichTextLabel_method_get_v_scroll_bar:

- :ref:`VScrollBar<class_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 :ref:`CanvasItem.visible<class_CanvasItem_property_visible>` property.

----

.. _class_RichTextLabel_method_get_visible_line_count:

- :ref:`int<class_int>` **get_visible_line_count** **(** **)** |const|

Returns the number of visible lines.

----

.. _class_RichTextLabel_method_get_visible_paragraph_count:

- :ref:`int<class_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.

----

.. _class_RichTextLabel_method_install_effect:

- void **install_effect** **(** :ref:`Variant<class_Variant>` effect **)**

Installs a custom effect. ``effect`` should be a valid :ref:`RichTextEffect<class_RichTextEffect>`.

----

.. _class_RichTextLabel_method_newline:

- void **newline** **(** **)**

Adds a newline tag to the tag stack.

----

.. _class_RichTextLabel_method_parse_bbcode:

- void **parse_bbcode** **(** :ref:`String<class_String>` bbcode **)**

The assignment version of :ref:`append_text<class_RichTextLabel_method_append_text>`. Clears the tag stack and inserts the new content.

----

.. _class_RichTextLabel_method_parse_expressions_for_values:

- :ref:`Dictionary<class_Dictionary>` **parse_expressions_for_values** **(** :ref:`PackedStringArray<class_PackedStringArray>` expressions **)**

Parses BBCode parameter ``expressions`` into a dictionary.

----

.. _class_RichTextLabel_method_pop:

- void **pop** **(** **)**

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

----

.. _class_RichTextLabel_method_push_bgcolor:

- void **push_bgcolor** **(** :ref:`Color<class_Color>` bgcolor **)**

Adds a ``[bgcolor]`` tag to the tag stack.

----

.. _class_RichTextLabel_method_push_bold:

- void **push_bold** **(** **)**

Adds a ``[font]`` tag with a bold font to the tag stack. This is the same as adding a ``[b]`` tag if not currently in a ``[i]`` tag.

----

.. _class_RichTextLabel_method_push_bold_italics:

- void **push_bold_italics** **(** **)**

Adds a ``[font]`` tag with a bold italics font to the tag stack.

----

.. _class_RichTextLabel_method_push_cell:

- void **push_cell** **(** **)**

Adds a ``[cell]`` tag to the tag stack. Must be inside a ``[table]`` tag. See :ref:`push_table<class_RichTextLabel_method_push_table>` for details.

----

.. _class_RichTextLabel_method_push_color:

- void **push_color** **(** :ref:`Color<class_Color>` color **)**

Adds a ``[color]`` tag to the tag stack.

----

.. _class_RichTextLabel_method_push_dropcap:

- void **push_dropcap** **(** :ref:`String<class_String>` string, :ref:`Font<class_Font>` font, :ref:`int<class_int>` size, :ref:`Rect2<class_Rect2>` dropcap_margins=Rect2(0, 0, 0, 0), :ref:`Color<class_Color>` color=Color(1, 1, 1, 1), :ref:`int<class_int>` outline_size=0, :ref:`Color<class_Color>` outline_color=Color(0, 0, 0, 0) **)**

Adds a ``[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.

----

.. _class_RichTextLabel_method_push_fgcolor:

- void **push_fgcolor** **(** :ref:`Color<class_Color>` fgcolor **)**

Adds a ``[fgcolor]`` tag to the tag stack.

----

.. _class_RichTextLabel_method_push_font:

- void **push_font** **(** :ref:`Font<class_Font>` font **)**

Adds a ``[font]`` tag to the tag stack. Overrides default fonts for its duration.

----

.. _class_RichTextLabel_method_push_font_features:

- void **push_font_features** **(** :ref:`Dictionary<class_Dictionary>` opentype_features **)**

Adds a ``[ot_feature]`` tag to the tag stack. Overrides default OpenType font feature for its duration.

----

.. _class_RichTextLabel_method_push_font_size:

- void **push_font_size** **(** :ref:`int<class_int>` font_size **)**

Adds a ``[font_size]`` tag to the tag stack. Overrides default font size for its duration.

----

.. _class_RichTextLabel_method_push_indent:

- void **push_indent** **(** :ref:`int<class_int>` level **)**

Adds an ``[indent]`` tag to the tag stack. Multiplies ``level`` by current :ref:`tab_size<class_RichTextLabel_property_tab_size>` to determine new margin length.

----

.. _class_RichTextLabel_method_push_italics:

- void **push_italics** **(** **)**

Adds a ``[font]`` tag with a italics font to the tag stack. This is the same as adding a ``[i]`` tag if not currently in a ``[b]`` tag.

----

.. _class_RichTextLabel_method_push_list:

- void **push_list** **(** :ref:`int<class_int>` level, :ref:`ListType<enum_RichTextLabel_ListType>` type, :ref:`bool<class_bool>` capitalize **)**

Adds ``[ol]`` or ``[ul]`` tag to the tag stack. Multiplies ``level`` by current :ref:`tab_size<class_RichTextLabel_property_tab_size>` to determine new margin length.

----

.. _class_RichTextLabel_method_push_meta:

- void **push_meta** **(** :ref:`Variant<class_Variant>` data **)**

Adds a ``[meta]`` tag to the tag stack. Similar to the BBCode ``[url=something]{text}[/url]``, but supports non-:ref:`String<class_String>` metadata types.

----

.. _class_RichTextLabel_method_push_mono:

- void **push_mono** **(** **)**

Adds a ``[font]`` tag with a monospace font to the tag stack.

----

.. _class_RichTextLabel_method_push_normal:

- void **push_normal** **(** **)**

Adds a ``[font]`` tag with a normal font to the tag stack.

----

.. _class_RichTextLabel_method_push_outline_color:

- void **push_outline_color** **(** :ref:`Color<class_Color>` color **)**

Adds a ``[outline_color]`` tag to the tag stack. Adds text outline for its duration.

----

.. _class_RichTextLabel_method_push_outline_size:

- void **push_outline_size** **(** :ref:`int<class_int>` outline_size **)**

Adds a ``[outline_size]`` tag to the tag stack. Overrides default text outline size for its duration.

----

.. _class_RichTextLabel_method_push_paragraph:

- void **push_paragraph** **(** :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` alignment, :ref:`TextDirection<enum_Control_TextDirection>` base_direction=0, :ref:`String<class_String>` language="", :ref:`StructuredTextParser<enum_Control_StructuredTextParser>` st_parser=0 **)**

Adds a ``[p]`` tag to the tag stack.

----

.. _class_RichTextLabel_method_push_strikethrough:

- void **push_strikethrough** **(** **)**

Adds a ``[s]`` tag to the tag stack.

----

.. _class_RichTextLabel_method_push_table:

- void **push_table** **(** :ref:`int<class_int>` columns, :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` inline_align=0 **)**

Adds a ``[table=columns,inline_align]`` tag to the tag stack.

----

.. _class_RichTextLabel_method_push_underline:

- void **push_underline** **(** **)**

Adds a ``[u]`` tag to the tag stack.

----

.. _class_RichTextLabel_method_remove_line:

- :ref:`bool<class_bool>` **remove_line** **(** :ref:`int<class_int>` line **)**

Removes a line of content from the label. Returns ``true`` if the line exists.

The ``line`` argument is the index of the line to remove, it can take values in the interval ``[0, get_line_count() - 1]``.

----

.. _class_RichTextLabel_method_scroll_to_line:

- void **scroll_to_line** **(** :ref:`int<class_int>` line **)**

Scrolls the window's top line to match ``line``.

----

.. _class_RichTextLabel_method_scroll_to_paragraph:

- void **scroll_to_paragraph** **(** :ref:`int<class_int>` paragraph **)**

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

----

.. _class_RichTextLabel_method_set_cell_border_color:

- void **set_cell_border_color** **(** :ref:`Color<class_Color>` color **)**

Sets color of a table cell border.

----

.. _class_RichTextLabel_method_set_cell_padding:

- void **set_cell_padding** **(** :ref:`Rect2<class_Rect2>` padding **)**

Sets inner padding of a table cell.

----

.. _class_RichTextLabel_method_set_cell_row_background_color:

- void **set_cell_row_background_color** **(** :ref:`Color<class_Color>` odd_row_bg, :ref:`Color<class_Color>` even_row_bg **)**

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

----

.. _class_RichTextLabel_method_set_cell_size_override:

- void **set_cell_size_override** **(** :ref:`Vector2<class_Vector2>` min_size, :ref:`Vector2<class_Vector2>` max_size **)**

Sets minimum and maximum size overrides for a table cell.

----

.. _class_RichTextLabel_method_set_table_column_expand:

- void **set_table_column_expand** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` expand, :ref:`int<class_int>` ratio **)**

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.

Theme Property Descriptions
---------------------------

.. _class_RichTextLabel_theme_color_default_color:

- :ref:`Color<class_Color>` **default_color**

+-----------+-----------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+

The default text color.

----

.. _class_RichTextLabel_theme_color_font_outline_color:

- :ref:`Color<class_Color>` **font_outline_color**

+-----------+-----------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+

The default tint of text outline.

----

.. _class_RichTextLabel_theme_color_font_selected_color:

- :ref:`Color<class_Color>` **font_selected_color**

+-----------+-----------------------+
| *Default* | ``Color(0, 0, 0, 1)`` |
+-----------+-----------------------+

The color of selected text, used when :ref:`selection_enabled<class_RichTextLabel_property_selection_enabled>` is ``true``.

----

.. _class_RichTextLabel_theme_color_font_shadow_color:

- :ref:`Color<class_Color>` **font_shadow_color**

+-----------+-----------------------+
| *Default* | ``Color(0, 0, 0, 0)`` |
+-----------+-----------------------+

The color of the font's shadow.

----

.. _class_RichTextLabel_theme_color_selection_color:

- :ref:`Color<class_Color>` **selection_color**

+-----------+-----------------------------+
| *Default* | ``Color(0.1, 0.1, 1, 0.8)`` |
+-----------+-----------------------------+

The color of the selection box.

----

.. _class_RichTextLabel_theme_color_table_border:

- :ref:`Color<class_Color>` **table_border**

+-----------+-----------------------+
| *Default* | ``Color(0, 0, 0, 0)`` |
+-----------+-----------------------+

The default cell border color.

----

.. _class_RichTextLabel_theme_color_table_even_row_bg:

- :ref:`Color<class_Color>` **table_even_row_bg**

+-----------+-----------------------+
| *Default* | ``Color(0, 0, 0, 0)`` |
+-----------+-----------------------+

The default background color for even rows.

----

.. _class_RichTextLabel_theme_color_table_odd_row_bg:

- :ref:`Color<class_Color>` **table_odd_row_bg**

+-----------+-----------------------+
| *Default* | ``Color(0, 0, 0, 0)`` |
+-----------+-----------------------+

The default background color for odd rows.

----

.. _class_RichTextLabel_theme_constant_line_separation:

- :ref:`int<class_int>` **line_separation**

+-----------+-------+
| *Default* | ``0`` |
+-----------+-------+

The vertical space between lines.

----

.. _class_RichTextLabel_theme_constant_outline_size:

- :ref:`int<class_int>` **outline_size**

+-----------+-------+
| *Default* | ``0`` |
+-----------+-------+

The size of the text outline.

----

.. _class_RichTextLabel_theme_constant_shadow_offset_x:

- :ref:`int<class_int>` **shadow_offset_x**

+-----------+-------+
| *Default* | ``1`` |
+-----------+-------+

The horizontal offset of the font's shadow.

----

.. _class_RichTextLabel_theme_constant_shadow_offset_y:

- :ref:`int<class_int>` **shadow_offset_y**

+-----------+-------+
| *Default* | ``1`` |
+-----------+-------+

The vertical offset of the font's shadow.

----

.. _class_RichTextLabel_theme_constant_shadow_outline_size:

- :ref:`int<class_int>` **shadow_outline_size**

+-----------+-------+
| *Default* | ``1`` |
+-----------+-------+

The size of the shadow outline.

----

.. _class_RichTextLabel_theme_constant_table_hseparation:

- :ref:`int<class_int>` **table_hseparation**

+-----------+-------+
| *Default* | ``3`` |
+-----------+-------+

The horizontal separation of elements in a table.

----

.. _class_RichTextLabel_theme_constant_table_vseparation:

- :ref:`int<class_int>` **table_vseparation**

+-----------+-------+
| *Default* | ``3`` |
+-----------+-------+

The vertical separation of elements in a table.

----

.. _class_RichTextLabel_theme_font_bold_font:

- :ref:`Font<class_Font>` **bold_font**

The font used for bold text.

----

.. _class_RichTextLabel_theme_font_bold_italics_font:

- :ref:`Font<class_Font>` **bold_italics_font**

The font used for bold italics text.

----

.. _class_RichTextLabel_theme_font_italics_font:

- :ref:`Font<class_Font>` **italics_font**

The font used for italics text.

----

.. _class_RichTextLabel_theme_font_mono_font:

- :ref:`Font<class_Font>` **mono_font**

The font used for monospace text.

----

.. _class_RichTextLabel_theme_font_normal_font:

- :ref:`Font<class_Font>` **normal_font**

The default text font.

----

.. _class_RichTextLabel_theme_font_size_bold_font_size:

- :ref:`int<class_int>` **bold_font_size**

The font size used for bold text.

----

.. _class_RichTextLabel_theme_font_size_bold_italics_font_size:

- :ref:`int<class_int>` **bold_italics_font_size**

The font size used for bold italics text.

----

.. _class_RichTextLabel_theme_font_size_italics_font_size:

- :ref:`int<class_int>` **italics_font_size**

The font size used for italics text.

----

.. _class_RichTextLabel_theme_font_size_mono_font_size:

- :ref:`int<class_int>` **mono_font_size**

The font size used for monospace text.

----

.. _class_RichTextLabel_theme_font_size_normal_font_size:

- :ref:`int<class_int>` **normal_font_size**

The default text font size.

----

.. _class_RichTextLabel_theme_style_focus:

- :ref:`StyleBox<class_StyleBox>` **focus**

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

----

.. _class_RichTextLabel_theme_style_normal:

- :ref:`StyleBox<class_StyleBox>` **normal**

The normal background for the ``RichTextLabel``.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`