Files
godot-docs/classes/class_callbacktweener.rst
2022-04-29 14:16:57 +02:00

47 lines
2.1 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CallbackTweener.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CallbackTweener:
CallbackTweener
===============
**Inherits:** :ref:`Tweener<class_Tweener>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Calls the specified method after optional delay.
Description
-----------
``CallbackTweener`` is used to call a method in a tweening sequence. See :ref:`SceneTreeTween.tween_callback<class_SceneTreeTween_method_tween_callback>` for more usage information.
\ **Note:** :ref:`SceneTreeTween.tween_callback<class_SceneTreeTween_method_tween_callback>` is the only correct way to create ``CallbackTweener``. Any ``CallbackTweener`` created manually will not function correctly.
Methods
-------
+-----------------------------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`CallbackTweener<class_CallbackTweener>` | :ref:`set_delay<class_CallbackTweener_method_set_delay>` **(** :ref:`float<class_float>` delay **)** |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------+
Method Descriptions
-------------------
.. _class_CallbackTweener_method_set_delay:
- :ref:`CallbackTweener<class_CallbackTweener>` **set_delay** **(** :ref:`float<class_float>` delay **)**
Makes the callback call delayed by given time in seconds. Example:
::
var tween = get_tree().create_tween()
tween.tween_callback(queue_free).set_delay(2) #this will call queue_free() after 2 seconds
.. |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.)`