summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRémi Verschelde <remi@verschelde.fr>2021-06-24 19:24:18 +0200
committerGitHub <noreply@github.com>2021-06-24 19:24:18 +0200
commit40d571a3a2399fbd812eb1f6e315b6fd80d2c027 (patch)
tree5d6ce24a355e36fa220d157c62eeb03ee614c361
parentcb8f045de8cddff47331051cb4410a7652fbfff8 (diff)
parent678827bebc0e92d49fb2cb98f0b51c3d62e553fd (diff)
Merge pull request #49886 from KoBeWi/small_step_for_tweens
Correct the description of Tween.custom_step
-rw-r--r--doc/classes/Tween.xml3
1 files changed, 1 insertions, 2 deletions
diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml
index ed193b9f7e..253822cf32 100644
--- a/doc/classes/Tween.xml
+++ b/doc/classes/Tween.xml
@@ -72,10 +72,9 @@
<argument index="0" name="delta" type="float">
</argument>
<description>
- Processes the [Tween] by given [code]delta[/code] value, in seconds. Mostly useful when the [Tween] is paused, for controlling it manually.
+ Processes the [Tween] by given [code]delta[/code] value, in seconds. Mostly useful when the [Tween] is paused, for controlling it manually. Can also be used to end the [Tween] animation immediately, by using [code]delta[/code] longer than the whole duration.
Returns [code]true[/code] if the [Tween] still has [Tweener]s that haven't finished.
[b]Note:[/b] The [Tween] will become invalid after finished, but you can call [method stop] after the step, to keep it and reset.
- [b]Note:[/b] [method custom_step] will process only one step of the [Tween]. If the [code]delta[/code] is greater than the remaining time, the excessive time will not have any effect.
</description>
</method>
<method name="interpolate_value">