Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

CharFXTransform

Inherits: RefCounted < Object

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

Color

color

Color(0, 0, 0, 1)

float

elapsed_time

0.0

Dictionary

env

{}

RID

font

RID()

int

glyph_count

0

int

glyph_flags

0

int

glyph_index

0

Vector2

offset

Vector2(0, 0)

bool

outline

false

Vector2i

range

Vector2i(0, 0)

int

relative_index

0

Transform2D

transform

Transform2D(1, 0, 0, 1, 0, 0)

bool

visible

true


Property Descriptions

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.process_mode). Resets when the text in the RichTextLabel is changed.

Note: Time still passes while the RichTextLabel is hidden.


Dictionary env = {}

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)}

RID font = RID()

  • void set_font ( RID value )

  • RID get_font ( )

Font resource used to render glyph.


int glyph_count = 0

  • void set_glyph_count ( int