Sync classref with current source

2026-01-04 14:11:02 +03:00 · 2019-09-24 13:39:50 +02:00
parent 247ba2144c
commit 9e7daa26fa
139 changed files with 1840 additions and 727 deletions
--- a/classes/class_charfxtransform.rst
+++ b/classes/class_charfxtransform.rst
@@ -0,0 +1,154 @@
+:github_url: hide
+
+.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
+.. DO NOT EDIT THIS FILE, but the CharFXTransform.xml source instead.
+.. The source is found in doc/classes or modules/<name>/doc_classes.
+
+.. _class_CharFXTransform:
+
+CharFXTransform
+===============
+
+**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
+
+**Category:** Core
+
+Brief Description
+-----------------
+
+
+
+Properties
+----------
+
+-------------------------------------+----------------------------------------------------------------------+---------------------+
+| :ref:`int<class_int>`               | :ref:`absolute_index<class_CharFXTransform_property_absolute_index>` | 0                   |
+-------------------------------------+----------------------------------------------------------------------+---------------------+
+| :ref:`int<class_int>`               | :ref:`character<class_CharFXTransform_property_character>`           | 0                   |
+-------------------------------------+----------------------------------------------------------------------+---------------------+
+| :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:`Vector2<class_Vector2>`       | :ref:`offset<class_CharFXTransform_property_offset>`                 | Vector2( 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                |
+-------------------------------------+----------------------------------------------------------------------+---------------------+
+
+Methods
+-------
+
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`Variant<class_Variant>` | :ref:`get_value_or<class_CharFXTransform_method_get_value_or>` **(** :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` default_value **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+Property Descriptions
+---------------------
+
+.. _class_CharFXTransform_property_absolute_index:
+
+- :ref:`int<class_int>` **absolute_index**
+
+-----------+---------------------------+
+| *Default* | 0                         |
+-----------+---------------------------+
+| *Setter*  | set_absolute_index(value) |
+-----------+---------------------------+
+| *Getter*  | get_absolute_index()      |
+-----------+---------------------------+
+
+.. _class_CharFXTransform_property_character:
+
+- :ref:`int<class_int>` **character**
+
+-----------+----------------------+
+| *Default* | 0                    |
+-----------+----------------------+
+| *Setter*  | set_character(value) |
+-----------+----------------------+
+| *Getter*  | get_character()      |
+-----------+----------------------+
+
+.. _class_CharFXTransform_property_color:
+
+- :ref:`Color<class_Color>` **color**
+
+-----------+---------------------+
+| *Default* | Color( 0, 0, 0, 1 ) |
+-----------+---------------------+
+| *Setter*  | set_color(value)    |
+-----------+---------------------+
+| *Getter*  | get_color()         |
+-----------+---------------------+
+
+.. _class_CharFXTransform_property_elapsed_time:
+
+- :ref:`float<class_float>` **elapsed_time**
+
+-----------+-------------------------+
+| *Default* | 0.0                     |
+-----------+-------------------------+
+| *Setter*  | set_elapsed_time(value) |
+-----------+-------------------------+
+| *Getter*  | get_elapsed_time()      |
+-----------+-------------------------+
+
+.. _class_CharFXTransform_property_env:
+
+- :ref:`Dictionary<class_Dictionary>` **env**
+
+-----------+------------------------+
+| *Default* | {}                     |
+-----------+------------------------+
+| *Setter*  | set_environment(value) |
+-----------+------------------------+
+| *Getter*  | get_environment()      |
+-----------+------------------------+
+
+.. _class_CharFXTransform_property_offset:
+
+- :ref:`Vector2<class_Vector2>` **offset**
+
+-----------+-------------------+
+| *Default* | Vector2( 0, 0 )   |
+-----------+-------------------+
+| *Setter*  | set_offset(value) |
+-----------+-------------------+
+| *Getter*  | get_offset()      |
+-----------+-------------------+
+
+.. _class_CharFXTransform_property_relative_index:
+
+- :ref:`int<class_int>` **relative_index**
+
+-----------+---------------------------+
+| *Default* | 0                         |
+-----------+---------------------------+
+| *Setter*  | set_relative_index(value) |
+-----------+---------------------------+
+| *Getter*  | get_relative_index()      |
+-----------+---------------------------+
+
+.. _class_CharFXTransform_property_visible:
+
+- :ref:`bool<class_bool>` **visible**
+
+-----------+-----------------------+
+| *Default* | true                  |
+-----------+-----------------------+
+| *Setter*  | set_visibility(value) |
+-----------+-----------------------+
+| *Getter*  | is_visible()          |
+-----------+-----------------------+
+
+Method Descriptions
+-------------------
+
+.. _class_CharFXTransform_method_get_value_or:
+
+- :ref:`Variant<class_Variant>` **get_value_or** **(** :ref:`String<class_String>` key, :ref:`Variant<class_Variant>` default_value **)**
+