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

Hérite de : Tweener < RefCounted < Object

Interpole une propriété d'un Object dans le temps.

Description

PropertyTweener est utilisé pour interpoler une propriété dans un objet. Voir Tween.tween_property() pour plus d'informations.

Le tweener se finira automatiquement si l'objet cible est libéré.

Note : Tween.tween_property() est le seul moyen correct de créer un PropertyTweener. Les PropertyTweener créés manuellement ne fonctionneront pas correctement.

Méthodes

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)

Descriptions des méthodes

PropertyTweener as_relative() 🔗

Quand appelée, la valeur finale sera utilisée comme une valeur relative à la place.

Exemple : Déplacer le nœud de 100 pixels vers la droite.

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

Définit une valeur initiale personnalisée pour le PropertyTweener.

Exemple : Déplacer le nœud de la position (100, 100) à (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() 🔗

Fait que ce PropertyTweener utilisera la valeur de propriété actuelle (c'est-à-dire au moment de créer ce PropertyTweener) comme point de départ. Ceci est équivalent à l'utilisation de from() avec la valeur actuelle. Ces deux appels sont identiques :

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

Définit le délai en secondes avant que le PropertyTweener commence son interpolation. Par défaut, il n'y a pas de délai.

PropertyTweener set_ease(ease: EaseType) 🔗

Définit le type de comportement utilisé pour EaseType. Si non défini, le comportement par défaut sera celui utilisé dans le Tween qui contient ce Tweener.

PropertyTweener set_trans(trans: TransitionType) 🔗

Définit le type de transition utilisée pour TransitionType. Si non défini, la transition par défaut sera celle utilisée dans le Tween qui contient ce Tweener.