:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CharFXTransform.xml. .. _class_CharFXTransform: CharFXTransform =============== **Inherits:** :ref:`Reference` **<** :ref:`Object` Controls how an individual character will be displayed in a :ref:`RichTextEffect`. Description ----------- By setting various properties on this object, you can control how individual characters will be displayed in a :ref:`RichTextEffect`. Tutorials --------- - :doc:`../tutorials/ui/bbcode_in_richtextlabel` - `https://github.com/Eoin-ONeill-Yokai/Godot-Rich-Text-Effect-Test-Project `__ Properties ---------- +-------------------------------------+----------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`absolute_index` | ``0`` | +-------------------------------------+----------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`character` | ``0`` | +-------------------------------------+----------------------------------------------------------------------+-------------------------+ | :ref:`Color` | :ref:`color` | ``Color( 0, 0, 0, 1 )`` | +-------------------------------------+----------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`elapsed_time` | ``0.0`` | +-------------------------------------+----------------------------------------------------------------------+-------------------------+ | :ref:`Dictionary` | :ref:`env` | ``{}`` | +-------------------------------------+----------------------------------------------------------------------+-------------------------+ | :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | +-------------------------------------+----------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`relative_index` | ``0`` | +-------------------------------------+----------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`visible` | ``true`` | +-------------------------------------+----------------------------------------------------------------------+-------------------------+ Property Descriptions --------------------- .. _class_CharFXTransform_property_absolute_index: - :ref:`int` **absolute_index** +-----------+---------------------------+ | *Default* | ``0`` | +-----------+---------------------------+ | *Setter* | set_absolute_index(value) | +-----------+---------------------------+ | *Getter* | get_absolute_index() | +-----------+---------------------------+ The index of the current character (starting from 0) for the :ref:`RichTextLabel`'s BBCode text. Setting this property won't affect drawing. ---- .. _class_CharFXTransform_property_character: - :ref:`int` **character** +-----------+----------------------+ | *Default* | ``0`` | +-----------+----------------------+ | *Setter* | set_character(value) | +-----------+----------------------+ | *Getter* | get_character() | +-----------+----------------------+ The Unicode codepoint the character will use. This only affects non-whitespace characters. :ref:`@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("*") ---- .. _class_CharFXTransform_property_color: - :ref:`Color` **color** +-----------+-------------------------+ | *Default* | ``Color( 0, 0, 0, 1 )`` | +-----------+-------------------------+ | *Setter* | set_color(value) | +-----------+-------------------------+ | *Getter* | get_color() | +-----------+-------------------------+ The color the character will be drawn with. ---- .. _class_CharFXTransform_property_elapsed_time: - :ref:`float` **elapsed_time** +-----------+-------------------------+ | *Default* | ``0.0`` | +-----------+-------------------------+ | *Setter* | set_elapsed_time(value) | +-----------+-------------------------+ | *Getter* | get_elapsed_time() | +-----------+-------------------------+ The time elapsed since the :ref:`RichTextLabel` was added to the scene tree (in seconds). Time stops when the :ref:`RichTextLabel` is paused (see :ref:`Node.pause_mode`). Resets when the text in the :ref:`RichTextLabel` is changed. \ **Note:** Time still passes while the :ref:`RichTextLabel` is hidden. ---- .. _class_CharFXTransform_property_env: - :ref:`Dictionary` **env** +-----------+------------------------+ | *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 :ref:`bool`, :ref:`int` or :ref:`float`, they will be converted automatically. Color codes in the form ``#rrggbb`` or ``#rgb`` will be converted to an opaque :ref:`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 :ref:`Dictionary`: :: {"foo": "hello", "bar": true, "baz": 42, "color": Color(1, 1, 1, 1)} ---- .. _class_CharFXTransform_property_offset: - :ref:`Vector2` **offset** +-----------+---------------------+ | *Default* | ``Vector2( 0, 0 )`` | +-----------+---------------------+ | *Setter* | set_offset(value) | +-----------+---------------------+ | *Getter* | get_offset() | +-----------+---------------------+ The position offset the character will be drawn with (in pixels). ---- .. _class_CharFXTransform_property_relative_index: - :ref:`int` **relative_index** +-----------+---------------------------+ | *Default* | ``0`` | +-----------+---------------------------+ | *Setter* | set_relative_index(value) | +-----------+---------------------------+ | *Getter* | get_relative_index() | +-----------+---------------------------+ The index of the current character (starting from 0) for this :ref:`RichTextEffect` custom block. Setting this property won't affect drawing. ---- .. _class_CharFXTransform_property_visible: - :ref:`bool` **visible** +-----------+-----------------------+ | *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 :ref:`color` to ``Color(1, 1, 1, 0)`` instead. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`