You've already forked godot
mirror of
https://github.com/godotengine/godot.git
synced 2025-11-12 13:20:55 +00:00
f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
31 lines
1.4 KiB
XML
31 lines
1.4 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="RichTextEffect" inherits="Resource" version="3.4">
|
|
<brief_description>
|
|
A custom effect for use with [RichTextLabel].
|
|
</brief_description>
|
|
<description>
|
|
A custom effect for use with [RichTextLabel].
|
|
[b]Note:[/b] For a [RichTextEffect] to be usable, a BBCode tag must be defined as a member variable called [code]bbcode[/code] in the script.
|
|
[codeblock]
|
|
# The RichTextEffect will be usable like this: `[example]Some text[/example]`
|
|
var bbcode = "example"
|
|
[/codeblock]
|
|
[b]Note:[/b] As soon as a [RichTextLabel] contains at least one [RichTextEffect], it will continuously process the effect unless the project is paused. This may impact battery life negatively.
|
|
</description>
|
|
<tutorials>
|
|
<link>https://docs.godotengine.org/en/3.3/tutorials/gui/bbcode_in_richtextlabel.html</link>
|
|
<link>https://github.com/Eoin-ONeill-Yokai/Godot-Rich-Text-Effect-Test-Project</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="_process_custom_fx" qualifiers="virtual">
|
|
<return type="bool" />
|
|
<argument index="0" name="char_fx" type="CharFXTransform" />
|
|
<description>
|
|
Override this method to modify properties in [code]char_fx[/code]. The method must return [code]true[/code] if the character could be transformed successfully. If the method returns [code]false[/code], it will skip transformation to avoid displaying broken text.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|