Skip to content

Commit ccaae46

Browse files
committed
Added jsdoc version numbers to each event
1 parent 04080bc commit ccaae46

200 files changed

Lines changed: 211 additions & 6 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/animations/events/ADD_ANIMATION_EVENT.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* or the Animation Manager creating a new animation directly.
1414
*
1515
* @event Phaser.Animations.Events#ADD_ANIMATION
16+
* @since 3.0.0
1617
*
1718
* @param {string} key - The key of the Animation that was added to the global Animation Manager.
1819
* @param {Phaser.Animations.Animation} animation - An instance of the newly created Animation.

src/animations/events/ANIMATION_COMPLETE_EVENT.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* animation at the same time, this event will invoke its handler for each one of them.
1414
*
1515
* @event Phaser.Animations.Events#ANIMATION_COMPLETE
16+
* @since 3.16.1
1617
*
1718
* @param {Phaser.Animations.Animation} animation - A reference to the Animation that completed.
1819
* @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame that the Animation completed on.

src/animations/events/ANIMATION_REPEAT_EVENT.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* bound to this event will be invoked every time the Animation repeats, for every Game Object that may have it.
1414
*
1515
* @event Phaser.Animations.Events#ANIMATION_REPEAT
16+
* @since 3.16.1
1617
*
1718
* @param {Phaser.Animations.Animation} animation - A reference to the Animation that repeated.
1819
* @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame that the Animation was on when it repeated.

src/animations/events/ANIMATION_RESTART_EVENT.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* animation at the same time, this event will invoke its handler for each one of them.
1414
*
1515
* @event Phaser.Animations.Events#ANIMATION_RESTART
16+
* @since 3.16.1
1617
*
1718
* @param {Phaser.Animations.Animation} animation - A reference to the Animation that restarted playing.
1819
* @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame that the Animation restarted with.

src/animations/events/ANIMATION_START_EVENT.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* animation at the same time, this event will invoke its handler for each one of them.
1414
*
1515
* @event Phaser.Animations.Events#ANIMATION_START
16+
* @since 3.16.1
1617
*
1718
* @param {Phaser.Animations.Animation} animation - A reference to the Animation that started playing.
1819
* @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame that the Animation started with.

src/animations/events/PAUSE_ALL_EVENT.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,6 @@
1313
* that the game has paused as well.
1414
*
1515
* @event Phaser.Animations.Events#PAUSE_ALL
16+
* @since 3.0.0
1617
*/
1718
module.exports = 'pauseall';

src/animations/events/REMOVE_ANIMATION_EVENT.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* This event is dispatched when an animation is removed from the global Animation Manager.
1111
*
1212
* @event Phaser.Animations.Events#REMOVE_ANIMATION
13+
* @since 3.0.0
1314
*
1415
* @param {string} key - The key of the Animation that was removed from the global Animation Manager.
1516
* @param {Phaser.Animations.Animation} animation - An instance of the removed Animation.

src/animations/events/RESUME_ALL_EVENT.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,6 @@
1212
* When this happens all current animations will continue updating again.
1313
*
1414
* @event Phaser.Animations.Events#RESUME_ALL
15+
* @since 3.0.0
1516
*/
1617
module.exports = 'resumeall';

src/animations/events/SPRITE_ANIMATION_COMPLETE_EVENT.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
* This same event is dispatched for all animations. To listen for a specific animation, use the `SPRITE_ANIMATION_KEY_COMPLETE` event.
1515
*
1616
* @event Phaser.Animations.Events#SPRITE_ANIMATION_COMPLETE
17+
* @since 3.16.1
1718
*
1819
* @param {Phaser.Animations.Animation} animation - A reference to the Animation that completed.
1920
* @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame that the Animation completed on.

src/animations/events/SPRITE_ANIMATION_KEY_COMPLETE_EVENT.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* the animation. For example, if you had an animation with the key 'explode' you should listen for `animationcomplete-explode`.
1414
*
1515
* @event Phaser.Animations.Events#SPRITE_ANIMATION_KEY_COMPLETE
16+
* @since 3.16.1
1617
*
1718
* @param {Phaser.Animations.Animation} animation - A reference to the Animation that completed.
1819
* @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame that the Animation completed on.

0 commit comments

Comments
 (0)