Label that displays rich text.
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 that assignments to [member bbcode_text] clear the tag stack and reconstruct it from the property's contents. Any edits made to [member bbcode_text] will erase previous edits made from other manual sources such as [method append_bbcode] and the [code]push_*[/code] / [method pop] methods.
https://docs.godotengine.org/en/latest/tutorials/gui/bbcode_in_richtextlabel.html
Adds an image's opening and closing tags to the tag stack.
Adds raw non-bbcode-parsed text to the tag stack.
Parses [code]bbcode[/code] and adds tags to the tag stack as needed. Returns the result of the parsing, [code]OK[/code] if successful.
Clears the tag stack and sets [member bbcode_text] to an empty string.
Returns the height of the content.
Returns the total number of newlines in the tag stack's text tags. Considers wrapped text as one line.
Returns the total number of characters from text tags. Does not include bbcodes.
Returns the vertical scrollbar.
Returns the number of visible lines.
Adds a newline tag to the tag stack.
The assignment version of [method append_bbcode]. Clears the tag stack and inserts the new content. Returns [code]OK[/code] if parses [code]bbcode[/code] successfully.
Terminates the current tag. Use after [code]push_*[/code] methods to close bbcodes manually. Does not need to follow [code]add_*[/code] methods.
Adds an alignment tag based on the given [code]align[/code] value. See [enum Align] for possible values.
Adds a [code][cell][/code] tag to the tag stack. Must be inside a [code][table][/code] tag. See [method push_table] for details.
Adds a [code][color][/code] tag to the tag stack.
Adds a [code][font][/code] tag to the tag stack. Overrides default fonts for its duration.
Adds an [code][indent][/code] tag to the tag stack. Multiplies "level" by current tab_size to determine new margin length.
Adds a list tag to the tag stack. Similar to the bbcodes [code][ol][/code] or [code][ul][/code], but supports more list types. Not fully implemented!
Adds a meta tag to the tag stack. Similar to the bbcode [code][url=something]{text}[/url][/code], but supports non-[String] metadata types.
Adds a [code][s][/code] tag to the tag stack.
Adds a [code][table=columns][/code] tag to the tag stack.
Adds a [code][u][/code] tag to the tag stack.
Removes a line of content from the label. Returns [code]true[/code] if the line exists.
Scrolls the window's top line to match [code]line[/code].
Edits the selected columns expansion options. If [code]expand[/code] is [code]true[/code], 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. Columns with a [code]false[/code] expand will not contribute to the total ratio.
- If [code]true[/code], the label uses BBCode formatting. Default value: [code]false[/code].
- 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.
- If [code]true[/code], the label underlines meta tags such as [code][url]{text}[/url][/code]. Default value: [code]true[/code].
- If [code]true[/code], the label uses the custom font color. Default value: [code]false[/code].
- The text's visibility, as a [float] between 0.0 and 1.0.
- If [code]true[/code], the scrollbar is visible. Does not block scrolling completely. See [method scroll_to_line]. Default value: [code]true[/code].
- If [code]true[/code], the window scrolls down to display new content automatically. Default value: [code]false[/code].
- If [code]true[/code], the label allows text selection.
- The number of spaces associated with a single tab length. Does not affect "\t" in text tags, only indent tags.
- The raw text of the label. When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify [member bbcode_text].
- The restricted number of characters to display in the label.
Triggered when the user clicks on content between [code][url][/code] tags. If the meta is defined in text, e.g. [code][url={"data"="hi"}]hi[/url][/code], then the parameter for this signal will be a [String] type. If a particular type or an object is desired, the [method push_meta] method must be used to manually insert the data into the tag stack.
Triggers when the mouse exits a meta tag.
Triggers when the mouse enters a meta tag.