godot-docs/classes/class_animationnodeblend3.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AnimationNodeBlend3.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_AnimationNodeBlend3:

AnimationNodeBlend3
===================

**Inherits:** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

Blends two of three animations linearly inside of an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.

Description
-----------

A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Blends two animations together linearly out of three based on a value in the ``[-1.0, 1.0]`` range.

This node has three inputs:

- The base animation

- A -blend animation to blend with when the blend amount is in the ``[-1.0, 0.0]`` range.

- A +blend animation to blend with when the blend amount is in the ``[0.0, 1.0]`` range

Properties
----------

+-------------------------+------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend3_property_sync>` | ``false`` |
+-------------------------+------------------------------------------------------+-----------+

Property Descriptions
---------------------

.. _class_AnimationNodeBlend3_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.