godot-docs/classes/class_tween.rst

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

.. _class_Tween:

Tween
=====

**Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

Smoothly animates a node's properties over time.

Member Functions
----------------

+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`follow_method<class_Tween_follow_method>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` initial_val, :ref:`Object<class_object>` target, :ref:`String<class_string>` target_method, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)**                  |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`follow_property<class_Tween_follow_property>` **(** :ref:`Object<class_object>` object, :ref:`NodePath<class_nodepath>` property, :ref:`Variant<class_variant>` initial_val, :ref:`Object<class_object>` target, :ref:`NodePath<class_nodepath>` target_property, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)**  |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_runtime<class_Tween_get_runtime>` **(** **)** const                                                                                                                                                                                                                                                                                                                                                           |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`interpolate_callback<class_Tween_interpolate_callback>` **(** :ref:`Object<class_object>` object, :ref:`float<class_float>` duration, :ref:`String<class_string>` callback, :ref:`Variant<class_variant>` arg1=null, :ref:`Variant<class_variant>` arg2=null, :ref:`Variant<class_variant>` arg3=null, :ref:`Variant<class_variant>` arg4=null, :ref:`Variant<class_variant>` arg5=null **)**                     |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`interpolate_deferred_callback<class_Tween_interpolate_deferred_callback>` **(** :ref:`Object<class_object>` object, :ref:`float<class_float>` duration, :ref:`String<class_string>` callback, :ref:`Variant<class_variant>` arg1=null, :ref:`Variant<class_variant>` arg2=null, :ref:`Variant<class_variant>` arg3=null, :ref:`Variant<class_variant>` arg4=null, :ref:`Variant<class_variant>` arg5=null **)**   |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`interpolate_method<class_Tween_interpolate_method>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` initial_val, :ref:`Variant<class_variant>` final_val, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)**                                              |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`interpolate_property<class_Tween_interpolate_property>` **(** :ref:`Object<class_object>` object, :ref:`NodePath<class_nodepath>` property, :ref:`Variant<class_variant>` initial_val, :ref:`Variant<class_variant>` final_val, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)**                                    |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`is_active<class_Tween_is_active>` **(** **)** const                                                                                                                                                                                                                                                                                                                                                               |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`remove<class_Tween_remove>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)**                                                                                                                                                                                                                                                                                                    |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`remove_all<class_Tween_remove_all>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                   |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`reset<class_Tween_reset>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)**                                                                                                                                                                                                                                                                                                      |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`reset_all<class_Tween_reset_all>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                     |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`resume<class_Tween_resume>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)**                                                                                                                                                                                                                                                                                                    |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`resume_all<class_Tween_resume_all>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                   |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`seek<class_Tween_seek>` **(** :ref:`float<class_float>` time **)**                                                                                                                                                                                                                                                                                                                                                |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_active<class_Tween_set_active>` **(** :ref:`bool<class_bool>` active **)**                                                                                                                                                                                                                                                                                                                                    |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`start<class_Tween_start>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                             |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`stop<class_Tween_stop>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)**                                                                                                                                                                                                                                                                                                        |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`stop_all<class_Tween_stop_all>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                       |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`targeting_method<class_Tween_targeting_method>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method, :ref:`Object<class_object>` initial, :ref:`String<class_string>` initial_method, :ref:`Variant<class_variant>` final_val, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)**            |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`targeting_property<class_Tween_targeting_property>` **(** :ref:`Object<class_object>` object, :ref:`NodePath<class_nodepath>` property, :ref:`Object<class_object>` initial, :ref:`NodePath<class_nodepath>` initial_val, :ref:`Variant<class_variant>` final_val, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`tell<class_Tween_tell>` **(** **)** const                                                                                                                                                                                                                                                                                                                                                                         |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

.. _class_Tween_tween_completed:

- **tween_completed** **(** :ref:`Object<class_object>` object, :ref:`NodePath<class_nodepath>` key **)**

Emitted when a tween ends.

.. _class_Tween_tween_started:

- **tween_started** **(** :ref:`Object<class_object>` object, :ref:`NodePath<class_nodepath>` key **)**

Emitted when a tween starts.

.. _class_Tween_tween_step:

- **tween_step** **(** :ref:`Object<class_object>` object, :ref:`NodePath<class_nodepath>` key, :ref:`float<class_float>` elapsed, :ref:`Object<class_object>` value **)**

Emitted at each step of the animation.


Member Variables
----------------

  .. _class_Tween_playback_process_mode:

- :ref:`TweenProcessMode<enum_tween_tweenprocessmode>` **playback_process_mode** - The tween's animation process thread. See enum TweenProcessMode. Default value: enum TWEEN_PROCESS_IDLE.

  .. _class_Tween_playback_speed:

- :ref:`float<class_float>` **playback_speed** - The tween's speed multiplier. For example, set it to ``1.0`` for normal speed, ``2.0`` for two times normal speed, or ``0.5`` for half of the normal speed. A value of ``0`` pauses the animation, but see also :ref:`set_active<class_Tween_set_active>` or :ref:`stop_all<class_Tween_stop_all>` for this.

  .. _class_Tween_repeat:

- :ref:`bool<class_bool>` **repeat** - If ``true`` the tween loops.


Enums
-----

  .. _enum_Tween_TweenProcessMode:

enum **TweenProcessMode**

- **TWEEN_PROCESS_PHYSICS** = **0** --- The tween updates with the ``_physics_process`` callback.
- **TWEEN_PROCESS_IDLE** = **1** --- The tween updates with the ``_process`` callback.

  .. _enum_Tween_EaseType:

enum **EaseType**

- **EASE_IN** = **0** --- The interpolation starts slowly and speeds up towards the end.
- **EASE_OUT** = **1** --- The interpolation starts quickly and slows down towards the end.
- **EASE_IN_OUT** = **2** --- A combination of EASE_IN and EASE_OUT. The interpolation is slowest at both ends.
- **EASE_OUT_IN** = **3** --- A combination of EASE_IN and EASE_OUT. The interpolation is fastest at both ends.

  .. _enum_Tween_TransitionType:

enum **TransitionType**

- **TRANS_LINEAR** = **0** --- The animation is interpolated linearly.
- **TRANS_SINE** = **1** --- The animation is interpolated using a sine function.
- **TRANS_QUINT** = **2** --- The animation is interpolated with a quintic (to the power of 5) function.
- **TRANS_QUART** = **3** --- The animation is interpolated with a quartic (to the power of 4) function.
- **TRANS_QUAD** = **4** --- The animation is interpolated with a quadratic (to the power of 2) function.
- **TRANS_EXPO** = **5** --- The animation is interpolated with an exponential (to the power of x) function.
- **TRANS_ELASTIC** = **6** --- The animation is interpolated with elasticity, wiggling around the edges.
- **TRANS_CUBIC** = **7** --- The animation is interpolated with a cubic (to the power of 3) function.
- **TRANS_CIRC** = **8** --- The animation is interpolated with a function using square roots.
- **TRANS_BOUNCE** = **9** --- The animation is interpolated by bouncing at the end.
- **TRANS_BACK** = **10** --- The animation is interpolated backing out at ends.


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

Tweens are useful for animations requiring a numerical property to be interpolated over a range of values. The name \*tween\* comes from \*in-betweening\*, an animation technique where you specify \*keyframes\* and the computer interpolates the frames that appear between them.

Here is a brief usage example that causes a 2D node to move smoothly between two positions:

::

    var tween = get_node("Tween")
    tween.interpolate_property($Node2D, "position",
                    Vector2(0, 0), Vector2(100, 100), 1,
                    Tween.TRANS_LINEAR, Tween.EASE_IN_OUT)
    tween.start()

Many methods require a property name, such as "position" above. You can find the correct property name by hovering over the property in the Inspector.

Many of the methods accept ``trans_type`` and ``ease_type``. The first accepts an enum TransitionType constant, and refers to the way the timing of the animation is handled (see ``http://easings.net/`` for some examples). The second accepts an enum EaseType constant, and controls the where ``trans_type`` is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different enum TransitionType constants with enum EASE_IN_OUT, and use the one that looks best.

Member Function Description
---------------------------

.. _class_Tween_follow_method:

- :ref:`bool<class_bool>` **follow_method** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` initial_val, :ref:`Object<class_object>` target, :ref:`String<class_string>` target_method, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)**

Follows ``method`` of ``object`` and applies the returned value on ``target_method`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` later. Methods are called with consecutive values.

                Use enum TransitionType for ``trans_type`` and enum EaseType for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information

.. _class_Tween_follow_property:

- :ref:`bool<class_bool>` **follow_property** **(** :ref:`Object<class_object>` object, :ref:`NodePath<class_nodepath>` property, :ref:`Variant<class_variant>` initial_val, :ref:`Object<class_object>` target, :ref:`NodePath<class_nodepath>` target_property, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)**

Follows ``property`` of ``object`` and applies it on ``target_property`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` seconds later.

                Use enum TransitionType for ``trans_type`` and enum EaseType for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information

.. _class_Tween_get_runtime:

- :ref:`float<class_float>` **get_runtime** **(** **)** const

Returns the total time needed for all tweens to end. If you have two tweens, one lasting 10 seconds and the other 20 seconds, it would return 20 seconds, as by that time all tweens would have finished.

.. _class_Tween_interpolate_callback:

- :ref:`bool<class_bool>` **interpolate_callback** **(** :ref:`Object<class_object>` object, :ref:`float<class_float>` duration, :ref:`String<class_string>` callback, :ref:`Variant<class_variant>` arg1=null, :ref:`Variant<class_variant>` arg2=null, :ref:`Variant<class_variant>` arg3=null, :ref:`Variant<class_variant>` arg4=null, :ref:`Variant<class_variant>` arg5=null **)**

Calls ``callback`` of ``object`` after ``duration``. ``arg1``-``arg5`` are arguments to be passed to the callback.

.. _class_Tween_interpolate_deferred_callback:

- :ref:`bool<class_bool>` **interpolate_deferred_callback** **(** :ref:`Object<class_object>` object, :ref:`float<class_float>` duration, :ref:`String<class_string>` callback, :ref:`Variant<class_variant>` arg1=null, :ref:`Variant<class_variant>` arg2=null, :ref:`Variant<class_variant>` arg3=null, :ref:`Variant<class_variant>` arg4=null, :ref:`Variant<class_variant>` arg5=null **)**

Calls ``callback`` of ``object`` after ``duration`` on the main thread (similar to :ref:`Object.call_deferred<class_Object_call_deferred>`). ``arg1``-``arg5`` are arguments to be passed to the callback.

.. _class_Tween_interpolate_method:

- :ref:`bool<class_bool>` **interpolate_method** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` initial_val, :ref:`Variant<class_variant>` final_val, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)**

Animates ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are called with consecutive values.

                Use enum TransitionType for ``trans_type`` and enum EaseType for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information

.. _class_Tween_interpolate_property:

- :ref:`bool<class_bool>` **interpolate_property** **(** :ref:`Object<class_object>` object, :ref:`NodePath<class_nodepath>` property, :ref:`Variant<class_variant>` initial_val, :ref:`Variant<class_variant>` final_val, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)**

Animates ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later.

                Use enum TransitionType for ``trans_type`` and enum EaseType for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information

.. _class_Tween_is_active:

- :ref:`bool<class_bool>` **is_active** **(** **)** const

Returns ``true`` if any tweens are currently running. Note that this method doesn't consider tweens that have ended.

.. _class_Tween_remove:

- :ref:`bool<class_bool>` **remove** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)**

Stops animation and removes a tween, given its object and property/method pair. By default, all tweens are removed, unless ``key`` is specified.

.. _class_Tween_remove_all:

- :ref:`bool<class_bool>` **remove_all** **(** **)**

Stops animation and removes all tweens.

.. _class_Tween_reset:

- :ref:`bool<class_bool>` **reset** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)**

Resets a tween to its initial value (the one given, not the one before the tween), given its object and property/method pair. By default, all tweens are removed, unless ``key`` is specified.

.. _class_Tween_reset_all:

- :ref:`bool<class_bool>` **reset_all** **(** **)**

Resets all tweens to their initial values (the ones given, not those before the tween).

.. _class_Tween_resume:

- :ref:`bool<class_bool>` **resume** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)**

Continues animating a stopped tween, given its object and property/method pair. By default, all tweens are resumed, unless ``key`` is specified.

.. _class_Tween_resume_all:

- :ref:`bool<class_bool>` **resume_all** **(** **)**

Continues animating all stopped tweens.

.. _class_Tween_seek:

- :ref:`bool<class_bool>` **seek** **(** :ref:`float<class_float>` time **)**

Sets the interpolation to the given ``time`` in seconds.

.. _class_Tween_set_active:

- void **set_active** **(** :ref:`bool<class_bool>` active **)**

Activates/deactivates the tween. See also :ref:`stop_all<class_Tween_stop_all>` and :ref:`resume_all<class_Tween_resume_all>`.

.. _class_Tween_start:

- :ref:`bool<class_bool>` **start** **(** **)**

Starts the tween. You can define animations both before and after this.

.. _class_Tween_stop:

- :ref:`bool<class_bool>` **stop** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)**

Stops a tween, given its object and property/method pair. By default, all tweens are stopped, unless ``key`` is specified.

.. _class_Tween_stop_all:

- :ref:`bool<class_bool>` **stop_all** **(** **)**

Stops animating all tweens.

.. _class_Tween_targeting_method:

- :ref:`bool<class_bool>` **targeting_method** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method, :ref:`Object<class_object>` initial, :ref:`String<class_string>` initial_method, :ref:`Variant<class_variant>` final_val, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)**

Animates ``method`` of ``object`` from the value returned by ``initial_method`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecutive values.

                Use enum TransitionType for ``trans_type`` and enum EaseType for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information

.. _class_Tween_targeting_property:

- :ref:`bool<class_bool>` **targeting_property** **(** :ref:`Object<class_object>` object, :ref:`NodePath<class_nodepath>` property, :ref:`Object<class_object>` initial, :ref:`NodePath<class_nodepath>` initial_val, :ref:`Variant<class_variant>` final_val, :ref:`float<class_float>` duration, :ref:`int<class_int>` trans_type, :ref:`int<class_int>` ease_type, :ref:`float<class_float>` delay=0 **)**

Animates ``property`` of ``object`` from the current value of the ``initial_val`` property of ``initial`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later.

                Use enum TransitionType for ``trans_type`` and enum EaseType for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information

.. _class_Tween_tell:

- :ref:`float<class_float>` **tell** **(** **)** const

Returns the current time of the tween.