Attention: Here be dragons (unstable version)

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Redot.

Checking the stable version of the documentation...

RichTextEffect

Inherits: Resource < RefCounted < Object

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.

# 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.

Tutorials

Methods

bool

_process_custom_fx(char_fx: CharFXTransform) virtual const

Method Descriptions

bool _process_custom_fx(char_fx: CharFXTransform) 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.