CharFXTransform

Inherits: Reference < Object RichTextEffect.

Description

RichTextEffect.

Tutorials

• BBCode in RichTextLabel
• https://github.com/Eoin-ONeill-Yokai/Godot-Rich-Text-Effect-Test-Project

  Properties

  Property Descriptions

• int absolute_index RichTextLabel‘s BBCode text. Setting this property won’t affect drawing.

• int character @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 The color the character will be drawn with.

• float elapsed_time 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 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. [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 The position offset the character will be drawn with (in pixels).

• int relative_index RichTextEffect custom block. Setting this property won’t affect drawing.

• bool visible 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.