Rename Tween.stop() to pause()

[opl-]

The Tween.stop() and Tween.stop_all() methods are named in a way that suggests that they stop the playback and reset the tween progress to 0, while in reality it only stops playback.

Related:

• Rename the method stop() to pause() in AnimatedSprite. #31168 - Similar issue for AnimationPlayer
• AnimatonPlayer.stop(), mentioned in Rename the method stop() to pause() in AnimatedSprite. #31168 (comment)
• Fixed by Complete rewrite of Tweens #41794

[Calinou]

It would be better to leave a comment in #16863 (comment) for API renaming requests.

That said, keep in mind Tween is being rewritten for 4.0.

[opl-]

Yeah, I'm writing a comment in that thread as we speak. Honestly the issue of "stop" vs "pause" is already being discussed in several places, so I decided to open a separate issue to track Tween naming specifically. Feel free to close it in favor of the tracker thread or making #31168 more general.

Edit: Also, thanks for mentioning the Tween rewrite, I was not aware of that. I'll take a look at it and try to link this issue to the PR if relevant.

[KoBeWi]

The rewrite was merged, so this issue is resolved.