From 0304f8fd572fadb4bc70c29cc82315d546bb4bd7 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Sat, 2 Nov 2024 20:52:11 -0700 Subject: [PATCH] Update docs for `Tween.stop` to clarify behavior Apply suggestions from code review Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> Co-authored-by: Micky <66727710+Mickeon@users.noreply.github.com> Updated wording in comments to be more concise --- doc/classes/Tween.xml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index ac16bebecb8..00bbce59b1b 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -280,6 +280,22 @@ Stops the tweening and resets the [Tween] to its initial state. This will not remove any appended [Tweener]s. + [b]Note:[/b] This does [i]not[/i] reset targets of [PropertyTweener]s to their values when the [Tween] first started. + [codeblock] + var tween = create_tween() + + # Will move from 0 to 500 over 1 second. + position.x = 0.0 + tween.tween_property(self, "position:x", 500, 1.0) + + # Will be at (about) 250 when the timer finishes. + await get_tree().create_timer(0.5).timeout + + # Will now move from (about) 250 to 500 over 1 second, + # thus at half the speed as before. + tween.stop() + tween.play() + [/codeblock] [b]Note:[/b] If a Tween is stopped and not bound to any node, it will exist indefinitely until manually started or invalidated. If you lose a reference to such Tween, you can retrieve it using [method SceneTree.get_processed_tweens].