.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. .. _class_Tween: Tween ===== **Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- Member Functions ---------------- +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_active` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_active` **(** :ref:`bool` active **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_repeat` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_repeat` **(** :ref:`bool` repeat **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_speed` **(** :ref:`float` speed **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_speed` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tween_process_mode` **(** :ref:`int` mode **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tween_process_mode` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`start` **(** **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`reset_all` **(** **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`stop_all` **(** **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`resume_all` **(** **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`remove_all` **(** **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`seek` **(** :ref:`float` time **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tell` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_runtime` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`String` property, var initial_val, var final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, var initial_val, var final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interpolate_callback` **(** :ref:`Object` object, :ref:`float` times_in_sec, :ref:`String` callback, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL, var arg5=NULL **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` times_in_sec, :ref:`String` callback, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL, var arg5=NULL **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`String` property, var initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, var initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, var final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, var final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **tween_complete** **(** :ref:`Object` object, :ref:`String` key **)** - **tween_step** **(** :ref:`Object` object, :ref:`String` key, :ref:`float` elapsed, :ref:`Object` value **)** - **tween_start** **(** :ref:`Object` object, :ref:`String` key **)** Numeric Constants ----------------- - **TWEEN_PROCESS_FIXED** = **0** - **TWEEN_PROCESS_IDLE** = **1** - **TRANS_LINEAR** = **0** - **TRANS_SINE** = **1** - **TRANS_QUINT** = **2** - **TRANS_QUART** = **3** - **TRANS_QUAD** = **4** - **TRANS_EXPO** = **5** - **TRANS_ELASTIC** = **6** - **TRANS_CUBIC** = **7** - **TRANS_CIRC** = **8** - **TRANS_BOUNCE** = **9** - **TRANS_BACK** = **10** - **EASE_IN** = **0** - **EASE_OUT** = **1** - **EASE_IN_OUT** = **2** - **EASE_OUT_IN** = **3** Member Function Description --------------------------- .. _class_Tween_is_active: - :ref:`bool` **is_active** **(** **)** const .. _class_Tween_set_active: - void **set_active** **(** :ref:`bool` active **)** .. _class_Tween_is_repeat: - :ref:`bool` **is_repeat** **(** **)** const .. _class_Tween_set_repeat: - void **set_repeat** **(** :ref:`bool` repeat **)** .. _class_Tween_set_speed: - void **set_speed** **(** :ref:`float` speed **)** .. _class_Tween_get_speed: - :ref:`float` **get_speed** **(** **)** const .. _class_Tween_set_tween_process_mode: - void **set_tween_process_mode** **(** :ref:`int` mode **)** .. _class_Tween_get_tween_process_mode: - :ref:`int` **get_tween_process_mode** **(** **)** const .. _class_Tween_start: - :ref:`bool` **start** **(** **)** .. _class_Tween_reset: - :ref:`bool` **reset** **(** :ref:`Object` object, :ref:`String` key **)** .. _class_Tween_reset_all: - :ref:`bool` **reset_all** **(** **)** .. _class_Tween_stop: - :ref:`bool` **stop** **(** :ref:`Object` object, :ref:`String` key **)** .. _class_Tween_stop_all: - :ref:`bool` **stop_all** **(** **)** .. _class_Tween_resume: - :ref:`bool` **resume** **(** :ref:`Object` object, :ref:`String` key **)** .. _class_Tween_resume_all: - :ref:`bool` **resume_all** **(** **)** .. _class_Tween_remove: - :ref:`bool` **remove** **(** :ref:`Object` object, :ref:`String` key **)** .. _class_Tween_remove_all: - :ref:`bool` **remove_all** **(** **)** .. _class_Tween_seek: - :ref:`bool` **seek** **(** :ref:`float` time **)** .. _class_Tween_tell: - :ref:`float` **tell** **(** **)** const .. _class_Tween_get_runtime: - :ref:`float` **get_runtime** **(** **)** const .. _class_Tween_interpolate_property: - :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`String` property, var initial_val, var final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** .. _class_Tween_interpolate_method: - :ref:`bool` **interpolate_method** **(** :ref:`Object` object, :ref:`String` method, var initial_val, var final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** .. _class_Tween_interpolate_callback: - :ref:`bool` **interpolate_callback** **(** :ref:`Object` object, :ref:`float` times_in_sec, :ref:`String` callback, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL, var arg5=NULL **)** .. _class_Tween_interpolate_deferred_callback: - :ref:`bool` **interpolate_deferred_callback** **(** :ref:`Object` object, :ref:`float` times_in_sec, :ref:`String` callback, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL, var arg5=NULL **)** .. _class_Tween_follow_property: - :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`String` property, var initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** .. _class_Tween_follow_method: - :ref:`bool` **follow_method** **(** :ref:`Object` object, :ref:`String` method, var initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** .. _class_Tween_targeting_property: - :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, var final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** .. _class_Tween_targeting_method: - :ref:`bool` **targeting_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, var final_val, :ref:`float` times_in_sec, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)**