| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the MethodTweener.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_MethodTweener:
- MethodTweener
- =============
- **Inherits:** :ref:`Tweener<class_Tweener>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- Interpolates an abstract value and supplies it to a method called over time.
- Description
- -----------
- ``MethodTweener`` is similar to a combination of :ref:`CallbackTweener<class_CallbackTweener>` and :ref:`PropertyTweener<class_PropertyTweener>`. It calls a method providing an interpolated value as a parameter. See :ref:`Tween.tween_method<class_Tween_method_tween_method>` for more usage information.
- \ **Note:** :ref:`Tween.tween_method<class_Tween_method_tween_method>` is the only correct way to create ``MethodTweener``. Any ``MethodTweener`` created manually will not function correctly.
- Methods
- -------
- +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
- | :ref:`MethodTweener<class_MethodTweener>` | :ref:`set_delay<class_MethodTweener_method_set_delay>` **(** :ref:`float<class_float>` delay **)** |
- +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
- | :ref:`MethodTweener<class_MethodTweener>` | :ref:`set_ease<class_MethodTweener_method_set_ease>` **(** :ref:`EaseType<enum_Tween_EaseType>` ease **)** |
- +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
- | :ref:`MethodTweener<class_MethodTweener>` | :ref:`set_trans<class_MethodTweener_method_set_trans>` **(** :ref:`TransitionType<enum_Tween_TransitionType>` trans **)** |
- +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
- Method Descriptions
- -------------------
- .. _class_MethodTweener_method_set_delay:
- - :ref:`MethodTweener<class_MethodTweener>` **set_delay** **(** :ref:`float<class_float>` delay **)**
- Sets the time in seconds after which the ``MethodTweener`` will start interpolating. By default there's no delay.
- ----
- .. _class_MethodTweener_method_set_ease:
- - :ref:`MethodTweener<class_MethodTweener>` **set_ease** **(** :ref:`EaseType<enum_Tween_EaseType>` ease **)**
- Sets the type of used easing from :ref:`EaseType<enum_Tween_EaseType>`. If not set, the default easing is used from the :ref:`Tween<class_Tween>` that contains this Tweener.
- ----
- .. _class_MethodTweener_method_set_trans:
- - :ref:`MethodTweener<class_MethodTweener>` **set_trans** **(** :ref:`TransitionType<enum_Tween_TransitionType>` trans **)**
- Sets the type of used transition from :ref:`TransitionType<enum_Tween_TransitionType>`. If not set, the default transition is used from the :ref:`Tween<class_Tween>` that contains this Tweener.
- .. |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.)`
|
