diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Tween.xml | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index 86a8130acc..3ad0a73b41 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -279,6 +279,22 @@ <return type="void" /> <description> 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]. </description> </method> |