stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (29b3d9e)

Browse Source
This commit is contained in:
Godot Organization
2024-03-30 03:20:32 +00:00
parent a22c312b8f
commit e41630eb7e
36 changed files with 1183 additions and 204 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_animationnodeanimation.rst
+106 -5
View File
@@ -40,11 +40,21 @@ Properties
.. table::
:widths: auto
+-------------------------------------------------------+-------------------------------------------------------------------+---------+
| :ref:`StringName<class_StringName>` | :ref:`animation<class_AnimationNodeAnimation_property_animation>` | ``&""`` |
+-------------------------------------------------------+-------------------------------------------------------------------+---------+
| :ref:`PlayMode<enum_AnimationNodeAnimation_PlayMode>` | :ref:`play_mode<class_AnimationNodeAnimation_property_play_mode>` | ``0`` |
+-------------------------------------------------------+-------------------------------------------------------------------+---------+
+-------------------------------------------------------+---------------------------------------------------------------------------------------+-----------+
| :ref:`StringName<class_StringName>` | :ref:`animation<class_AnimationNodeAnimation_property_animation>` | ``&""`` |
+-------------------------------------------------------+---------------------------------------------------------------------------------------+-----------+
| :ref:`LoopMode<enum_Animation_LoopMode>` | :ref:`loop_mode<class_AnimationNodeAnimation_property_loop_mode>` | |
+-------------------------------------------------------+---------------------------------------------------------------------------------------+-----------+
| :ref:`PlayMode<enum_AnimationNodeAnimation_PlayMode>` | :ref:`play_mode<class_AnimationNodeAnimation_property_play_mode>` | ``0`` |
+-------------------------------------------------------+---------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`start_offset<class_AnimationNodeAnimation_property_start_offset>` | |
+-------------------------------------------------------+---------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`stretch_time_scale<class_AnimationNodeAnimation_property_stretch_time_scale>` | |
+-------------------------------------------------------+---------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`timeline_length<class_AnimationNodeAnimation_property_timeline_length>` | |
+-------------------------------------------------------+---------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`use_custom_timeline<class_AnimationNodeAnimation_property_use_custom_timeline>` | ``false`` |
+-------------------------------------------------------+---------------------------------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
@@ -103,6 +113,23 @@ Animation to use as an output. It is one of the animations provided by :ref:`Ani
----
.. _class_AnimationNodeAnimation_property_loop_mode:
.. rst-class:: classref-property
:ref:`LoopMode<enum_Animation_LoopMode>` **loop_mode**
.. rst-class:: classref-property-setget
- |void| **set_loop_mode**\ (\ value\: :ref:`LoopMode<enum_Animation_LoopMode>`\ )
- :ref:`LoopMode<enum_Animation_LoopMode>` **get_loop_mode**\ (\ )
If :ref:`use_custom_timeline<class_AnimationNodeAnimation_property_use_custom_timeline>` is ``true``, override the loop settings of the original :ref:`Animation<class_Animation>` resource with the value.
.. rst-class:: classref-item-separator
----
.. _class_AnimationNodeAnimation_property_play_mode:
.. rst-class:: classref-property
@@ -116,6 +143,80 @@ Animation to use as an output. It is one of the animations provided by :ref:`Ani
Determines the playback direction of the animation.
.. rst-class:: classref-item-separator
----
.. _class_AnimationNodeAnimation_property_start_offset:
.. rst-class:: classref-property
:ref:`float<class_float>` **start_offset**
.. rst-class:: classref-property-setget
- |void| **set_start_offset**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_start_offset**\ (\ )
If :ref:`use_custom_timeline<class_AnimationNodeAnimation_property_use_custom_timeline>` is ``true``, offset the start position of the animation.
This is useful for adjusting which foot steps first in 3D walking animations.
.. rst-class:: classref-item-separator
----
.. _class_AnimationNodeAnimation_property_stretch_time_scale:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **stretch_time_scale**
.. rst-class:: classref-property-setget
- |void| **set_stretch_time_scale**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_stretching_time_scale**\ (\ )
If ``true``, scales the time so that the length specified in :ref:`timeline_length<class_AnimationNodeAnimation_property_timeline_length>` is one cycle.
This is useful for matching the periods of walking and running animations.
If ``false``, the original animation length is respected. If you set the loop to :ref:`loop_mode<class_AnimationNodeAnimation_property_loop_mode>`, the animation will loop in :ref:`timeline_length<class_AnimationNodeAnimation_property_timeline_length>`.
.. rst-class:: classref-item-separator
----
.. _class_AnimationNodeAnimation_property_timeline_length:
.. rst-class:: classref-property
:ref:`float<class_float>` **timeline_length**
.. rst-class:: classref-property-setget
- |void| **set_timeline_length**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_timeline_length**\ (\ )
If :ref:`use_custom_timeline<class_AnimationNodeAnimation_property_use_custom_timeline>` is ``true``, offset the start position of the animation.
.. rst-class:: classref-item-separator
----
.. _class_AnimationNodeAnimation_property_use_custom_timeline:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **use_custom_timeline** = ``false``
.. rst-class:: classref-property-setget
- |void| **set_use_custom_timeline**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_using_custom_timeline**\ (\ )
If ``true``, :ref:`AnimationNode<class_AnimationNode>` provides an animation based on the :ref:`Animation<class_Animation>` resource with some parameters adjusted.
.. |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.)`