diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-09-23 08:59:14 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-23 08:59:14 +0200 |
| commit | d21b3c26932d5a30edcc731cc3a00721bb721aac (patch) | |
| tree | 897fafb36b3b8ec5a9f918a2a751c86af870c0c2 /doc/classes | |
| parent | e40ba13e59331efe6917b855a9248e2c77b09177 (diff) | |
| parent | 3e1457f51747975599c07c8b6aa25435f12cfa22 (diff) | |
Merge pull request #42217 from Calinou/doc-richtextlabel-append-bbcode-no-close
Document `RichTextLabel.append_bbcode()` not closing previously open tags
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/RichTextLabel.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index dc3c7c7dc0..050f1aab25 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -44,6 +44,7 @@ </argument> <description> Parses [code]bbcode[/code] and adds tags to the tag stack as needed. Returns the result of the parsing, [constant OK] if successful. + [b]Note:[/b] Using this method, you can't close a tag that was opened in a previous [method append_bbcode] 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 [member bbcode_text] instead of using [method append_bbcode]. </description> </method> <method name="clear"> @@ -289,7 +290,7 @@ </member> <member name="bbcode_text" type="String" setter="set_bbcode" getter="get_bbcode" default=""""> 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. - [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. + [b]Note:[/b] It is unadvised to use the [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, unless you absolutely need to close a tag that was opened in an earlier method call. </member> <member name="custom_effects" type="Array" setter="set_effects" getter="get_effects" default="[ ]"> The currently installed custom effects. This is an array of [RichTextEffect]s. |