Table of Contents

Class RichTextEffect

Namespace
Godot
Assembly
GodotSharp.dll

A custom effect for a RichTextLabel, which can be loaded in the RichTextLabel inspector or using InstallEffect(Variant).

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]`
  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.

public class RichTextEffect : Resource, IDisposable
Inheritance
RichTextEffect
Implements
Inherited Members

Constructors

RichTextEffect() 

public RichTextEffect()

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

_ProcessCustomFX(CharFXTransform)

Override this method to modify properties in charFX. 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.

public virtual bool _ProcessCustomFX(CharFXTransform charFX)

Parameters

charFX CharFXTransform

Returns

bool
Edit this page