godot-docs/classes/class_animationnodeanimation.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeAnimation.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_AnimationNodeAnimation:

AnimationNodeAnimation
======================

**Inherits:** :ref:`AnimationRootNode<class_AnimationRootNode>` **<** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Input animation to use in an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.

Description
-----------

A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Only features one output set using the :ref:`animation<class_AnimationNodeAnimation_property_animation>` property. Use it as an input for :ref:`AnimationNode<class_AnimationNode>` that blend animations together.

Tutorials
---------

- :doc:`AnimationTree <../tutorials/animation/animation_tree>`

- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`__

- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__

Properties
----------

+-------------------------------------------------------+-------------------------------------------------------------------+---------+
| :ref:`StringName<class_StringName>`                   | :ref:`animation<class_AnimationNodeAnimation_property_animation>` | ``&""`` |
+-------------------------------------------------------+-------------------------------------------------------------------+---------+
| :ref:`PlayMode<enum_AnimationNodeAnimation_PlayMode>` | :ref:`play_mode<class_AnimationNodeAnimation_property_play_mode>` | ``0``   |
+-------------------------------------------------------+-------------------------------------------------------------------+---------+

Enumerations
------------

.. _enum_AnimationNodeAnimation_PlayMode:

.. _class_AnimationNodeAnimation_constant_PLAY_MODE_FORWARD:

.. _class_AnimationNodeAnimation_constant_PLAY_MODE_BACKWARD:

enum **PlayMode**:

- **PLAY_MODE_FORWARD** = **0**

- **PLAY_MODE_BACKWARD** = **1**

Property Descriptions
---------------------

.. _class_AnimationNodeAnimation_property_animation:

- :ref:`StringName<class_StringName>` **animation**

+-----------+----------------------+
| *Default* | ``&""``              |
+-----------+----------------------+
| *Setter*  | set_animation(value) |
+-----------+----------------------+
| *Getter*  | get_animation()      |
+-----------+----------------------+

Animation to use as an output. It is one of the animations provided by :ref:`AnimationTree.anim_player<class_AnimationTree_property_anim_player>`.

----

.. _class_AnimationNodeAnimation_property_play_mode:

- :ref:`PlayMode<enum_AnimationNodeAnimation_PlayMode>` **play_mode**

+-----------+----------------------+
| *Default* | ``0``                |
+-----------+----------------------+
| *Setter*  | set_play_mode(value) |
+-----------+----------------------+
| *Getter*  | get_play_mode()      |
+-----------+----------------------+

Determines the playback direction of the animation.

.. |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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`