From 7ba1789b13768a01a99c49923dac3d0a2f9803a3 Mon Sep 17 00:00:00 2001 From: Bossdell113 Date: Tue, 26 Nov 2024 20:06:24 -0500 Subject: [PATCH] Update PropertyTweener.xml Adding C# examples to PropertyTweener Docs for the following methods as_relative from from_current set_custom_interpolator Co-Authored-By: tetrapod <145553014+tetrapod00@users.noreply.github.com> --- doc/classes/PropertyTweener.xml | 53 ++++++++++++++++++++++++++++----- 1 file changed, 45 insertions(+), 8 deletions(-) diff --git a/doc/classes/PropertyTweener.xml b/doc/classes/PropertyTweener.xml index 76cf4cbfeb5e..08ce876e9181 100644 --- a/doc/classes/PropertyTweener.xml +++ b/doc/classes/PropertyTweener.xml @@ -16,10 +16,16 @@ When called, the final value will be used as a relative value instead. [b]Example:[/b] Move the node by [code]100[/code] pixels to the right. - [codeblock] + [codeblocks] + [gdscript] var tween = get_tree().create_tween() tween.tween_property(self, "position", Vector2.RIGHT * 100, 1).as_relative() - [/codeblock] + [/gdscript] + [csharp] + Tween tween = GetTree().CreateTween(); + tween.TweenProperty(this, "position", Vector2.Right * 100.0f, 1.0f).AsRelative(); + [/csharp] + [/codeblocks] @@ -28,20 +34,32 @@ Sets a custom initial value to the [PropertyTweener]. [b]Example:[/b] Move the node from position [code](100, 100)[/code] to [code](200, 100)[/code]. - [codeblock] + [codeblocks] + [gdscript] var tween = get_tree().create_tween() tween.tween_property(self, "position", Vector2(200, 100), 1).from(Vector2(100, 100)) - [/codeblock] + [/gdscript] + [csharp] + Tween tween = GetTree().CreateTween(); + tween.TweenProperty(this, "position", new Vector2(200.0f, 100.0f), 1.0f).From(new Vector2(100.0f, 100.0f)); + [/csharp] + [/codeblocks] 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 [method from] with the current value. These two calls will do the same: - [codeblock] + [codeblocks] + [gdscript] tween.tween_property(self, "position", Vector2(200, 100), 1).from(position) tween.tween_property(self, "position", Vector2(200, 100), 1).from_current() - [/codeblock] + [/gdscript] + [csharp] + 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(); + [/csharp] + [/codeblocks] @@ -49,7 +67,8 @@ Allows interpolating the value with a custom easing function. The provided [param interpolator_method] will be called with a value ranging from [code]0.0[/code] to [code]1.0[/code] 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. - [codeblock] + [codeblocks] + [gdscript] @export var curve: Curve func _ready(): @@ -59,7 +78,25 @@ func tween_curve(v): return curve.sample_baked(v) - [/codeblock] + [/gdscript] + [csharp] + [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); + } + [/csharp] + [/codeblocks]