class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectNodeCanvasItemControl RichTextLabel
A control for displaying text that can contain different font styles, images, and basic formatting.

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

 Signal finished<>():Signal

Triggered when the document is fully loaded.

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

 Signal meta_clicked<>( Variant meta=, meta:Variant=, ):Signal

Triggered when the user clicks on content between meta (URL) tags. If the meta is defined in BBCode, e.g. [url={"key": "value"}]Text[/url], then the parameter for this signal will always be a String type. If a particular type or an object is desired, the push_meta() method must be used to manually insert the data into the tag stack. Alternatively, you can convert the String input to the desired type based on its contents (such as calling JSON.parse() on it).

For example, the following method can be connected to meta_clicked to open clicked URLs using the user's default web browser:

# This assumes RichTextLabel's `meta_clicked` signal was connected to # the function below using the signal connection dialog. func _richtextlabel_on_meta_clicked(meta): # `meta` is of Variant type, so convert it to a String to avoid script errors at run-time. OS.shell_open(str(meta))
Signal meta_hover_ended<>( Variant meta=, meta:Variant=, ):Signal

Triggers when the mouse exits a meta tag.

 Signal meta_hover_started<>( Variant meta=, meta:Variant=, ):Signal

Triggers when the mouse enters a meta tag.

 Enum ListType<>():Enum

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 MenuItems<>():Enum

MENU_COPY = 0

Copies the selected text.


MENU_SELECT_ALL = 1

Selects the whole RichTextLabel text.


MENU_MAX = 2

Represents the size of the MenuItems enum.

 Enum MetaUnderline<>():Enum

META_UNDERLINE_NEVER = 0

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


META_UNDERLINE_ALWAYS = 1

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


META_UNDERLINE_ON_HOVER = 2

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

 Enum ImageUpdateMask<>():Enum

UPDATE_TEXTURE = 1

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


UPDATE_SIZE = 2

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


UPDATE_COLOR = 4

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


UPDATE_ALIGNMENT = 8

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


UPDATE_REGION = 16

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


UPDATE_PAD = 32

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


UPDATE_TOOLTIP = 64

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


UPDATE_WIDTH_IN_PERCENT = 128

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

 AutowrapMode autowrap_mode<>():AutowrapMode

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

 bool bbcode_enabled<>():bool

If true, the label uses BBCode formatting.

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

 bool context_menu_enabled<>():bool

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

 Array custom_effects<>():Array

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

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

 bool deselect_on_focus_loss_enabled<>():bool

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

 bool drag_and_drop_selection_enabled<>():bool

If true, allow drag and drop of selected text.

 bool fit_content<>():bool

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

 bool hint_underlined<>():bool

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

 HorizontalAlignment horizontal_alignment<>():HorizontalAlignment

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

 BitField justification_flags<>():BitField

Line fill alignment rules. See JustificationFlag for more information.

 String language<>():String

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

 bool meta_underlined<>():bool

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

 int progress_bar_delay<>():int

The delay after which the loading progress bar is displayed, in milliseconds. Set to -1 to disable progress bar entirely.

Note: Progress bar is displayed only if threaded is enabled.

 bool scroll_active<>():bool

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

 bool scroll_following<>():bool

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

 bool selection_enabled<>():bool

If true, the label allows text selection.

 bool shortcut_keys_enabled<>():bool

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

 StructuredTextParser structured_text_bidi_override<>():StructuredTextParser

Set BiDi algorithm override for the structured text.

 Array structured_text_bidi_override_options<>():Array

Set additional options for BiDi override.

 int tab_size<>():int

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

 PackedFloat32Array tab_stops<>():PackedFloat32Array

Aligns text to the given tab-stops.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedFloat32Array for more details.

 String text<>():String

The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited.

Note: If bbcode_enabled is true, it is unadvised to use the += operator with text (e.g. text += "some string") as it replaces the whole text and can cause slowdowns. It will also erase all BBCode that was added to stack using push_* methods. Use append_text() for adding text instead, unless you absolutely need to close a tag that was opened in an earlier method call.

 TextDirection text_direction<>():TextDirection

Base text writing direction.

 bool threaded<>():bool

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

 VerticalAlignment vertical_alignment<>():VerticalAlignment

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

 int visible_characters<>():int

The number of characters to display. If set to -1, all characters are displayed. This can be useful when animating the text appearing in a dialog box.

Note: Setting this property updates visible_ratio accordingly.

 VisibleCharactersBehavior visible_characters_behavior<>():VisibleCharactersBehavior

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

 float visible_ratio<>():float

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

Note: Setting this property updates visible_characters accordingly.

 void add_image<>( =, :=, =, :=, =, :=, =, :=, ):void

Adds an image's opening and closing tags to the tag stack, optionally providing a width and height to resize the image, a color to tint the image and a region to only use parts of the image.

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

If width and height are not set, but region is, the region's rect will be used.

key is an optional identifier, that can be used to modify the image via update_image().

If pad is set, and the image is smaller than the size specified by width and height, the image padding is added to match the size instead of upscaling.

If size_in_percent is set, width and height values are percentages of the control width instead of pixels.

 void add_text<>( String text=, text:String=, ):void

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

 void append_text<>( String bbcode=, bbcode:String=, ):void

Parses bbcode and adds tags to the tag stack as needed.

Note: Using this method, you can't close a tag that was opened in a previous append_text() call. This is done to improve performance, especially when updating large RichTextLabels since rebuilding the whole BBCode every time would be slower. If you absolutely need to close a tag in a future method call, append the text instead of using append_text().

 void clear<>():void

Clears the tag stack, causing the label to display nothing.

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

 void deselect<>():void

Clears the current selection.

 int get_character_line<>( int character=, character:int=, ):int

Returns the line number of the character position provided. Line and character numbers are both zero-indexed.

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

 int get_character_paragraph<>( int character=, character:int=, ):int

Returns the paragraph number of the character position provided. Paragraph and character numbers are both zero-indexed.

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

 int get_content_height<>():int

Returns the height of the content.

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

 int get_content_width<>():int

Returns the width of the content.

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

 int get_line_count<>():int

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

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

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

 float get_line_offset<>( int line=, line:int=, ):float

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

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

 Vector2i get_line_range<>( int line=, line:int=, ):Vector2i

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

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

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

 PopupMenu get_menu<>():PopupMenu

Returns the PopupMenu of this RichTextLabel. By default, this menu is displayed when right-clicking on the RichTextLabel.

You can add custom menu items or remove standard ones. Make sure your IDs don't conflict with the standard ones (see MenuItems). For example:

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

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their Window.visible property.

 int get_paragraph_count<>():int

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

 float get_paragraph_offset<>( int paragraph=, paragraph:int=, ):float

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

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

 String get_parsed_text<>():String

Returns the text without BBCode mark-up.

 String get_selected_text<>():String

Returns the current selection text. Does not include BBCodes.

 int get_selection_from<>():int

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

 float get_selection_line_offset<>():float

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

 int get_selection_to<>():int

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

 int get_total_character_count<>():int

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

 VScrollBar get_v_scroll_bar<>():VScrollBar

Returns the vertical scrollbar.

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their CanvasItem.visible property.

 int get_visible_line_count<>():int

Returns the number of visible lines.

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

 int get_visible_paragraph_count<>():int

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

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

 void install_effect<>( Variant effect=, effect:Variant=, ):void

Installs a custom effect. This can also be done in the Inspector through the custom_effects property. effect should be a valid RichTextEffect.

Example: With the following script extending from RichTextEffect:

# effect.gd class_name MyCustomEffect extends RichTextEffect var bbcode = "my_custom_effect" # ...

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

# rich_text_label.gd extends RichTextLabel func _ready(): install_effect(MyCustomEffect.new()) # Alternatively, if not using `class_name` in the script that extends RichTextEffect: install_effect(preload("res://effect.gd").new())
bool invalidate_paragraph<>( int paragraph=, paragraph:int=, ):bool

Invalidates paragraph and all subsequent paragraphs cache.

 bool is_finished<>():bool

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

 bool is_menu_visible<>():bool

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

 bool is_ready<>():bool

Deprecated: Use is_finished() instead.

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

 void menu_option<>( int option=, option:int=, ):void

Executes a given action as defined in the MenuItems enum.

 void newline<>():void

Adds a newline tag to the tag stack.

 void parse_bbcode<>( String bbcode=, bbcode:String=, ):void

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

 Dictionary parse_expressions_for_values<>( PackedStringArray expressions=, expressions:PackedStringArray=, ):Dictionary

Parses BBCode parameter expressions into a dictionary.

 void pop<>():void

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

 void pop_all<>():void

Terminates all tags opened by push_* methods.

 void pop_context<>():void

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

 void push_bgcolor<>( Color bgcolor=, bgcolor:Color=, ):void

Adds a [bgcolor] tag to the tag stack.

 void push_bold<>():void

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.

 void push_bold_italics<>():void

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

 void push_cell<>():void

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

 void push_color<>( Color color=, color:Color=, ):void

Adds a [color] tag to the tag stack.

 void push_context<>():void

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

 void push_customfx<>( RichTextEffect effect=, effect:RichTextEffect=, Dictionary env=, env:Dictionary=, ):void

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

 void push_dropcap<>( =, :=, =, :=, =, :=, =, :=, ):void

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.

 void push_fgcolor<>( Color fgcolor=, fgcolor:Color=, ):void

Adds a [fgcolor] tag to the tag stack.

 void push_font<>( Font font=, font:Font=, int font_size=0, font_size:int=0, ):void

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

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

 void push_font_size<>( int font_size=, font_size:int=, ):void

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

 void push_hint<>( String description=, description:String=, ):void

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

 void push_indent<>( int level=, level:int=, ):void

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

 void push_italics<>():void

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

 void push_language<>( String language=, language:String=, ):void

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

 void push_list<>( int level=, level:int=, ListType type=, type:ListType=, bool capitalize=, capitalize:bool=, String bullet="•", bullet:String="•", ):void

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

 void push_meta<>( Variant data=, data:Variant=, MetaUnderline underline_mode=1, underline_mode:MetaUnderline=1, String tooltip="", tooltip:String="", ):void

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

If meta_underlined is true, meta tags display an underline. This behavior can be customized with underline_mode.

Note: Meta tags do nothing by default when clicked. To assign behavior when clicked, connect meta_clicked to a function that is called when the meta tag is clicked.

 void push_mono<>():void

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

 void push_normal<>():void

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

 void push_outline_color<>( Color color=, color:Color=, ):void

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

 void push_outline_size<>( int outline_size=, outline_size:int=, ):void

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

 void push_paragraph<>():void

Adds a [p] tag to the tag stack.

 void push_strikethrough<>():void

Adds a [s] tag to the tag stack.

 void push_table<>( int columns=, columns:int=, InlineAlignment inline_align=0, inline_align:InlineAlignment=0, int align_to_row=-1, align_to_row:int=-1, ):void

Adds a [table=columns,inline_align] tag to the tag stack. Use set_table_column_expand() to set column expansion ratio. Use push_cell() to add cells.

 void push_underline<>():void

Adds a [u] tag to the tag stack.

 bool remove_paragraph<>( int paragraph=, paragraph:int=, bool no_invalidate=false, no_invalidate:bool=false, ):bool

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

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

If no_invalidate is set to true, cache for the subsequent paragraphs is not invalidated. Use it for faster updates if deleted paragraph is fully self-contained (have no unclosed tags), or this call is part of the complex edit operation and invalidate_paragraph() will be called at the end of operation.

 void scroll_to_line<>( int line=, line:int=, ):void

Scrolls the window's top line to match line.

 void scroll_to_paragraph<>( int paragraph=, paragraph:int=, ):void

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

 void scroll_to_selection<>():void

Scrolls to the beginning of the current selection.

 void select_all<>():void

Select all the text.

If selection_enabled is false, no selection will occur.

 void set_cell_border_color<>( Color color=, color:Color=, ):void

Sets color of a table cell border.

 void set_cell_padding<>( Rect2 padding=, padding:Rect2=, ):void

Sets inner padding of a table cell.

 void set_cell_row_background_color<>( Color odd_row_bg=, odd_row_bg:Color=, Color even_row_bg=, even_row_bg:Color=, ):void

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

 void set_cell_size_override<>( Vector2 min_size=, min_size:Vector2=, Vector2 max_size=, max_size:Vector2=, ):void

Sets minimum and maximum size overrides for a table cell.

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

Edits the selected column's expansion options. If expand is true, the column expands in proportion to its expansion ratio versus the other columns' ratios.

For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width would expand 30 and 40 pixels, respectively.

If expand is false, the column will not contribute to the total ratio.

 void update_image<>( =, :=, =, :=, =, :=, =, :=, ):void

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


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...