By setting various properties on this object, you can control how individual characters will be displayed in a godot.RichTextEffect
.
Constructor
Variables
absoluteIndex:UInt64
The index of the current character (starting from 0) for the godot.RichTextLabel
's BBCode text. Setting this property won't affect drawing.
character:Int
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("*")
elapsedTime:Single
The time elapsed since the godot.RichTextLabel
was added to the scene tree (in seconds). Time stops when the godot.RichTextLabel
is paused (see godot.Node.pauseMode
). Resets when the text in the godot.RichTextLabel
is changed.
Note: Time still passes while the godot.RichTextLabel
is hidden.
env:Dictionary
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 Single
, they will be converted automatically. Color codes in the form #rrggbb
or #rgb
will be converted to an opaque godot.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 godot.Collections_Dictionary
:
{"foo": "hello", "bar": true, "baz": 42, "color": Color(1, 1, 1, 1)}
relativeIndex:UInt64
The index of the current character (starting from 0) for this godot.RichTextEffect
custom block. Setting this property won't affect drawing.
visible:Bool
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 godot.CharFXTransform.color
to Color(1, 1, 1, 0)
instead.