Files
godot-docs/classes/class_animationnodeadd3.rst
2019-07-02 14:03:23 +02:00

56 lines
1.9 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeAdd3.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_AnimationNodeAdd3:
AnimationNodeAdd3
=================
**Inherits:** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Blends two of three animations additively inside of an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
Properties
----------
+-------------------------+----------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd3_property_sync>` | false |
+-------------------------+----------------------------------------------------+-------+
Description
-----------
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.
This node has three inputs:
- The base animation to add to
- A -add animation to blend with when the blend amount is in the ``[-1.0, 0.0]`` range.
- A +add animation to blend with when the blend amount is in the ``[0.0, 1.0]`` range
Property Descriptions
---------------------
.. _class_AnimationNodeAdd3_property_sync:
- :ref:`bool<class_bool>` **sync**
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_use_sync(value) |
+-----------+---------------------+
| *Getter* | is_using_sync() |
+-----------+---------------------+
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.