Class RichTextEffect

A custom effect for a RichTextLabel.

Inheritance

Resource

RefCounted

Object

RichTextEffect

Remarks

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
• C#

# The RichTextEffect will be usable like this: `[example]Some text[/example]`
var 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.

See Also

BBCode in RichTextLabel

RichTextEffect test project (third-party)

Methods

_process_custom_fx(CharFXTransform)

Qualifiers: virtualconst

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.

bool _process_custom_fx(CharFXTransform char_fx)

Parameters

char_fx CharFXTransform