class_animationnodeblend2.rst 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlend2.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_AnimationNodeBlend2:
  5. AnimationNodeBlend2
  6. ===================
  7. **Inherits:** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Blends two animations linearly inside of an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
  12. Properties
  13. ----------
  14. +-------------------------+------------------------------------------------------+-------+
  15. | :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend2_property_sync>` | false |
  16. +-------------------------+------------------------------------------------------+-------+
  17. Description
  18. -----------
  19. 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.
  20. Property Descriptions
  21. ---------------------
  22. .. _class_AnimationNodeBlend2_property_sync:
  23. - :ref:`bool<class_bool>` **sync**
  24. +-----------+---------------------+
  25. | *Default* | false |
  26. +-----------+---------------------+
  27. | *Setter* | set_use_sync(value) |
  28. +-----------+---------------------+
  29. | *Getter* | is_using_sync() |
  30. +-----------+---------------------+
  31. 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.