From 3deb209105220db292b5dff8e459589ee0c52b57 Mon Sep 17 00:00:00 2001 From: Haoyu Qiu Date: Mon, 6 Jan 2020 13:33:53 +0800 Subject: Completes the RichTextLabel documentation --- doc/classes/RichTextLabel.xml | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 2567b64c03..0e53490681 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -91,6 +91,7 @@ + Installs a custom effect. [code]effect[/code] should be a valid [RichTextEffect]. @@ -115,6 +116,7 @@ + Parses BBCode parameter [code]expressions[/code] into a dictionary. @@ -137,12 +139,14 @@ + Adds a [code][font][/code] tag with a bold font to the tag stack. This is the same as adding a [code][b][/code] tag if not currently in a [code][i][/code] tag. + Adds a [code][font][/code] tag with a bold italics font to the tag stack. @@ -176,13 +180,14 @@ - Adds an [code][indent][/code] tag to the tag stack. Multiplies "level" by current tab_size to determine new margin length. + Adds an [code][indent][/code] tag to the tag stack. Multiplies [code]level[/code] by current [member tab_size] to determine new margin length. + Adds a [code][font][/code] tag with a italics font to the tag stack. This is the same as adding a [code][i][/code] tag if not currently in a [code][b][/code] tag. @@ -207,12 +212,14 @@ + Adds a [code][font][/code] tag with a monospace font to the tag stack. + Adds a [code][font][/code] tag with a normal font to the tag stack. @@ -244,7 +251,7 @@ - Removes a line of content from the label. Returns [code]true[/code] if the line exists. + Removes the [code]line[/code]th line of content from the label. Returns [code]true[/code] if the line exists. @@ -281,6 +288,8 @@ [b]Note:[/b] It is unadvised to use [code]+=[/code] operator with [code]bbcode_text[/code] (e.g. [code]bbcode_text += "some string"[/code]) as it replaces the whole text and can cause slowdowns. Use [method append_bbcode] for adding text instead. + The currently installed custom effects. This is an array of [RichTextEffect]s. + To add a custom effect, it's more convenient to use [method install_effect]. If [code]true[/code], the label underlines meta tags such as [code][url]{text}[/url][/code]. @@ -289,11 +298,12 @@ If [code]true[/code], the label uses the custom font color. - The text's visibility, as a [float] between 0.0 and 1.0. + The range of characters to display, as a [float] between 0.0 and 1.0. When assigned an out of range value, it's the same as assigning 1.0. + [b]Note:[/b] Setting this property updates [member visible_characters] based on current [method get_total_character_count]. - If [code]true[/code], the scrollbar is visible. Does not block scrolling completely. See [method scroll_to_line]. + If [code]true[/code], the scrollbar is visible. Setting this to [code]false[/code] does not block scrolling completely. See [method scroll_to_line]. If [code]true[/code], the window scrolls down to display new content automatically. @@ -317,7 +327,7 @@ - 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. + Triggered when the user clicks on content between meta 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. @@ -337,18 +347,25 @@ + Makes text left aligned. + Makes text centered. + Makes text right aligned. + Makes text fill width. + Each list item has a number marker. + Each list item has a letter marker. + Each list item has a filled circle marker. -- cgit v1.2.3