Struct RichTextEffect
A custom effect for use with RichTextLabel
.
struct RichTextEffect
;
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: class="pln">D exampleSome textclass="pln">D /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.
Methods
Name | Description |
---|---|
_processCustomFx
|
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.
|