Update JSDocs for events

Author: halilcakar

plugins/spine/src/SpinePlugin.js

@@ -389,7 +389,7 @@ var Game = new Class({
      *
      * @method Phaser.Game#texturesReady
      * @private
-     * @fires Phaser.Game#ready
+     * @fires Phaser.Game#READY
      * @since 3.12.0
      */
     texturesReady: function ()
@@ -443,11 +443,11 @@ var Game = new Class({
      * It will then render each Scene in turn, via the Renderer. This process emits `prerender` and `postrender` events.
      *
      * @method Phaser.Game#step
-     * @fires Phaser.Core.Events#PRE_STEP_EVENT
-     * @fires Phaser.Core.Events#STEP_EVENT
-     * @fires Phaser.Core.Events#POST_STEP_EVENT
-     * @fires Phaser.Core.Events#PRE_RENDER_EVENT
-     * @fires Phaser.Core.Events#POST_RENDER_EVENT
+     * @fires Phaser.Core.Events#PRE_STEP
+     * @fires Phaser.Core.Events#PRE_STEP
+     * @fires Phaser.Core.Events#POST_STEP
+     * @fires Phaser.Core.Events#PRE_RENDER
+     * @fires Phaser.Core.Events#POST_RENDER
      * @since 3.0.0
      *
      * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.
@@ -510,8 +510,8 @@ var Game = new Class({
      * This process emits `prerender` and `postrender` events, even though nothing actually displays.
      *
      * @method Phaser.Game#headlessStep
-     * @fires Phaser.Game#prerenderEvent
-     * @fires Phaser.Game#postrenderEvent
+     * @fires Phaser.Game#PRE_RENDER
+     * @fires Phaser.Game#POST_RENDER
      * @since 3.2.0
      *
      * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.
@@ -672,7 +672,7 @@ var Game = new Class({
     runDestroy: function ()
     {
         this.scene.destroy();
-        
+
         this.events.emit(Events.DESTROY);
 
         this.events.removeAllListeners();

src/core/Game.js

@@ -297,14 +297,14 @@ var Animation = new Class({
 
     /**
      * Sets an animation to be played immediately after the current one completes.
-     * 
+     *
      * The current animation must enter a 'completed' state for this to happen, i.e. finish all of its repeats, delays, etc, or have the `stop` method called directly on it.
-     * 
+     *
      * An animation set to repeat forever will never enter a completed state.
-     * 
+     *
      * You can chain a new animation at any point, including before the current one starts playing, during it, or when it ends (via its `animationcomplete` callback).
      * Chained animations are specific to a Game Object, meaning different Game Objects can have different chained animations without impacting the global animation they're playing.
-     * 
+     *
      * Call this method with no arguments to reset the chained animation.
      *
      * @method Phaser.GameObjects.Components.Animation#chain
@@ -496,7 +496,7 @@ var Animation = new Class({
 
     /**
      * Plays an Animation on a Game Object that has the Animation component, such as a Sprite.
-     * 
+     *
      * Animations are stored in the global Animation Manager and are referenced by a unique string-based key.
      *
      * @method Phaser.GameObjects.Components.Animation#play
@@ -570,9 +570,9 @@ var Animation = new Class({
      * Load an Animation and fires 'onStartEvent' event, extracted from 'play' method.
      *
      * @method Phaser.GameObjects.Components.Animation#_startAnimation
-     * @fires Phaser.Animations.Events#START_ANIMATION_EVENT
-     * @fires Phaser.Animations.Events#SPRITE_START_ANIMATION_EVENT
-     * @fires Phaser.Animations.Events#SPRITE_START_KEY_ANIMATION_EVENT
+     * @fires Phaser.Animations.Events#ANIMATION_START
+     * @fires Phaser.Animations.Events#SPRITE_ANIMATION_START
+     * @fires Phaser.Animations.Events#SPRITE_ANIMATION_KEY_START
      * @since 3.12.0
      *
      * @param {string} key - The string-based key of the animation to play, as defined previously in the Animation Manager.
@@ -777,9 +777,9 @@ var Animation = new Class({
      * Restarts the current animation from its beginning, optionally including its delay value.
      *
      * @method Phaser.GameObjects.Components.Animation#restart
-     * @fires Phaser.Animations.Events#RESTART_ANIMATION_EVENT
-     * @fires Phaser.Animations.Events#SPRITE_RESTART_ANIMATION_EVENT
-     * @fires Phaser.Animations.Events#SPRITE_RESTART_KEY_ANIMATION_EVENT
+     * @fires Phaser.Animations.Events#ANIMATION_RESTART
+     * @fires Phaser.Animations.Events#SPRITE_ANIMATION_RESTART
+     * @fires Phaser.Animations.Events#SPRITE_ANIMATION_KEY_RESTART
      * @since 3.0.0
      *
      * @param {boolean} [includeDelay=false] - Whether to include the delay value of the animation when restarting.
@@ -816,9 +816,9 @@ var Animation = new Class({
 
     /**
      * Immediately stops the current animation from playing and dispatches the `animationcomplete` event.
-     * 
+     *
      * If no animation is set, no event will be dispatched.
-     * 
+     *
      * If there is another animation queued (via the `chain` method) then it will start playing immediately.
      *
      * @method Phaser.GameObjects.Components.Animation#stop
@@ -842,7 +842,7 @@ var Animation = new Class({
             anim.emit(Events.ANIMATION_COMPLETE, anim, frame, gameObject);
 
             gameObject.emit(Events.SPRITE_ANIMATION_KEY_COMPLETE + anim.key, anim, frame, gameObject);
-    
+
             gameObject.emit(Events.SPRITE_ANIMATION_COMPLETE, anim, frame, gameObject);
         }
 
@@ -1039,8 +1039,8 @@ var Animation = new Class({
      * Internal frame change handler.
      *
      * @method Phaser.GameObjects.Components.Animation#updateFrame
-     * @fires Phaser.Animations.Events#SPRITE_ANIMATION_UPDATE_EVENT
-     * @fires Phaser.Animations.Events#SPRITE_ANIMATION_KEY_UPDATE_EVENT
+     * @fires Phaser.Animations.Events#SPRITE_ANIMATION_UPDATE
+     * @fires Phaser.Animations.Events#SPRITE_ANIMATION_KEY_UPDATE
      * @private
      * @since 3.0.0
      *
@@ -1073,7 +1073,7 @@ var Animation = new Class({
     /**
      * Advances the animation to the next frame, regardless of the time or animation state.
      * If the animation is set to repeat, or yoyo, this will still take effect.
-     * 
+     *
      * Calling this does not change the direction of the animation. I.e. if it was currently
      * playing in reverse, calling this method doesn't then change the direction to forwards.
      *
@@ -1095,7 +1095,7 @@ var Animation = new Class({
     /**
      * Advances the animation to the previous frame, regardless of the time or animation state.
      * If the animation is set to repeat, or yoyo, this will still take effect.
-     * 
+     *
      * Calling this does not change the direction of the animation. I.e. if it was currently
      * playing in forwards, calling this method doesn't then change the direction to backwards.
      *

src/gameobjects/components/Animation.js

@@ -151,9 +151,9 @@ var LoaderPlugin = new Class({
 
         /**
          * If you want to append a URL before the path of any asset you can set this here.
-         * 
+         *
          * Useful if allowing the asset base url to be configured outside of the game code.
-         * 
+         *
          * If you set this property directly then it _must_ end with a "/". Alternatively, call `setBaseURL()` and it'll do it for you.
          *
          * @name Phaser.Loader.LoaderPlugin#baseURL
@@ -232,7 +232,7 @@ var LoaderPlugin = new Class({
 
         /**
          * Files are placed in this Set when they're added to the Loader via `addFile`.
-         * 
+         *
          * They are moved to the `inflight` Set when they start loading, and assuming a successful
          * load, to the `queue` Set for further processing.
          *
@@ -246,9 +246,9 @@ var LoaderPlugin = new Class({
 
         /**
          * Files are stored in this Set while they're in the process of being loaded.
-         * 
+         *
          * Upon a successful load they are moved to the `queue` Set.
-         * 
+         *
          * By the end of the load process this Set will be empty.
          *
          * @name Phaser.Loader.LoaderPlugin#inflight
@@ -259,10 +259,10 @@ var LoaderPlugin = new Class({
 
         /**
          * Files are stored in this Set while they're being processed.
-         * 
+         *
          * If the process is successful they are moved to their final destination, which could be
          * a Cache or the Texture Manager.
-         * 
+         *
          * At the end of the load process this Set will be empty.
          *
          * @name Phaser.Loader.LoaderPlugin#queue
@@ -357,9 +357,9 @@ var LoaderPlugin = new Class({
 
     /**
      * If you want to append a URL before the path of any asset you can set this here.
-     * 
+     *
      * Useful if allowing the asset base url to be configured outside of the game code.
-     * 
+     *
      * Once a base URL is set it will affect every file loaded by the Loader from that point on. It does _not_ change any
      * file _already_ being loaded. To reset it, call this method with no arguments.
      *
@@ -399,7 +399,7 @@ var LoaderPlugin = new Class({
      * given as it's an absolute URL.
      *
      * Please note that the path is added before the filename but *after* the baseURL (if set.)
-     * 
+     *
      * Once a path is set it will then affect every file added to the Loader from that point on. It does _not_ change any
      * file _already_ in the load queue. To reset it, call this method with no arguments.
      *
@@ -426,9 +426,9 @@ var LoaderPlugin = new Class({
 
     /**
      * An optional prefix that is automatically prepended to the start of every file key.
-     * 
+     *
      * If prefix was `MENU.` and you load an image with the key 'Background' the resulting key would be `MENU.Background`.
-     * 
+     *
      * Once a prefix is set it will then affect every file added to the Loader from that point on. It does _not_ change any
      * file _already_ in the load queue. To reset it, call this method with no arguments.
      *
@@ -450,9 +450,9 @@ var LoaderPlugin = new Class({
 
     /**
      * Sets the Cross Origin Resource Sharing value used when loading files.
-     * 
+     *
      * Files can override this value on a per-file basis by specifying an alternative `crossOrigin` value in their file config.
-     * 
+     *
      * Once CORs is set it will then affect every file loaded by the Loader from that point on, as long as they don't have
      * their own CORs setting. To reset it, call this method with no arguments.
      *
@@ -586,7 +586,7 @@ var LoaderPlugin = new Class({
      * @method Phaser.Loader.LoaderPlugin#addPack
      * @since 3.7.0
      *
-     * @param {any} data - The Pack File data to be parsed and each entry of it to added to the load queue.
+     * @param {any} pack - The Pack File data to be parsed and each entry of it to added to the load queue.
      * @param {string} [packKey] - An optional key to use from the pack file data.
      *
      * @return {boolean} `true` if any files were added to the queue, otherwise `false`.
@@ -609,6 +609,11 @@ var LoaderPlugin = new Class({
         //  Here we go ...
         for (var key in pack)
         {
+            if (!Object.prototype.hasOwnProperty.call(pack, key))
+            {
+                continue;
+            }
+
             var config = pack[key];
 
             //  Any meta data to process?
@@ -753,10 +758,10 @@ var LoaderPlugin = new Class({
 
     /**
      * An internal method called by the Loader.
-     * 
+     *
      * It will check to see if there are any more files in the pending list that need loading, and if so it will move
      * them from the list Set into the inflight Set, set their CORs flag and start them loading.
-     * 
+     *
      * It will carrying on doing this for each file in the pending list until it runs out, or hits the max allowed parallel downloads.
      *
      * @method Phaser.Loader.LoaderPlugin#checkLoadQueue
@@ -793,7 +798,7 @@ var LoaderPlugin = new Class({
 
     /**
      * An internal method called automatically by the XHRLoader belong to a File.
-     * 
+     *
      * This method will remove the given file from the inflight Set and update the load progress.
      * If the file was successful its `onProcess` method is called, otherwise it is added to the delete queue.
      *
@@ -933,7 +938,7 @@ var LoaderPlugin = new Class({
      *
      * @method Phaser.Loader.LoaderPlugin#flagForRemoval
      * @since 3.7.0
-     * 
+     *
      * @param {Phaser.Loader.File} file - The File to be queued for deletion when the Loader completes.
      */
     flagForRemoval: function (file)
@@ -961,7 +966,7 @@ var LoaderPlugin = new Class({
 
     /**
      * Causes the browser to save the given data as a file to its default Downloads folder.
-     * 
+     *
      * Creates a DOM level anchor link, assigns it as being a `download` anchor, sets the href
      * to be an ObjectURL based on the given data, and then invokes a click event.
      *

src/loader/LoaderPlugin.js

@@ -14,7 +14,7 @@ var LoaderEvents = require('../events');
  * A single Animation JSON File suitable for loading by the Loader.
  *
  * These are created when you use the Phaser.Loader.LoaderPlugin#animation method and are not typically created directly.
- * 
+ *
  * For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#animation.
  *
  * @class AnimationJSONFile
@@ -80,7 +80,7 @@ var AnimationJSONFile = new Class({
  * Adds an Animation JSON Data file, or array of Animation JSON files, to the current load queue.
  *
  * You can call this method from within your Scene's `preload`, along with any other files you wish to load:
- * 
+ *
  * ```javascript
  * function preload ()
  * {
@@ -95,17 +95,17 @@ var AnimationJSONFile = new Class({
  * The typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the
  * Scene's `create` method is called you are guaranteed that all of those assets are ready for use and have been
  * loaded.
- * 
+ *
  * If you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring
  * its events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.
- * 
+ *
  * The key must be a unique String. It is used to add the file to the global JSON Cache upon a successful load.
  * The key should be unique both in terms of files being loaded and files already present in the JSON Cache.
  * Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file
  * then remove it from the JSON Cache first, before loading a new one.
  *
  * Instead of passing arguments you can pass a configuration object, such as:
- * 
+ *
  * ```javascript
  * this.load.animation({
  *     key: 'baddieAnims',
@@ -122,9 +122,9 @@ var AnimationJSONFile = new Class({
  *
  * Once the animation data has been parsed you will be able to play animations using that data.
  * Please see the Animation Manager `fromJSON` method for more details about the format and playback.
- * 
+ *
  * You can also access the raw animation data from its Cache using its key:
- * 
+ *
  * ```javascript
  * this.load.animation('baddieAnims', 'files/BaddieAnims.json');
  * // and later in your game ...
@@ -143,7 +143,7 @@ var AnimationJSONFile = new Class({
  *
  * You can also optionally provide a `dataKey` to use. This allows you to extract only a part of the JSON and store it in the Cache,
  * rather than the whole file. For example, if your JSON data had a structure like this:
- * 
+ *
  * ```json
  * {
  *     "level1": {
@@ -163,7 +163,7 @@ var AnimationJSONFile = new Class({
  * It is available in the default build but can be excluded from custom builds.
  *
  * @method Phaser.Loader.LoaderPlugin#animation
- * @fires Phaser.Loader.LoaderPlugin#addFileEvent
+ * @fires Phaser.Loader.LoaderPlugin#ADD
  * @since 3.0.0
  *
  * @param {(string|Phaser.Types.Loader.FileTypes.JSONFileConfig|Phaser.Types.Loader.FileTypes.JSONFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.