.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/Tween.xml. .. _class_Tween: Tween ===== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tween` | :ref:`bind_node` **(** :ref:`Node` node **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tween` | :ref:`chain` **(** **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`custom_step` **(** :ref:`float` delta **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_loops_left` **(** **)** |const| | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_total_elapsed_time` **(** **)** |const| | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`interpolate_value` **(** :ref:`Variant` initial_value, :ref:`Variant` delta_value, :ref:`float` elapsed_time, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type **)** |static| | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_running` **(** **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid` **(** **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`kill` **(** **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tween` | :ref:`parallel` **(** **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`pause` **(** **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`play` **(** **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tween` | :ref:`set_ease` **(** :ref:`EaseType` ease **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tween` | :ref:`set_loops` **(** :ref:`int` loops=0 **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tween` | :ref:`set_parallel` **(** :ref:`bool` parallel=true **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tween` | :ref:`set_pause_mode` **(** :ref:`TweenPauseMode` mode **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tween` | :ref:`set_process_mode` **(** :ref:`TweenProcessMode` mode **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tween` | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tween` | :ref:`set_trans` **(** :ref:`TransitionType` trans **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`CallbackTweener` | :ref:`tween_callback` **(** :ref:`Callable` callback **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`IntervalTweener` | :ref:`tween_interval` **(** :ref:`float` time **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`MethodTweener` | :ref:`tween_method` **(** :ref:`Callable` method, :ref:`Variant` from, :ref:`Variant` to, :ref:`float` duration **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PropertyTweener` | :ref:`tween_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` final_val, :ref:`float` duration **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_Tween_signal_finished: .. rst-class:: classref-signal **finished** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_signal_loop_finished: .. rst-class:: classref-signal **loop_finished** **(** :ref:`int` loop_count **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_signal_step_finished: .. rst-class:: classref-signal **step_finished** **(** :ref:`int` idx **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_Tween_TweenProcessMode: .. rst-class:: classref-enumeration enum **TweenProcessMode**: .. _class_Tween_constant_TWEEN_PROCESS_PHYSICS: .. rst-class:: classref-enumeration-constant :ref:`TweenProcessMode` **TWEEN_PROCESS_PHYSICS** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TWEEN_PROCESS_IDLE: .. rst-class:: classref-enumeration-constant :ref:`TweenProcessMode` **TWEEN_PROCESS_IDLE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_Tween_TweenPauseMode: .. rst-class:: classref-enumeration enum **TweenPauseMode**: .. _class_Tween_constant_TWEEN_PAUSE_BOUND: .. rst-class:: classref-enumeration-constant :ref:`TweenPauseMode` **TWEEN_PAUSE_BOUND** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TWEEN_PAUSE_STOP: .. rst-class:: classref-enumeration-constant :ref:`TweenPauseMode` **TWEEN_PAUSE_STOP** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TWEEN_PAUSE_PROCESS: .. rst-class:: classref-enumeration-constant :ref:`TweenPauseMode` **TWEEN_PAUSE_PROCESS** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_Tween_TransitionType: .. rst-class:: classref-enumeration enum **TransitionType**: .. _class_Tween_constant_TRANS_LINEAR: .. rst-class:: classref-enumeration-constant :ref:`TransitionType` **TRANS_LINEAR** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TRANS_SINE: .. rst-class:: classref-enumeration-constant :ref:`TransitionType` **TRANS_SINE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TRANS_QUINT: .. rst-class:: classref-enumeration-constant :ref:`TransitionType` **TRANS_QUINT** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TRANS_QUART: .. rst-class:: classref-enumeration-constant :ref:`TransitionType` **TRANS_QUART** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TRANS_QUAD: .. rst-class:: classref-enumeration-constant :ref:`TransitionType` **TRANS_QUAD** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TRANS_EXPO: .. rst-class:: classref-enumeration-constant :ref:`TransitionType` **TRANS_EXPO** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TRANS_ELASTIC: .. rst-class:: classref-enumeration-constant :ref:`TransitionType` **TRANS_ELASTIC** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TRANS_CUBIC: .. rst-class:: classref-enumeration-constant :ref:`TransitionType` **TRANS_CUBIC** = ``7`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TRANS_CIRC: .. rst-class:: classref-enumeration-constant :ref:`TransitionType` **TRANS_CIRC** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TRANS_BOUNCE: .. rst-class:: classref-enumeration-constant :ref:`TransitionType` **TRANS_BOUNCE** = ``9`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TRANS_BACK: .. rst-class:: classref-enumeration-constant :ref:`TransitionType` **TRANS_BACK** = ``10`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_TRANS_SPRING: .. rst-class:: classref-enumeration-constant :ref:`TransitionType` **TRANS_SPRING** = ``11`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_Tween_EaseType: .. rst-class:: classref-enumeration enum **EaseType**: .. _class_Tween_constant_EASE_IN: .. rst-class:: classref-enumeration-constant :ref:`EaseType` **EASE_IN** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_EASE_OUT: .. rst-class:: classref-enumeration-constant :ref:`EaseType` **EASE_OUT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_EASE_IN_OUT: .. rst-class:: classref-enumeration-constant :ref:`EaseType` **EASE_IN_OUT** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Tween_constant_EASE_OUT_IN: .. rst-class:: classref-enumeration-constant :ref:`EaseType` **EASE_OUT_IN** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Tween_method_bind_node: .. rst-class:: classref-method :ref:`Tween` **bind_node** **(** :ref:`Node` node **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_chain: .. rst-class:: classref-method :ref:`Tween` **chain** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_custom_step: .. rst-class:: classref-method :ref:`bool` **custom_step** **(** :ref:`float` delta **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_get_loops_left: .. rst-class:: classref-method :ref:`int` **get_loops_left** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_get_total_elapsed_time: .. rst-class:: classref-method :ref:`float` **get_total_elapsed_time** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_interpolate_value: .. rst-class:: classref-method :ref:`Variant` **interpolate_value** **(** :ref:`Variant` initial_value, :ref:`Variant` delta_value, :ref:`float` elapsed_time, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_is_running: .. rst-class:: classref-method :ref:`bool` **is_running** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_is_valid: .. rst-class:: classref-method :ref:`bool` **is_valid** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_kill: .. rst-class:: classref-method void **kill** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_parallel: .. rst-class:: classref-method :ref:`Tween` **parallel** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_pause: .. rst-class:: classref-method void **pause** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_play: .. rst-class:: classref-method void **play** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_set_ease: .. rst-class:: classref-method :ref:`Tween` **set_ease** **(** :ref:`EaseType` ease **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_set_loops: .. rst-class:: classref-method :ref:`Tween` **set_loops** **(** :ref:`int` loops=0 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_set_parallel: .. rst-class:: classref-method :ref:`Tween` **set_parallel** **(** :ref:`bool` parallel=true **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_set_pause_mode: .. rst-class:: classref-method :ref:`Tween` **set_pause_mode** **(** :ref:`TweenPauseMode` mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_set_process_mode: .. rst-class:: classref-method :ref:`Tween` **set_process_mode** **(** :ref:`TweenProcessMode` mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_set_speed_scale: .. rst-class:: classref-method :ref:`Tween` **set_speed_scale** **(** :ref:`float` speed **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_set_trans: .. rst-class:: classref-method :ref:`Tween` **set_trans** **(** :ref:`TransitionType` trans **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_stop: .. rst-class:: classref-method void **stop** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_tween_callback: .. rst-class:: classref-method :ref:`CallbackTweener` **tween_callback** **(** :ref:`Callable` callback **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_tween_interval: .. rst-class:: classref-method :ref:`IntervalTweener` **tween_interval** **(** :ref:`float` time **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_tween_method: .. rst-class:: classref-method :ref:`MethodTweener` **tween_method** **(** :ref:`Callable` method, :ref:`Variant` from, :ref:`Variant` to, :ref:`float` duration **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Tween_method_tween_property: .. rst-class:: classref-method :ref:`PropertyTweener` **tween_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` final_val, :ref:`float` duration **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`