RichTextEffect¶
Inherits: Resource < RefCounted < Object
A custom effect for a RichTextLabel.
Description¶
A custom effect for a RichTextLabel.
Note: For a RichTextEffect to be usable, a BBCode tag must be defined as a member variable called bbcode in the script.
# The RichTextEffect will be usable like this: `[example]Some text[/example]`
var bbcode = "example"
// The RichTextEffect will be usable like this: `[example]Some text[/example]`
string bbcode = "example";
Note: 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.
Tutorials¶
Methods¶
_process_custom_fx ( CharFXTransform char_fx ) virtual const |
Method Descriptions¶
bool _process_custom_fx ( CharFXTransform char_fx ) virtual const
Override this method to modify properties in char_fx. The method must return true if the character could be transformed successfully. If the method returns false, it will skip transformation to avoid displaying broken text.