phaser/src/animations/events/SPRITE_ANIMATION_START_EVENT.js

17 lines
802 B
JavaScript
Raw Normal View History

/**
* The Sprite Animation Start Event.
*
* This event is dispatched by a Sprite when an animation starts playing on it.
*
* Listen for it on the Sprite using `sprite.on('animationstart', listener)`
*
* This same event is dispatched for all animations. To listen for a specific animation, use the `SPRITE_START_KEY_ANIMATION_EVENT` event.
*
* @event Phaser.Animations.Events#SPRITE_ANIMATION_START
*
* @param {Phaser.Animations.Animation} animation - A reference to the Animation that was started on the Sprite.
* @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame that the Animation started with.
* @param {Phaser.GameObjects.Sprite} gameObject - A reference to the Game Object on which the animation started playing.
*/
module.exports = 'animationstart';