PropertyTweener

Inherits: Tweener < RefCounted < Object

Interpolates an Object's property over time.

Description

PropertyTweener is used to interpolate a property in an object. See Tween.tween_property for more usage information.

Note: Tween.tween_property is the only correct way to create PropertyTweener. Any PropertyTweener created manually will not function correctly.

Methods

PropertyTweener	as_relative()
PropertyTweener	from(value: Variant)
PropertyTweener	from_current()
PropertyTweener	set_custom_interpolator(interpolator_method: Callable)
PropertyTweener	set_delay(delay: float)
PropertyTweener	set_ease(ease: EaseType)
PropertyTweener	set_trans(trans: TransitionType)

---

Method Descriptions

PropertyTweener as_relative() 🔗

When called, the final value will be used as a relative value instead.

Example:

var tween = get_tree().create_tween()
tween.tween_property(self, "position", Vector2.RIGHT * 100, 1).as_relative() #the node will move by 100 pixels to the right

---

PropertyTweener from(value: Variant) 🔗

Sets a custom initial value to the PropertyTweener.

Example:

var tween = get_tree().create_tween()
tween.tween_property(self, "position", Vector2(200, 100), 1).from(Vector2(100, 100)) #this will move the node from position (100, 100) to (200, 100)

---

PropertyTweener from_current() 🔗

Makes the PropertyTweener use the current property value (i.e. at the time of creating this PropertyTweener) as a starting point. This is equivalent of using from with the current value. These two calls will do the same:

tween.tween_property(self, "position", Vector2(200, 100), 1).from(position)
tween.tween_property(self, "position", Vector2(200, 100), 1).from_current()

---

PropertyTweener set_custom_interpolator(interpolator_method: Callable) 🔗

Allows interpolating the value with a custom easing function. The provided interpolator_method will be called with a value ranging from 0.0 to 1.0 and is expected to return a value within the same range (values outside the range can be used for overshoot). The return value of the method is then used for interpolation between initial and final value. Note that the parameter passed to the method is still subject to the tweener's own easing.

Example:

@export var curve: Curve

func _ready():
    var tween = create_tween()
    # Interpolate the value using a custom curve.
    tween.tween_property(self, "position:x", 300, 1).as_relative().set_custom_interpolator(tween_curve)

func tween_curve(v):
    return curve.sample_baked(v)

---

PropertyTweener set_delay(delay: float) 🔗

Sets the time in seconds after which the PropertyTweener will start interpolating. By default there's no delay.

---

PropertyTweener set_ease(ease: EaseType) 🔗

Sets the type of used easing from EaseType. If not set, the default easing is used from the Tween that contains this Tweener.

---

PropertyTweener set_trans(trans: TransitionType) 🔗

Sets the type of used transition from TransitionType. If not set, the default transition is used from the Tween that contains this Tweener.