Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add p_keep_state to AnimationPlayer::stop() #71619

Merged
merged 1 commit into from
Jan 18, 2023
Merged

Add p_keep_state to AnimationPlayer::stop() #71619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions doc/classes/AnimationPlayer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,9 +208,11 @@
</method>
<method name="stop">
<return type="void" />
<param index="0" name="keep_state" type="bool" default="false" />
<description>
Stops the currently playing animation. The animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code].
See also [method pause].
Stops the currently playing animation. The animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code]. See also [method pause].
If [param keep_state] is [code]true[/code], the animation state is not updated visually.
[b]Note:[/b] The method / audio / animation playback tracks will not be processed by this method.
</description>
</method>
</methods>
Expand Down
20 changes: 12 additions & 8 deletions scene/animation/animation_player.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1736,11 +1736,11 @@ String AnimationPlayer::get_assigned_animation() const {
}

void AnimationPlayer::pause() {
_stop_internal(false);
_stop_internal(false, false);
}

void AnimationPlayer::stop() {
_stop_internal(true);
void AnimationPlayer::stop(bool p_keep_state) {
_stop_internal(true, p_keep_state);
}

void AnimationPlayer::set_speed_scale(float p_speed) {
Expand Down Expand Up @@ -1960,14 +1960,18 @@ void AnimationPlayer::_set_process(bool p_process, bool p_force) {
processing = p_process;
}

void AnimationPlayer::_stop_internal(bool p_reset) {
void AnimationPlayer::_stop_internal(bool p_reset, bool p_keep_state) {
_stop_playing_caches(p_reset);
Playback &c = playback;
c.blend.clear();
if (p_reset) {
is_stopping = true;
seek(0, true);
is_stopping = false;
if (p_keep_state) {
c.current.pos = 0;
} else {
is_stopping = true;
seek(0, true);
is_stopping = false;
}
c.current.from = nullptr;
c.current.speed_scale = 1;
}
Expand Down Expand Up @@ -2139,7 +2143,7 @@ void AnimationPlayer::_bind_methods() {
ClassDB::bind_method(D_METHOD("play", "name", "custom_blend", "custom_speed", "from_end"), &AnimationPlayer::play, DEFVAL(""), DEFVAL(-1), DEFVAL(1.0), DEFVAL(false));
ClassDB::bind_method(D_METHOD("play_backwards", "name", "custom_blend"), &AnimationPlayer::play_backwards, DEFVAL(""), DEFVAL(-1));
ClassDB::bind_method(D_METHOD("pause"), &AnimationPlayer::pause);
ClassDB::bind_method(D_METHOD("stop"), &AnimationPlayer::stop);
ClassDB::bind_method(D_METHOD("stop", "keep_state"), &AnimationPlayer::stop, DEFVAL(false));
ClassDB::bind_method(D_METHOD("is_playing"), &AnimationPlayer::is_playing);

ClassDB::bind_method(D_METHOD("set_current_animation", "anim"), &AnimationPlayer::set_current_animation);
Expand Down
4 changes: 2 additions & 2 deletions scene/animation/animation_player.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ class AnimationPlayer : public Node {
void _animation_changed(const StringName &p_name);

void _set_process(bool p_process, bool p_force = false);
void _stop_internal(bool p_reset);
void _stop_internal(bool p_reset, bool p_keep_state);

bool playing = false;

Expand Down Expand Up @@ -349,7 +349,7 @@ class AnimationPlayer : public Node {
Vector<String> get_queue();
void clear_queue();
void pause();
void stop();
void stop(bool p_keep_state = false);
bool is_playing() const;
String get_current_animation() const;
void set_current_animation(const String &p_anim);
Expand Down