RichTextEffect

继承: 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"

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

方法

bool_process_custom_fx ( char_fx: CharFXTransform ) virtual1 const2

方法说明

bool _process_custom_fx ( char_fx: CharFXTransform ) virtual1 const2

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.

1

本方法通常需要用户覆盖才能生效。

2

本方法无副作用,不会修改该实例的任何成员变量。

3

本方法除了能接受在此处描述的参数外,还能够继续接受任意数量的参数。

4

本方法用于构造某个类型。

5

调用本方法无需实例,可直接使用类名进行调用。

6

本方法描述的是使用本类型作为左操作数的有效运算符。

7

这个值是由下列位标志构成位掩码的整数。

8

无返回值。