Class reference
RichTextEffect
Inherits Resource
A custom effect for a RichTextLabel.
Description
A custom effect for a RichTextLabel, which can be loaded in the RichTextLabel inspector or using RichTextLabel.install_effect(). Note: For a RichTextEffect to be usable, a BBCode tag must be defined as a member variable called bbcode in the script.
[gdscript skip-lint]
# The RichTextEffect will be usable like this: `[example]Some text[/example]`
var bbcode = "example"
[/gdscript]
[csharp skip-lint]
// The RichTextEffect will be usable like this: `[example]Some text[/example]`
string bbcode = "example";
[/csharp]
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.
Methods
bool _process_custom_fx(CharFXTransform char_fx) virtual const
bool _process_custom_fx(CharFXTransform char_fx) virtual constOverride 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.