Fix for animated sprite not stopping

[Owlzy]

Description of change

Fixes issue where animated sprite continues to play even when _playing = false

Pre-Merge Checklist

• Lint process passed (npm run lint)

[bigtimebuddy]

Thanks for this @Owlzy. Can you provide an example of this not work so we can verify?

[Owlzy]

Thanks for this @Owlzy. Can you provide an example of this not work so we can verify?

Sure. Having made a playground I now see it is specific to autoUpdate = false.

In this playground can see that animation plays regardless of calling stop(). If loop is true it will continue looping, or if not looping it will play till the last frame and stop.

https://www.pixiplayground.com/#/edit/1EdyVzCi9_Djk1FbjhyGw

[bigtimebuddy]

Got it, this example is helpful for context. At first, it seemed a little redundant to add this check, but now I see why because you are enabling autoUpdate.

I fine with this, but additional, I think it might be nice to add play and stop events. So the user could know when to remove from the ticker (which is what happens if autoUpdate is true). For example:

const sprite = new AnimatedSprite();
sprite.autoUpdate = false;
sprite.on('play', () => ticker.add(sprite.update, sprite) });
sprite.on('stop', () => ticker.remove(sprite.update, sprite) });

Play and stop would allow you to remove from the ticker or event loop and remove that call all together, which means you wouldn't need to defensively add the check in update. I think there's value in both, just a thought.

[bigtimebuddy]

Can you please fix the linting? Otherwise, I'm fine with this.

[Owlzy]

Can you please fix the linting? Otherwise, I'm fine with this.

Sorry thought I fixed that already. Should be fixed in the latest commit.

[codecov]

Codecov Report

Merging #7211 (99bfd39) into dev (851734e) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##               dev     #7211   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           17        17           
  Lines          699       699           
=========================================
  Hits           699       699           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 851734e...7e95c48. Read the comment docs.

[bigtimebuddy]

Thank you @Owlzy 🎉