Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
PropertyTweener
Hereda: Tweener < RefCounted < Object
Interpola una propiedad de un Object a lo largo del tiempo.
Descripción
PropertyTweener se usa para interpolar una propiedad en un objeto. Véase Tween.tween_property() para obtener más información de uso.
El tweener finalizará automáticamente si el objeto de destino es liberado.
Nota: Tween.tween_property() es la única forma correcta de crear PropertyTweener. Cualquier PropertyTweener creado manualmente no funcionará correctamente.
Métodos
set_custom_interpolator(interpolator_method: Callable) |
|
set_trans(trans: TransitionType) |
Descripciones de Métodos
PropertyTweener as_relative() 🔗
Cuando se llama, el valor final se usará como un valor relativo en su lugar.
Ejemplo: Mueve el nodo 100 píxeles a la derecha.
var tween = get_tree().create_tween()
tween.tween_property(self, "position", Vector2.RIGHT * 100, 1).as_relative()
Tween tween = GetTree().CreateTween();
tween.TweenProperty(this, "position", Vector2.Right * 100.0f, 1.0f).AsRelative();
PropertyTweener from(value: Variant) 🔗
Sets a custom initial value to the PropertyTweener.
Example: Move the node from position (100, 100) to (200, 100).
var tween = get_tree().create_tween()
tween.tween_property(self, "position", Vector2(200, 100), 1).from(Vector2(100, 100))
Tween tween = GetTree().CreateTween();
tween.TweenProperty(this, "position", new Vector2(200.0f, 100.0f), 1.0f).From(new Vector2(100.0f, 100.0f));
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()
tween.TweenProperty(this, "position", new Vector2(200.0f, 100.0f), 1.0f).From(Position);
tween.TweenProperty(this, "position", new Vector2(200.0f, 100.0f), 1.0f).FromCurrent();
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.
@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)
[Export]
public Curve Curve { get; set; }
public override void _Ready()
{
Tween tween = CreateTween();
// Interpolate the value using a custom curve.
Callable tweenCurveCallable = Callable.From<float, float>(TweenCurve);
tween.TweenProperty(this, "position:x", 300.0f, 1.0f).AsRelative().SetCustomInterpolator(tweenCurveCallable);
}
private float TweenCurve(float value)
{
return Curve.SampleBaked(value);
}
PropertyTweener set_delay(delay: float) 🔗
Establece el tiempo en segundos después del cual el PropertyTweener comenzará a interpolar. Por defecto no hay retardo.
PropertyTweener set_ease(ease: EaseType) 🔗
Establece el tipo de easing usado de EaseType. Si no se establece, se usa el easing por defecto del Tween que contiene este Tweener.
PropertyTweener set_trans(trans: TransitionType) 🔗
Establece el tipo de transición usada de TransitionType. Si no se establece, se usa la transición por defecto del Tween que contiene este Tweener.