class_animationnodeanimation.rst 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the AnimationNodeAnimation.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AnimationNodeAnimation:
  6. AnimationNodeAnimation
  7. ======================
  8. **Inherits:** :ref:`AnimationRootNode<class_AnimationRootNode>` **<** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Input animation to use in an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
  10. Description
  11. -----------
  12. 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.
  13. Tutorials
  14. ---------
  15. - :doc:`../tutorials/animation/animation_tree`
  16. Properties
  17. ----------
  18. +-----------------------------+-------------------------------------------------------------------+--------+
  19. | :ref:`String<class_String>` | :ref:`animation<class_AnimationNodeAnimation_property_animation>` | ``""`` |
  20. +-----------------------------+-------------------------------------------------------------------+--------+
  21. Property Descriptions
  22. ---------------------
  23. .. _class_AnimationNodeAnimation_property_animation:
  24. - :ref:`String<class_String>` **animation**
  25. +-----------+----------------------+
  26. | *Default* | ``""`` |
  27. +-----------+----------------------+
  28. | *Setter* | set_animation(value) |
  29. +-----------+----------------------+
  30. | *Getter* | get_animation() |
  31. +-----------+----------------------+
  32. Animation to use as an output. It is one of the animations provided by :ref:`AnimationTree.anim_player<class_AnimationTree_property_anim_player>`.
  33. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  34. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  35. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`