Click or drag to resize

CharFXTransform Properties

The CharFXTransform type exposes the following members.

Properties
  NameDescription
Public propertyAbsoluteIndex

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

Public propertyCharacter

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("*")

Public propertyColor

The color the character will be drawn with.

Public propertyDynamicObject
Gets a new DynamicGodotObject associated with this instance.
(Inherited from Object.)
Public propertyElapsedTime

The time elapsed since the RichTextLabel was added to the scene tree (in seconds). Time stops when the project is paused, unless the RichTextLabel's PauseMode is set to .

Note: Time still passes while the RichTextLabel is hidden.

Public propertyEnv

Contains the arguments passed in the opening BBCode tag. By default, arguments are strings; if their contents match a type such as Boolean, Int32 or Single, 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)}

Public propertyNativeInstance (Inherited from Object.)
Public propertyOffset

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

Public propertyRelativeIndex

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

Public propertyVisible

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.

Top
See Also