:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator:
[Link]
.. XML source:
[Link]
.. _class_AnimationRootNode:
AnimationRootNode
=================
**Inherits:** :ref:`AnimationNode<class_AnimationNode>`
**<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>`
**<** :ref:`Object<class_Object>`
**Inherited
By:** :ref:`AnimationNodeAnimation<class_AnimationNodeAnimation>`, :ref:`AnimationN
odeBlendSpace1D<class_AnimationNodeBlendSpace1D>`, :ref:`AnimationNodeBlendSpace2D<
class_AnimationNodeBlendSpace2D>`, :ref:`AnimationNodeBlendTree<class_AnimationNode
BlendTree>`, :ref:`AnimationNodeStateMachine<class_AnimationNodeStateMachine>`
Base class for :ref:`AnimationNode<class_AnimationNode>`\ s that hold one or
multiple composite animations. Usually used
for :ref:`AnimationTree.tree_root<class_AnimationTree_property_tree_root>`.
.. rst-class:: classref-introduction-group
Description
-----------
**AnimationRootNode** is a base class
for :ref:`AnimationNode<class_AnimationNode>`\ s that hold a complete animation. A
complete animation refers to the output of
an :ref:`AnimationNodeOutput<class_AnimationNodeOutput>` in
an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>` or the output of
another **AnimationRootNode**. Used
for :ref:`AnimationTree.tree_root<class_AnimationTree_property_tree_root>` or in
other **AnimationRootNode**\ s.
Examples of built-in root nodes
include :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>` (allows
blending nodes between each other using various
modes), :ref:`AnimationNodeStateMachine<class_AnimationNodeStateMachine>` (allows
to configure blending and transitions between nodes using a state machine pattern),
:ref:`AnimationNodeBlendSpace2D<class_AnimationNodeBlendSpace2D>` (allows linear
blending between **three** :ref:`AnimationNode<class_AnimationNode>`\
s), :ref:`AnimationNodeBlendSpace1D<class_AnimationNodeBlendSpace1D>` (allows
linear blending only between **two** :ref:`AnimationNode<class_AnimationNode>`\ s).
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Using AnimationTree <../tutorials/animation/animation_tree>`
.. |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.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a
bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`