Inherits: Resource < RefCounted < Object
A custom effect for a RichTextLabel.
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.
# The RichTextEffect will be usable like this: `[example]Some text[/example]` var bbcode = "example"C#
// 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.
_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.
© 2014–present Juan Linietsky, Ariel Manzur and the Godot community
Licensed under the Creative Commons Attribution Unported License v3.0.
https://docs.godotengine.org/en/4.2/classes/class_richtexteffect.html