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.

Method Descriptions

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

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)

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()

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


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


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