New Animation events

Author: photonstorm

src/animations/events/ANIMATION_STOP_EVENT.js

@@ -0,0 +1,21 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Animation Stop Event.
+ *
+ * This event is dispatched by an Animation instance when playback is forcibly stopped on it,
+ * i.e. `Sprite.stop()`, or similar, is called. Or, a new animation is started before the
+ * previous one completes.
+ *
+ * @event Phaser.Animations.Events#ANIMATION_STOP
+ * @since 3.50.0
+ *
+ * @param {Phaser.Animations.Animation} animation - A reference to the Animation that was stopped.
+ * @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame that the Animation stopped on.
+ * @param {Phaser.GameObjects.Sprite} gameObject - A reference to the Game Object on which the animation stopped.
+ */
+module.exports = 'stop';

src/animations/events/ANIMATION_UPDATE_EVENT.js

@@ -0,0 +1,22 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Animation Update Event.
+ *
+ * This event is dispatched by an animation when it updates. This happens when the animation changes frame,
+ * based on the animation frame rate and other factors like `timeScale` and `delay`.
+ *
+ * Listen for it on the Animation using `anim.on('update', listener)`
+ *
+ * @event Phaser.Animations.Events#ANIMATION_UPDATE
+ * @since 3.50.0
+ *
+ * @param {Phaser.Animations.Animation} animation - A reference to the Animation that has updated on the Sprite.
+ * @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame of the Animation.
+ * @param {Phaser.GameObjects.Sprite} gameObject - A reference to the Game Object on which the animation updated.
+ */
+module.exports = 'update';

src/animations/events/SPRITE_ANIMATION_KEY_STOP_EVENT.js

@@ -0,0 +1,24 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Sprite Animation Key Complete Event.
+ *
+ * This event is dispatched by a Sprite when animation playback is forcibly stopped on it,
+ * i.e. `Sprite.stop()`, or similar, is called. Or, a new animation is started before the
+ * previous one completes.
+ *
+ * Listen for it on the Sprite using `sprite.on('animationstop-key', listener)` where `key` is the key of
+ * the animation. For example, if you had an animation with the key 'explode' you should listen for `animationstop-explode`.
+ *
+ * @event Phaser.Animations.Events#SPRITE_ANIMATION_KEY_STOP
+ * @since 3.50.0
+ *
+ * @param {Phaser.Animations.Animation} animation - A reference to the Animation that was stopped.
+ * @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame that the Animation stopped on.
+ * @param {Phaser.GameObjects.Sprite} gameObject - A reference to the Game Object on which the animation stopped.
+ */
+module.exports = 'animationstop-';

src/animations/events/SPRITE_ANIMATION_STOP_EVENT.js

@@ -0,0 +1,26 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Sprite Animation Stop Event.
+ *
+ * This event is dispatched by a Sprite when animation playback is forcibly stopped on it,
+ * i.e. `Sprite.stop()`, or similar, is called. Or, a new animation is started before the
+ * previous one completes.
+ *
+ * Listen for it on the Sprite using `sprite.on('animationstop', listener)`
+ *
+ * This same event is dispatched for all animations. To listen for a specific animation,
+ * use the `SPRITE_ANIMATION_KEY_STOP` event.
+ *
+ * @event Phaser.Animations.Events#SPRITE_ANIMATION_STOP
+ * @since 3.50.0
+ *
+ * @param {Phaser.Animations.Animation} animation - A reference to the Animation that was stopped.
+ * @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame that the Animation stopped on.
+ * @param {Phaser.GameObjects.Sprite} gameObject - A reference to the Game Object on which the animation stopped.
+ */
+module.exports = 'animationstop';

src/animations/events/index.js

@@ -15,6 +15,8 @@ module.exports = {
     ANIMATION_REPEAT: require('./ANIMATION_REPEAT_EVENT'),
     ANIMATION_RESTART: require('./ANIMATION_RESTART_EVENT'),
     ANIMATION_START: require('./ANIMATION_START_EVENT'),
+    ANIMATION_STOP: require('./ANIMATION_STOP_EVENT'),
+    ANIMATION_UPDATE: require('./ANIMATION_UPDATE_EVENT'),
     PAUSE_ALL: require('./PAUSE_ALL_EVENT'),
     REMOVE_ANIMATION: require('./REMOVE_ANIMATION_EVENT'),
     RESUME_ALL: require('./RESUME_ALL_EVENT'),
@@ -23,10 +25,12 @@ module.exports = {
     SPRITE_ANIMATION_KEY_REPEAT: require('./SPRITE_ANIMATION_KEY_REPEAT_EVENT'),
     SPRITE_ANIMATION_KEY_RESTART: require('./SPRITE_ANIMATION_KEY_RESTART_EVENT'),
     SPRITE_ANIMATION_KEY_START: require('./SPRITE_ANIMATION_KEY_START_EVENT'),
+    SPRITE_ANIMATION_KEY_STOP: require('./SPRITE_ANIMATION_KEY_STOP_EVENT'),
     SPRITE_ANIMATION_KEY_UPDATE: require('./SPRITE_ANIMATION_KEY_UPDATE_EVENT'),
     SPRITE_ANIMATION_REPEAT: require('./SPRITE_ANIMATION_REPEAT_EVENT'),
     SPRITE_ANIMATION_RESTART: require('./SPRITE_ANIMATION_RESTART_EVENT'),
     SPRITE_ANIMATION_START: require('./SPRITE_ANIMATION_START_EVENT'),
+    SPRITE_ANIMATION_STOP: require('./SPRITE_ANIMATION_STOP_EVENT'),
     SPRITE_ANIMATION_UPDATE: require('./SPRITE_ANIMATION_UPDATE_EVENT')
 
 };