class_animationnodeadd3.rst 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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 AnimationNodeAdd3.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AnimationNodeAdd3:
  6. AnimationNodeAdd3
  7. =================
  8. **Inherits:** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Blends two of three animations additively inside of an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
  10. Description
  11. -----------
  12. A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Blends two animations together additively out of three based on a value in the ``[-1.0, 1.0]`` range.
  13. This node has three inputs:
  14. - The base animation to add to
  15. - A -add animation to blend with when the blend amount is in the ``[-1.0, 0.0]`` range.
  16. - A +add animation to blend with when the blend amount is in the ``[0.0, 1.0]`` range
  17. Tutorials
  18. ---------
  19. - :doc:`../tutorials/animation/animation_tree`
  20. - `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
  21. Properties
  22. ----------
  23. +-------------------------+----------------------------------------------------+-----------+
  24. | :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd3_property_sync>` | ``false`` |
  25. +-------------------------+----------------------------------------------------+-----------+
  26. Property Descriptions
  27. ---------------------
  28. .. _class_AnimationNodeAdd3_property_sync:
  29. - :ref:`bool<class_bool>` **sync**
  30. +-----------+---------------------+
  31. | *Default* | ``false`` |
  32. +-----------+---------------------+
  33. | *Setter* | set_use_sync(value) |
  34. +-----------+---------------------+
  35. | *Getter* | is_using_sync() |
  36. +-----------+---------------------+
  37. 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.
  38. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  39. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  40. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`