class_callbacktweener.rst 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the CallbackTweener.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CallbackTweener:
  6. CallbackTweener
  7. ===============
  8. **Inherits:** :ref:`Tweener<class_Tweener>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Calls the specified method after optional delay.
  10. Description
  11. -----------
  12. ``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.
  13. \ **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.
  14. Methods
  15. -------
  16. +-----------------------------------------------+------------------------------------------------------------------------------------------------------+
  17. | :ref:`CallbackTweener<class_CallbackTweener>` | :ref:`set_delay<class_CallbackTweener_method_set_delay>` **(** :ref:`float<class_float>` delay **)** |
  18. +-----------------------------------------------+------------------------------------------------------------------------------------------------------+
  19. Method Descriptions
  20. -------------------
  21. .. _class_CallbackTweener_method_set_delay:
  22. - :ref:`CallbackTweener<class_CallbackTweener>` **set_delay** **(** :ref:`float<class_float>` delay **)**
  23. Makes the callback call delayed by given time in seconds. Example:
  24. ::
  25. var tween = get_tree().create_tween()
  26. tween.tween_callback(queue_free).set_delay(2) #this will call queue_free() after 2 seconds
  27. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  28. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  29. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`