Merge pull request #98689 from Meorge/tween-docs

Improve `Tween.set_ease` and `Tween.set_trans` documentation
This commit is contained in:
Thaddeus Crews 2024-11-12 12:12:59 -06:00
commit a5c5504dc2
No known key found for this signature in database
GPG Key ID: 62181B86FE9E5D84

View File

@ -218,8 +218,14 @@
<return type="Tween" /> <return type="Tween" />
<param index="0" name="ease" type="int" enum="Tween.EaseType" /> <param index="0" name="ease" type="int" enum="Tween.EaseType" />
<description> <description>
Sets the default ease type for [PropertyTweener]s and [MethodTweener]s animated by this [Tween]. Sets the default ease type for [PropertyTweener]s and [MethodTweener]s appended after this method.
If not specified, the default value is [constant EASE_IN_OUT]. 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> </description>
</method> </method>
<method name="set_loops"> <method name="set_loops">
@ -271,8 +277,14 @@
<return type="Tween" /> <return type="Tween" />
<param index="0" name="trans" type="int" enum="Tween.TransitionType" /> <param index="0" name="trans" type="int" enum="Tween.TransitionType" />
<description> <description>
Sets the default transition type for [PropertyTweener]s and [MethodTweener]s animated by this [Tween]. Sets the default transition type for [PropertyTweener]s and [MethodTweener]s appended after this method.
If not specified, the default value is [constant TRANS_LINEAR]. 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> </description>
</method> </method>
<method name="stop"> <method name="stop">