CharFXTransform¶

Controls how an individual character will be displayed in a RichTextEffect.

Description¶

By setting various properties on this object, you can control how individual characters will be displayed in a RichTextEffect.

Tutorials¶

Properties¶

int	absolute_index	`0`
int	character	`0`
Color	color	`Color( 0, 0, 0, 1 )`
float	elapsed_time	`0.0`
Dictionary	env	`{}`
Vector2	offset	`Vector2( 0, 0 )`
int	relative_index	`0`
bool	visible	`true`

Property Descriptions¶

int absolute_index = 0

void set_absolute_index ( int value )
int get_absolute_index ( )

The index of the current character (starting from 0) for the RichTextLabel's BBCode text. Setting this property won't affect drawing.

int character = 0

void set_character ( int value )
int get_character ( )

The Unicode codepoint the character will use. This only affects non-whitespace characters. @GDScript.ord can be useful here. For example, the following will replace all characters with asterisks:

# `char_fx` is the CharFXTransform parameter from `_process_custom_fx()`.
# See the RichTextEffect documentation for details.
char_fx.character = ord("*")

Color color = Color( 0, 0, 0, 1 )

void set_color ( Color value )
Color get_color ( )

The color the character will be drawn with.

float elapsed_time = 0.0

void set_elapsed_time ( float value )
float get_elapsed_time ( )

The time elapsed since the RichTextLabel was added to the scene tree (in seconds). Time stops when the RichTextLabel is paused (see Node.pause_mode). Resets when the text in the RichTextLabel is changed.

Note: Time still passes while the RichTextLabel is hidden.

Dictionary env = {}

void set_environment ( Dictionary value )
Dictionary get_environment ( )

Contains the arguments passed in the opening BBCode tag. By default, arguments are strings; if their contents match a type such as bool, int or float, they will be converted automatically. Color codes in the form #rrggbb or #rgb will be converted to an opaque Color. String arguments may not contain spaces, even if they're quoted. If present, quotes will also be present in the final string.

For example, the opening BBCode tag [example foo=hello bar=true baz=42 color=#ffffff] will map to the following Dictionary:

{"foo": "hello", "bar": true, "baz": 42, "color": Color(1, 1, 1, 1)}

Vector2 offset = Vector2( 0, 0 )

void set_offset ( Vector2 value )
Vector2 get_offset ( )

The position offset the character will be drawn with (in pixels).

int relative_index = 0

void set_relative_index ( int value )
int get_relative_index ( )

The index of the current character (starting from 0) for this RichTextEffect custom block. Setting this property won't affect drawing.

bool visible = true

void set_visibility ( bool value )
bool is_visible ( )

If true, the character will be drawn. If false, the character will be hidden. Characters around hidden characters will reflow to take the space of hidden characters. If this is not desired, set their color to Color(1, 1, 1, 0) instead.