godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

263
classes/class_charfxtransform.rst
View File

@@ -14,11 +14,15 @@ CharFXTransform
Controls how an individual character will be displayed in a :ref:`RichTextEffect<class_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<class_RichTextEffect>`.
.. rst-class:: classref-introduction-group
Tutorials
---------
@@ -26,81 +30,95 @@ Tutorials
- `RichTextEffect test project (third-party) <https://github.com/Eoin-ONeill-Yokai/Godot-Rich-Text-Effect-Test-Project>`__
.. rst-class:: classref-reftable-group
Properties
----------
+-------------------------------------+------------------------------------------------------------------+-----------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_CharFXTransform_property_color>` | ``Color(0, 0, 0, 1)`` |
+-------------------------------------+------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`elapsed_time<class_CharFXTransform_property_elapsed_time>` | ``0.0`` |
+-------------------------------------+------------------------------------------------------------------+-----------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`env<class_CharFXTransform_property_env>` | ``{}`` |
+-------------------------------------+------------------------------------------------------------------+-----------------------+
| :ref:`RID<class_RID>` | :ref:`font<class_CharFXTransform_property_font>` | |
+-------------------------------------+------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>` | :ref:`glyph_count<class_CharFXTransform_property_glyph_count>` | ``0`` |
+-------------------------------------+------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>` | :ref:`glyph_flags<class_CharFXTransform_property_glyph_flags>` | ``0`` |
+-------------------------------------+------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>` | :ref:`glyph_index<class_CharFXTransform_property_glyph_index>` | ``0`` |
+-------------------------------------+------------------------------------------------------------------+-----------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_CharFXTransform_property_offset>` | ``Vector2(0, 0)`` |
+-------------------------------------+------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`outline<class_CharFXTransform_property_outline>` | ``false`` |
+-------------------------------------+------------------------------------------------------------------+-----------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`range<class_CharFXTransform_property_range>` | ``Vector2i(0, 0)`` |
+-------------------------------------+------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`visible<class_CharFXTransform_property_visible>` | ``true`` |
+-------------------------------------+------------------------------------------------------------------+-----------------------+
.. table::
:widths: auto
+-------------------------------------+----------------------------------------------------------------------+-----------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_CharFXTransform_property_color>` | ``Color(0, 0, 0, 1)`` |
+-------------------------------------+----------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`elapsed_time<class_CharFXTransform_property_elapsed_time>` | ``0.0`` |
+-------------------------------------+----------------------------------------------------------------------+-----------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`env<class_CharFXTransform_property_env>` | ``{}`` |
+-------------------------------------+----------------------------------------------------------------------+-----------------------+
| :ref:`RID<class_RID>` | :ref:`font<class_CharFXTransform_property_font>` | |
+-------------------------------------+----------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>` | :ref:`glyph_count<class_CharFXTransform_property_glyph_count>` | ``0`` |
+-------------------------------------+----------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>` | :ref:`glyph_flags<class_CharFXTransform_property_glyph_flags>` | ``0`` |
+-------------------------------------+----------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>` | :ref:`glyph_index<class_CharFXTransform_property_glyph_index>` | ``0`` |
+-------------------------------------+----------------------------------------------------------------------+-----------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_CharFXTransform_property_offset>` | ``Vector2(0, 0)`` |
+-------------------------------------+----------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`outline<class_CharFXTransform_property_outline>` | ``false`` |
+-------------------------------------+----------------------------------------------------------------------+-----------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`range<class_CharFXTransform_property_range>` | ``Vector2i(0, 0)`` |
+-------------------------------------+----------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>` | :ref:`relative_index<class_CharFXTransform_property_relative_index>` | ``0`` |
+-------------------------------------+----------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`visible<class_CharFXTransform_property_visible>` | ``true`` |
+-------------------------------------+----------------------------------------------------------------------+-----------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_CharFXTransform_property_color:
- :ref:`Color<class_Color>` **color**
.. rst-class:: classref-property
+-----------+-----------------------+
| *Default* | ``Color(0, 0, 0, 1)`` |
+-----------+-----------------------+
| *Setter* | set_color(value) |
+-----------+-----------------------+
| *Getter* | get_color() |
+-----------+-----------------------+
:ref:`Color<class_Color>` **color** = ``Color(0, 0, 0, 1)``
.. rst-class:: classref-property-setget
- void **set_color** **(** :ref:`Color<class_Color>` value **)**
- :ref:`Color<class_Color>` **get_color** **(** **)**
The color the character will be drawn with.
.. rst-class:: classref-item-separator
----
.. _class_CharFXTransform_property_elapsed_time:
- :ref:`float<class_float>` **elapsed_time**
.. rst-class:: classref-property
+-----------+-------------------------+
| *Default* | ``0.0`` |
+-----------+-------------------------+
| *Setter* | set_elapsed_time(value) |
+-----------+-------------------------+
| *Getter* | get_elapsed_time() |
+-----------+-------------------------+
:ref:`float<class_float>` **elapsed_time** = ``0.0``
.. rst-class:: classref-property-setget
- void **set_elapsed_time** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_elapsed_time** **(** **)**
The time elapsed since the :ref:`RichTextLabel<class_RichTextLabel>` was added to the scene tree (in seconds). Time stops when the :ref:`RichTextLabel<class_RichTextLabel>` is paused (see :ref:`Node.process_mode<class_Node_property_process_mode>`). Resets when the text in the :ref:`RichTextLabel<class_RichTextLabel>` is changed.
\ **Note:** Time still passes while the :ref:`RichTextLabel<class_RichTextLabel>` is hidden.
.. rst-class:: classref-item-separator
----
.. _class_CharFXTransform_property_env:
- :ref:`Dictionary<class_Dictionary>` **env**
.. rst-class:: classref-property
+-----------+------------------------+
| *Default* | ``{}`` |
+-----------+------------------------+
| *Setter* | set_environment(value) |
+-----------+------------------------+
| *Getter* | get_environment() |
+-----------+------------------------+
:ref:`Dictionary<class_Dictionary>` **env** = ``{}``
.. rst-class:: classref-property-setget
- void **set_environment** **(** :ref:`Dictionary<class_Dictionary>` value **)**
- :ref:`Dictionary<class_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<class_bool>`, :ref:`int<class_int>` or :ref:`float<class_float>`, they will be converted automatically. Color codes in the form ``#rrggbb`` or ``#rgb`` will be converted to an opaque :ref:`Color<class_Color>`. String arguments may not contain spaces, even if they're quoted. If present, quotes will also be present in the final string.
@@ -110,129 +128,156 @@ For example, the opening BBCode tag ``[example foo=hello bar=true baz=42 color=#
{"foo": "hello", "bar": true, "baz": 42, "color": Color(1, 1, 1, 1)}
.. rst-class:: classref-item-separator
----
.. _class_CharFXTransform_property_font:
- :ref:`RID<class_RID>` **font**
.. rst-class:: classref-property
+----------+-----------------+
| *Setter* | set_font(value) |
+----------+-----------------+
| *Getter* | get_font() |
+----------+-----------------+
:ref:`RID<class_RID>` **font**
.. rst-class:: classref-property-setget
- void **set_font** **(** :ref:`RID<class_RID>` value **)**
- :ref:`RID<class_RID>` **get_font** **(** **)**
Font resource used to render glyph.
.. rst-class:: classref-item-separator
----
.. _class_CharFXTransform_property_glyph_count:
- :ref:`int<class_int>` **glyph_count**
.. rst-class:: classref-property
+-----------+------------------------+
| *Default* | ``0`` |
+-----------+------------------------+
| *Setter* | set_glyph_count(value) |
+-----------+------------------------+
| *Getter* | get_glyph_count() |
+-----------+------------------------+
:ref:`int<class_int>` **glyph_count** = ``0``
.. rst-class:: classref-property-setget
- void **set_glyph_count** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_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:
- :ref:`int<class_int>` **glyph_flags**
.. rst-class:: classref-property
+-----------+------------------------+
| *Default* | ``0`` |
+-----------+------------------------+
| *Setter* | set_glyph_flags(value) |
+-----------+------------------------+
| *Getter* | get_glyph_flags() |
+-----------+------------------------+
:ref:`int<class_int>` **glyph_flags** = ``0``
.. rst-class:: classref-property-setget
- void **set_glyph_flags** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_glyph_flags** **(** **)**
Glyph flags. See :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` for more info. Setting this property won't affect drawing.
.. rst-class:: classref-item-separator
----
.. _class_CharFXTransform_property_glyph_index:
- :ref:`int<class_int>` **glyph_index**
.. rst-class:: classref-property
+-----------+------------------------+
| *Default* | ``0`` |
+-----------+------------------------+
| *Setter* | set_glyph_index(value) |
+-----------+------------------------+
| *Getter* | get_glyph_index() |
+-----------+------------------------+
:ref:`int<class_int>` **glyph_index** = ``0``
.. rst-class:: classref-property-setget
- void **set_glyph_index** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_glyph_index** **(** **)**
Font specific glyph index.
.. rst-class:: classref-item-separator
----
.. _class_CharFXTransform_property_offset:
- :ref:`Vector2<class_Vector2>` **offset**
.. rst-class:: classref-property
+-----------+-------------------+
| *Default* | ``Vector2(0, 0)`` |
+-----------+-------------------+
| *Setter* | set_offset(value) |
+-----------+-------------------+
| *Getter* | get_offset() |
+-----------+-------------------+
:ref:`Vector2<class_Vector2>` **offset** = ``Vector2(0, 0)``
.. rst-class:: classref-property-setget
- void **set_offset** **(** :ref:`Vector2<class_Vector2>` value **)**
- :ref:`Vector2<class_Vector2>` **get_offset** **(** **)**
The position offset the character will be drawn with (in pixels).
.. rst-class:: classref-item-separator
----
.. _class_CharFXTransform_property_outline:
- :ref:`bool<class_bool>` **outline**
.. rst-class:: classref-property
+-----------+--------------------+
| *Default* | ``false`` |
+-----------+--------------------+
| *Setter* | set_outline(value) |
+-----------+--------------------+
| *Getter* | is_outline() |
+-----------+--------------------+
:ref:`bool<class_bool>` **outline** = ``false``
.. rst-class:: classref-property-setget
- void **set_outline** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_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:
- :ref:`Vector2i<class_Vector2i>` **range**
.. rst-class:: classref-property
+-----------+--------------------+
| *Default* | ``Vector2i(0, 0)`` |
+-----------+--------------------+
| *Setter* | set_range(value) |
+-----------+--------------------+
| *Getter* | get_range() |
+-----------+--------------------+
:ref:`Vector2i<class_Vector2i>` **range** = ``Vector2i(0, 0)``
.. rst-class:: classref-property-setget
- void **set_range** **(** :ref:`Vector2i<class_Vector2i>` value **)**
- :ref:`Vector2i<class_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<class_int>` **relative_index** = ``0``
.. rst-class:: classref-property-setget
- void **set_relative_index** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_relative_index** **(** **)**
The character offset of the glyph, relative to the current :ref:`RichTextEffect<class_RichTextEffect>` custom block. Setting this property won't affect drawing.
.. rst-class:: classref-item-separator
----
.. _class_CharFXTransform_property_visible:
- :ref:`bool<class_bool>` **visible**
.. rst-class:: classref-property
+-----------+-----------------------+
| *Default* | ``true`` |
+-----------+-----------------------+
| *Setter* | set_visibility(value) |
+-----------+-----------------------+
| *Getter* | is_visible() |
+-----------+-----------------------+
:ref:`bool<class_bool>` **visible** = ``true``
.. rst-class:: classref-property-setget
- void **set_visibility** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_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<class_CharFXTransform_property_color>` to ``Color(1, 1, 1, 0)`` instead.