| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the AnimationNodeTransition.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_AnimationNodeTransition:
- AnimationNodeTransition
- =======================
- **Inherits:** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- A generic animation transition node for :ref:`AnimationTree<class_AnimationTree>`.
- Description
- -----------
- Simple state machine for cases which don't require a more advanced :ref:`AnimationNodeStateMachine<class_AnimationNodeStateMachine>`. Animations can be connected to the inputs and transition times can be specified.
- Tutorials
- ---------
- - :doc:`../tutorials/animation/animation_tree`
- Properties
- ----------
- +---------------------------+------------------------------------------------------------------------+---------+
- | :ref:`int<class_int>` | :ref:`input_count<class_AnimationNodeTransition_property_input_count>` | ``0`` |
- +---------------------------+------------------------------------------------------------------------+---------+
- | :ref:`float<class_float>` | :ref:`xfade_time<class_AnimationNodeTransition_property_xfade_time>` | ``0.0`` |
- +---------------------------+------------------------------------------------------------------------+---------+
- Methods
- -------
- +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_input_caption<class_AnimationNodeTransition_method_get_input_caption>` **(** :ref:`int<class_int>` input **)** |const| |
- +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_input_set_as_auto_advance<class_AnimationNodeTransition_method_is_input_set_as_auto_advance>` **(** :ref:`int<class_int>` input **)** |const| |
- +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_input_as_auto_advance<class_AnimationNodeTransition_method_set_input_as_auto_advance>` **(** :ref:`int<class_int>` input, :ref:`bool<class_bool>` enable **)** |
- +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_input_caption<class_AnimationNodeTransition_method_set_input_caption>` **(** :ref:`int<class_int>` input, :ref:`String<class_String>` caption **)** |
- +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_AnimationNodeTransition_property_input_count:
- - :ref:`int<class_int>` **input_count**
- +-----------+---------------------------+
- | *Default* | ``0`` |
- +-----------+---------------------------+
- | *Setter* | set_enabled_inputs(value) |
- +-----------+---------------------------+
- | *Getter* | get_enabled_inputs() |
- +-----------+---------------------------+
- The number of available input ports for this node.
- ----
- .. _class_AnimationNodeTransition_property_xfade_time:
- - :ref:`float<class_float>` **xfade_time**
- +-----------+----------------------------+
- | *Default* | ``0.0`` |
- +-----------+----------------------------+
- | *Setter* | set_cross_fade_time(value) |
- +-----------+----------------------------+
- | *Getter* | get_cross_fade_time() |
- +-----------+----------------------------+
- Cross-fading time (in seconds) between each animation connected to the inputs.
- Method Descriptions
- -------------------
- .. _class_AnimationNodeTransition_method_get_input_caption:
- - :ref:`String<class_String>` **get_input_caption** **(** :ref:`int<class_int>` input **)** |const|
- ----
- .. _class_AnimationNodeTransition_method_is_input_set_as_auto_advance:
- - :ref:`bool<class_bool>` **is_input_set_as_auto_advance** **(** :ref:`int<class_int>` input **)** |const|
- ----
- .. _class_AnimationNodeTransition_method_set_input_as_auto_advance:
- - void **set_input_as_auto_advance** **(** :ref:`int<class_int>` input, :ref:`bool<class_bool>` enable **)**
- ----
- .. _class_AnimationNodeTransition_method_set_input_caption:
- - void **set_input_caption** **(** :ref:`int<class_int>` input, :ref:`String<class_String>` caption **)**
- .. |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.)`
|
