:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.1/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.1/doc/classes/CharFXTransform.xml. .. _class_CharFXTransform: CharFXTransform =============== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Controls how an individual character will be displayed in a :ref:`RichTextEffect`. .. rst-class:: classref-introduction-group Description ----------- By setting various properties on this object, you can control how individual characters will be displayed in a :ref:`RichTextEffect`. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`BBCode in RichTextLabel <../tutorials/ui/bbcode_in_richtextlabel>` - `RichTextEffect test project (third-party) `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------+----------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`color` | ``Color(0, 0, 0, 1)`` | +-------------------------------------+----------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`elapsed_time` | ``0.0`` | +-------------------------------------+----------------------------------------------------------------------+-----------------------+ | :ref:`Dictionary` | :ref:`env` | ``{}`` | +-------------------------------------+----------------------------------------------------------------------+-----------------------+ | :ref:`RID` | :ref:`font` | ``RID()`` | +-------------------------------------+----------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`glyph_count` | ``0`` | +-------------------------------------+----------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`glyph_flags` | ``0`` | +-------------------------------------+----------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`glyph_index` | ``0`` | +-------------------------------------+----------------------------------------------------------------------+-----------------------+ | :ref:`Vector2` | :ref:`offset` | ``Vector2(0, 0)`` | +-------------------------------------+----------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`outline` | ``false`` | +-------------------------------------+----------------------------------------------------------------------+-----------------------+ | :ref:`Vector2i` | :ref:`range` | ``Vector2i(0, 0)`` | +-------------------------------------+----------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`relative_index` | ``0`` | +-------------------------------------+----------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`visible` | ``true`` | +-------------------------------------+----------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_CharFXTransform_property_color: .. rst-class:: classref-property :ref:`Color` **color** = ``Color(0, 0, 0, 1)`` .. rst-class:: classref-property-setget - void **set_color** **(** :ref:`Color` value **)** - :ref:`Color` **get_color** **(** **)** The color the character will be drawn with. .. rst-class:: classref-item-separator ---- .. _class_CharFXTransform_property_elapsed_time: .. rst-class:: classref-property :ref:`float` **elapsed_time** = ``0.0`` .. rst-class:: classref-property-setget - void **set_elapsed_time** **(** :ref:`float` value **)** - :ref:`float` **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.process_mode`). Resets when the text in the :ref:`RichTextLabel` is changed. \ **Note:** Time still passes while the :ref:`RichTextLabel` is hidden. .. rst-class:: classref-item-separator ---- .. _class_CharFXTransform_property_env: .. rst-class:: classref-property :ref:`Dictionary` **env** = ``{}`` .. rst-class:: classref-property-setget - void **set_environment** **(** :ref:`Dictionary` value **)** - :ref:`Dictionary` **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)} .. rst-class:: classref-item-separator ---- .. _class_CharFXTransform_property_font: .. rst-class:: classref-property :ref:`RID` **font** = ``RID()`` .. rst-class:: classref-property-setget - void **set_font** **(** :ref:`RID` value **)** - :ref:`RID` **get_font** **(** **)** Font resource used to render glyph. .. rst-class:: classref-item-separator ---- .. _class_CharFXTransform_property_glyph_count: .. rst-class:: classref-property :ref:`int` **glyph_count** = ``0`` .. rst-class:: classref-property-setget - void **set_glyph_count** **(** :ref:`int` value **)** - :ref:`int` **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. .. rst-class:: classref-item-separator ---- .. _class_CharFXTransform_property_glyph_flags: .. rst-class:: classref-property :ref:`int` **glyph_flags** = ``0`` .. rst-class:: classref-property-setget - void **set_glyph_flags** **(** :ref:`int` value **)** - :ref:`int` **get_glyph_flags** **(** **)** Glyph flags. See :ref:`GraphemeFlag` for more info. Setting this property won't affect drawing. .. rst-class:: classref-item-separator ---- .. _class_CharFXTransform_property_glyph_index: .. rst-class:: classref-property :ref:`int` **glyph_index** = ``0`` .. rst-class:: classref-property-setget - void **set_glyph_index** **(** :ref:`int` value **)** - :ref:`int` **get_glyph_index** **(** **)** Font specific glyph index. .. rst-class:: classref-item-separator ---- .. _class_CharFXTransform_property_offset: .. rst-class:: classref-property :ref:`Vector2` **offset** = ``Vector2(0, 0)`` .. rst-class:: classref-property-setget - void **set_offset** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_offset** **(** **)** The position offset the character will be drawn with (in pixels). .. rst-class:: classref-item-separator ---- .. _class_CharFXTransform_property_outline: .. rst-class:: classref-property :ref:`bool` **outline** = ``false`` .. rst-class:: classref-property-setget - void **set_outline** **(** :ref:`bool` value **)** - :ref:`bool` **is_outline** **(** **)** If ``true``, FX transform is called for outline drawing. Setting this property won't affect drawing. .. rst-class:: classref-item-separator ---- .. _class_CharFXTransform_property_range: .. rst-class:: classref-property :ref:`Vector2i` **range** = ``Vector2i(0, 0)`` .. rst-class:: classref-property-setget - void **set_range** **(** :ref:`Vector2i` value **)** - :ref:`Vector2i` **get_range** **(** **)** Absolute character range in the string, corresponding to the glyph. Setting this property won't affect drawing. .. rst-class:: classref-item-separator ---- .. _class_CharFXTransform_property_relative_index: .. rst-class:: classref-property :ref:`int` **relative_index** = ``0`` .. rst-class:: classref-property-setget - void **set_relative_index** **(** :ref:`int` value **)** - :ref:`int` **get_relative_index** **(** **)** The character offset of the glyph, relative to the current :ref:`RichTextEffect` custom block. Setting this property won't affect drawing. .. rst-class:: classref-item-separator ---- .. _class_CharFXTransform_property_visible: .. rst-class:: classref-property :ref:`bool` **visible** = ``true`` .. rst-class:: classref-property-setget - void **set_visibility** **(** :ref:`bool` value **)** - :ref:`bool` **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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`