class_animationnodeblend2.rst 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlend2.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AnimationNodeBlend2:
  6. AnimationNodeBlend2
  7. ===================
  8. **Inherits:** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Blends two animations linearly inside of an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
  10. Description
  11. -----------
  12. A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Blends two animations linearly based on an amount value in the ``[0.0, 1.0]`` range.
  13. Tutorials
  14. ---------
  15. - :doc:`../tutorials/animation/animation_tree`
  16. - `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`__
  17. - `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
  18. Properties
  19. ----------
  20. +-------------------------+------------------------------------------------------+-----------+
  21. | :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend2_property_sync>` | ``false`` |
  22. +-------------------------+------------------------------------------------------+-----------+
  23. Property Descriptions
  24. ---------------------
  25. .. _class_AnimationNodeBlend2_property_sync:
  26. - :ref:`bool<class_bool>` **sync**
  27. +-----------+---------------------+
  28. | *Default* | ``false`` |
  29. +-----------+---------------------+
  30. | *Setter* | set_use_sync(value) |
  31. +-----------+---------------------+
  32. | *Getter* | is_using_sync() |
  33. +-----------+---------------------+
  34. If ``true``, sets the ``optimization`` to ``false`` when calling :ref:`AnimationNode.blend_input<class_AnimationNode_method_blend_input>`, forcing the blended animations to update every frame.
  35. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  36. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  37. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`