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.

Properties

Color

color

Color(0, 0, 0, 1)

float

elapsed_time

0.0

Dictionary

env

{}

RID

font

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)

bool

visible

true

Property Descriptions

Default

Color(0, 0, 0, 1)

Setter

set_color(value)

Getter

get_color()

The color the character will be drawn with.


Default

0.0

Setter

set_elapsed_time(value)

Getter

get_elapsed_time()

The time elapsed since the RichTextLabel was added to the scene tree (in seconds). Time stops when the project is paused depending on the value of the RichTextLabel's Node.process_mode.

Note: Time still passes while the RichTextLabel is hidden.


Default

{}

Setter

set_environment(value)

Getter

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

Setter

set_font(value)

Getter

get_font()

Font resource used to render glyph.


  • int glyph_count

Default

0

Setter

set_glyph_count(value)

Getter

get_glyph_count()

Number of glyphs in the grapheme cluster. This value is set in the first glyph of a cluster. Setting this property won't affect drawing.


  • int glyph_flags

Default

0

Setter

set_glyph_flags(value)

Getter

get_glyph_flags()

Glyph flags. See GraphemeFlag for more info. Setting this property won't affect drawing.


  • int glyph_index

Default

0

Setter

set_glyph_index(value)

Getter

get_glyph_index()

Font specific glyph index.


Default

Vector2(0, 0)

Setter

set_offset(value)

Getter

get_offset()

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


Default

false

Setter

set_outline(value)

Getter

is_outline()

If true, FX transform is called for outline drawing. Setting this property won't affect drawing.


Default

Vector2i(0, 0)

Setter

set_range(value)

Getter

get_range()

Absolute character range in the string, corresponding to the glyph. Setting this property won't affect drawing.


Default

true

Setter

set_visibility(value)

Getter

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.