[Merged by Bors] - Rename `play` to `start` and add new `play` method that won't overwrite the existing animation if it's already playing by anchpop · Pull Request #6350 · bevyengine/bevy

anchpop · 2022-10-23T17:13:58Z

Objective

You usually want to say that a given animation should be playing, doing nothing if it's already playing.

Solution

Rename play to start and add new play method that won't overwrite the existing animation if it's already playing [Merged by Bors] - Rename play to start and add new play method that won't overwrite the existing animation if it's already playing #6350

Changelog

Changed

AnimationPlayer::play will now not restart the animation if it's already playing

Added

An AnimationPlayer ::start method, which has the old behavior of play

Migration guide

If you were using play to restart an animation that was already playing, that functionality has been moved to start. Now, play won't have any effect if the requested animation is already playing.

alice-i-cecile · 2022-10-23T18:20:59Z

Bikeshed: can we call this method start_playing?

MrGVSV · 2022-10-23T20:29:17Z

Here's my bikeshed: maybe call this play and change the current play method to start?

anchpop · 2022-10-23T20:33:47Z

@MrGVSV I really like that, @alice-i-cecile what do you think?

alice-i-cecile · 2022-10-23T22:45:18Z

Yep, I'm on board with that change.

anchpop · 2022-10-23T23:48:52Z

@alice-i-cecile ok, done!

MrGVSV · 2022-10-24T03:29:41Z

crates/bevy_animation/src/lib.rs

 impl AnimationPlayer {
    /// Start playing an animation, resetting state of the player
-    pub fn play(&mut self, handle: Handle<AnimationClip>) -> &mut Self {
+    pub fn start(&mut self, handle: Handle<AnimationClip>) -> &mut Self {


Does this change affect other code, such as any examples?

I tested the examples and they work the same as before. AFAICT none of them call play on an animation that's already playing.

crates/bevy_animation/src/lib.rs

Pietrek14

Except for the small thing with the docs, it looks good to me.

Pietrek14 · 2022-10-24T11:54:17Z

crates/bevy_animation/src/lib.rs

        self
    }

+    /// Like `start`, but does nothing if the requested animation is already playing.


Shouldn't start be wrapped in a square brackets to link the method?

Could be wrong but it might even need a path to the method (i.e. [`start`](Self::start))

alice-i-cecile

Once you add that doc link, update the PR title and add a migration guide, this LGTM.

anchpop · 2022-10-24T16:06:28Z

@alice-i-cecile done!

crates/bevy_animation/src/lib.rs

mockersf · 2022-10-24T17:36:13Z

crates/bevy_animation/src/lib.rs

        self
    }

+    /// Like [`start`](Self::start), but does nothing if the requested animation is already playing.


this doc is not self-explaining, could you reformulate?

What do you think of the new doc?

Much better IMO.

good for me, thanks 👍

Pietrek14

I like the new doc :)

alice-i-cecile · 2022-10-24T20:53:38Z

bors r+

…te the existing animation if it's already playing (#6350) # Objective - You usually want to say that a given animation *should* be playing, doing nothing if it's already playing. ## Solution - Rename play to start and add new play method that won't overwrite the existing animation if it's already playing #6350 --- ## Changelog ### Changed `AnimationPlayer::play` will now not restart the animation if it's already playing ### Added An `AnimationPlayer ::start` method, which has the old behavior of `play` ## Migration guide - If you were using `play` to restart an animation that was already playing, that functionality has been moved to `start`. Now, `play` won't have any effect if the requested animation is already playing.

bors · 2022-10-24T21:20:20Z

Pull request successfully merged into main.

Build succeeded:

…te the existing animation if it's already playing (bevyengine#6350) # Objective - You usually want to say that a given animation *should* be playing, doing nothing if it's already playing. ## Solution - Rename play to start and add new play method that won't overwrite the existing animation if it's already playing bevyengine#6350 --- ## Changelog ### Changed `AnimationPlayer::play` will now not restart the animation if it's already playing ### Added An `AnimationPlayer ::start` method, which has the old behavior of `play` ## Migration guide - If you were using `play` to restart an animation that was already playing, that functionality has been moved to `start`. Now, `play` won't have any effect if the requested animation is already playing.

anchpop force-pushed the @anchpop/play_unless_already_playing branch from 249734a to f525419 Compare October 23, 2022 17:17

alice-i-cecile added C-Usability A targeted quality-of-life change that makes Bevy easier to use A-Animation Make things move and change over time labels Oct 23, 2022

anchpop force-pushed the @anchpop/play_unless_already_playing branch from f525419 to 005508e Compare October 23, 2022 23:47

MrGVSV reviewed Oct 24, 2022

View reviewed changes

anchpop force-pushed the @anchpop/play_unless_already_playing branch from 005508e to e0274dc Compare October 24, 2022 04:06

MrGVSV approved these changes Oct 24, 2022

View reviewed changes

Pietrek14 suggested changes Oct 24, 2022

View reviewed changes

alice-i-cecile requested changes Oct 24, 2022

View reviewed changes

alice-i-cecile added the M-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide label Oct 24, 2022

alice-i-cecile requested a review from mockersf October 24, 2022 14:40

anchpop force-pushed the @anchpop/play_unless_already_playing branch from e0274dc to 2d63bf4 Compare October 24, 2022 16:04

anchpop changed the title ~~Add play_unless_already_playing method to AnimationPlayer~~ Rename play to start and add new play method that won't overwrite the existing animation if it's already playing Oct 24, 2022

MrGVSV reviewed Oct 24, 2022

View reviewed changes

crates/bevy_animation/src/lib.rs Outdated Show resolved Hide resolved

anchpop force-pushed the @anchpop/play_unless_already_playing branch from 2d63bf4 to 4205190 Compare October 24, 2022 16:31

alice-i-cecile approved these changes Oct 24, 2022

View reviewed changes

alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Oct 24, 2022

mockersf reviewed Oct 24, 2022

View reviewed changes

anchpop force-pushed the @anchpop/play_unless_already_playing branch from 4205190 to 924544e Compare October 24, 2022 17:41

Add play_unless_already_playing method to AnimationPlayer

9549e46

anchpop force-pushed the @anchpop/play_unless_already_playing branch from 924544e to 9549e46 Compare October 24, 2022 17:53

Pietrek14 approved these changes Oct 24, 2022

View reviewed changes

mockersf approved these changes Oct 24, 2022

View reviewed changes

bors bot changed the title ~~Rename play to start and add new play method that won't overwrite the existing animation if it's already playing~~ [Merged by Bors] - Rename play to start and add new play method that won't overwrite the existing animation if it's already playing Oct 24, 2022

bors bot closed this Oct 24, 2022

mockersf added the hacktoberfest-accepted label Oct 24, 2022

Uh oh!

Conversation

anchpop commented Oct 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Objective

Solution

Changelog

Changed

Added

Migration guide

Uh oh!

alice-i-cecile commented Oct 23, 2022

Uh oh!

MrGVSV commented Oct 23, 2022

Uh oh!

anchpop commented Oct 23, 2022

Uh oh!

alice-i-cecile commented Oct 23, 2022

Uh oh!

anchpop commented Oct 23, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Pietrek14 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alice-i-cecile left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anchpop commented Oct 24, 2022

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pietrek14 left a comment

Choose a reason for hiding this comment

Uh oh!

alice-i-cecile commented Oct 24, 2022

Uh oh!

bors bot commented Oct 24, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

anchpop commented Oct 23, 2022 •

edited

Loading

alice-i-cecile left a comment •

edited

Loading