Tween.stop documentation has ambiguous description of effects

[Meorge]

Your Godot version: 4.3, 4.4

Issue description:

The documentation for Tween.stop reads:

Stops the tweening and resets the Tween to its initial state.

The phrase "initial state" implies that the property being tweened would snap back to whatever it was when the Tween began. This is not the case; when a stopped tween is played with Tween.play, it begins interpolating from where the tween stopped towards the final value again.

The code for Tween.stop is:

void Tween::stop() {
	_stop_internal(true);
}

void Tween::_stop_internal(bool p_reset) {
	running = false;
	if (p_reset) {
		started = false;
		dead = false;
		total_time = 0;
	}
}

So, what stop does is:

• Set running to false (since it is no longer being evaluated currently)
• Set started to false (as if it hadn't executed at all yet)
• Set dead to false (so if it has been killed or finished running, it will be usable again)
• Set total_time to 0 (so that when run, it will take the full amount of time to finish again)

Notably, it does not reset the value of the property it is interpolating.

I think the documentation should be updated to clarify what is considered the tween's "initial state" in this context (specifically the fact that an interpolated property is not reset to the initial value).

URL to the documentation page:

https://docs.godotengine.org/en/stable/classes/class_tween.html#class-tween-method-stop