class_animationnodetransition.rst

github_url:	hide

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

• :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.

---

• :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

• :ref:`String<class_String>` get_input_caption ( :ref:`int<class_int>` input ) const

---

• :ref:`bool<class_bool>` is_input_set_as_auto_advance ( :ref:`int<class_int>` input ) const

---

• void set_input_as_auto_advance ( :ref:`int<class_int>` input, :ref:`bool<class_bool>` enable )

---

• void set_input_caption ( :ref:`int<class_int>` input, :ref:`String<class_String>` caption )