diff options
| author | Thaddeus Crews <repiteo@outlook.com> | 2024-11-12 12:12:59 -0600 |
|---|---|---|
| committer | Thaddeus Crews <repiteo@outlook.com> | 2024-11-12 12:12:59 -0600 |
| commit | a5c5504dc2c872ec869f4feadc7528e2fb93566e (patch) | |
| tree | 2ac2649a79bd422c49f2d1a9e5f500a841c2e8da | |
| parent | caff0ff591ed63234474c46a6fd868661aa8ea01 (diff) | |
| parent | 47be06b6ea432c3c1c31d0c4c623a8a544c8afef (diff) | |
| download | redot-engine-a5c5504dc2c872ec869f4feadc7528e2fb93566e.tar.gz | |
Merge pull request #98689 from Meorge/tween-docs
Improve `Tween.set_ease` and `Tween.set_trans` documentation
| -rw-r--r-- | doc/classes/Tween.xml | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index 3ad0a73b41..147d9fa4bd 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -218,8 +218,14 @@ <return type="Tween" /> <param index="0" name="ease" type="int" enum="Tween.EaseType" /> <description> - Sets the default ease type for [PropertyTweener]s and [MethodTweener]s animated by this [Tween]. - If not specified, the default value is [constant EASE_IN_OUT]. + Sets the default ease type for [PropertyTweener]s and [MethodTweener]s appended after this method. + Before this method is called, the default ease type is [constant EASE_IN_OUT]. + [codeblock] + var tween = create_tween() + tween.tween_property(self, "position", Vector2(300, 0), 0.5) # Uses EASE_IN_OUT. + tween.set_ease(Tween.EASE_IN) + tween.tween_property(self, "rotation_degrees", 45.0, 0.5) # Uses EASE_IN. + [/codeblock] </description> </method> <method name="set_loops"> @@ -271,8 +277,14 @@ <return type="Tween" /> <param index="0" name="trans" type="int" enum="Tween.TransitionType" /> <description> - Sets the default transition type for [PropertyTweener]s and [MethodTweener]s animated by this [Tween]. - If not specified, the default value is [constant TRANS_LINEAR]. + Sets the default transition type for [PropertyTweener]s and [MethodTweener]s appended after this method. + Before this method is called, the default transition type is [constant TRANS_LINEAR]. + [codeblock] + var tween = create_tween() + tween.tween_property(self, "position", Vector2(300, 0), 0.5) # Uses TRANS_LINEAR. + tween.set_trans(Tween.TRANS_SINE) + tween.tween_property(self, "rotation_degrees", 45.0, 0.5) # Uses TRANS_SINE. + [/codeblock] </description> </method> <method name="stop"> |