Merge branch 'master' of https://github.com/photonstorm/phaser

Author: photonstorm

src/boot/Config.js

@@ -502,7 +502,7 @@ var Config = new Class({
          *
          * plugins: {
          *    global: [
-         *        { key: 'TestPlugin', plugin: TestPlugin, start: true },
+         *        { key: 'TestPlugin', plugin: TestPlugin, start: true, data: { msg: 'The plugin is alive' } },
          *    ],
          *    scene: [
          *        { key: 'WireFramePlugin', plugin: WireFramePlugin, systemKey: 'wireFramePlugin', sceneKey: 'wireframe' }

src/gameobjects/GameObject.js

@@ -126,7 +126,7 @@ var GameObject = new Class({
          * A bitmask that controls if this Game Object is drawn by a Camera or not.
          * Not usually set directly, instead call `Camera.ignore`, however you can
          * set this property directly using the Camera.id property:
-         * 
+         *
          * @example
          * this.cameraFilter |= camera.id
          *
@@ -234,12 +234,12 @@ var GameObject = new Class({
 
     /**
      * Allows you to store a key value pair within this Game Objects Data Manager.
-     * 
+     *
      * If the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled
      * before setting the value.
-     * 
+     *
      * If the key doesn't already exist in the Data Manager then it is created.
-     * 
+     *
      * ```javascript
      * sprite.setData('name', 'Red Gem Stone');
      * ```
@@ -251,13 +251,13 @@ var GameObject = new Class({
      * ```
      *
      * To get a value back again you can call `getData`:
-     * 
+     *
      * ```javascript
      * sprite.getData('gold');
      * ```
-     * 
+     *
      * Or you can access the value directly via the `values` property, where it works like any other variable:
-     * 
+     *
      * ```javascript
      * sprite.data.values.gold += 50;
      * ```
@@ -295,19 +295,19 @@ var GameObject = new Class({
      * Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.
      *
      * You can also access values via the `values` object. For example, if you had a key called `gold` you can do either:
-     * 
+     *
      * ```javascript
      * sprite.getData('gold');
      * ```
      *
      * Or access the value directly:
-     * 
+     *
      * ```javascript
      * sprite.data.values.gold;
      * ```
      *
      * You can also pass in an array of keys, in which case an array of values will be returned:
-     * 
+     *
      * ```javascript
      * sprite.getData([ 'gold', 'armor', 'health' ]);
      * ```
@@ -416,6 +416,8 @@ var GameObject = new Class({
      *
      * @method Phaser.GameObjects.GameObject#update
      * @since 3.0.0
+     *
+     * @param {...*} [args] - args
      */
     update: function ()
     {
@@ -440,7 +442,7 @@ var GameObject = new Class({
      *
      * @method Phaser.GameObjects.GameObject#willRender
      * @since 3.0.0
-     * 
+     *
      * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to check against this Game Object.
      *
      * @return {boolean} True if the Game Object should be rendered, otherwise false.

src/gameobjects/sprite/SpriteCreator.js

@@ -10,6 +10,14 @@ var GameObjectCreator = require('../GameObjectCreator');
 var GetAdvancedValue = require('../../utils/object/GetAdvancedValue');
 var Sprite = require('./Sprite');
 
+/**
+ * @typedef {object} SpriteConfig
+ * @extends GameObjectConfig
+ *
+ * @property {string} [key] - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
+ * @property {(number|string)} [frame] - An optional frame from the Texture this Game Object is rendering with.
+ */
+
 /**
  * Creates a new Sprite Game Object and returns it.
  *
@@ -18,7 +26,7 @@ var Sprite = require('./Sprite');
  * @method Phaser.GameObjects.GameObjectCreator#sprite
  * @since 3.0.0
  *
- * @param {object} config - The configuration object this Game Object will use to create itself.
+ * @param {SpriteConfig} config - The configuration object this Game Object will use to create itself.
  * @param {boolean} [addToScene] - Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.
  *
  * @return {Phaser.GameObjects.Sprite} The Game Object that was created.

src/plugins/BasePlugin.js

@@ -80,6 +80,8 @@ var BasePlugin = new Class({
      *
      * @method Phaser.Plugins.BasePlugin#init
      * @since 3.8.0
+     *
+     * @param {?any} [data] - A value specified by the user, if any, from the `data` property of the plugin's configuration object (if started at game boot) or passed in the PluginManager's `install` method (if started manually).
      */
     init: function ()
     {

src/plugins/PluginCache.js

@@ -61,10 +61,11 @@ PluginCache.register = function (key, plugin, mapping, custom)
  * @param {string} key - A reference used to get this plugin from the plugin cache.
  * @param {function} plugin - The plugin to be stored. Should be the core object, not instantiated.
  * @param {string} mapping - If this plugin is to be injected into the Scene Systems, this is the property key map used.
+ * @param {?any} data - A value to be passed to the plugin's `init` method.
  */
-PluginCache.registerCustom = function (key, plugin, mapping)
+PluginCache.registerCustom = function (key, plugin, mapping, data)
 {
-    customPlugins[key] = { plugin: plugin, mapping: mapping };
+    customPlugins[key] = { plugin: plugin, mapping: mapping, data: data };
 };
 
 /**

src/plugins/PluginManager.js

@@ -146,6 +146,7 @@ var PluginManager = new Class({
         var plugin;
         var start;
         var mapping;
+        var data;
         var config = this.game.config;
 
         //  Any plugins to install?
@@ -158,16 +159,17 @@ var PluginManager = new Class({
         {
             entry = list[i];
 
-            // { key: 'TestPlugin', plugin: TestPlugin, start: true, mapping: 'test' }
+            // { key: 'TestPlugin', plugin: TestPlugin, start: true, mapping: 'test', data: { msg: 'The plugin is alive' } }
 
             key = GetFastValue(entry, 'key', null);
             plugin = GetFastValue(entry, 'plugin', null);
             start = GetFastValue(entry, 'start', false);
             mapping = GetFastValue(entry, 'mapping', null);
+            data = GetFastValue(entry, 'data', null);
 
             if (key && plugin)
             {
-                this.install(key, plugin, start, mapping);
+                this.install(key, plugin, start, mapping, data);
             }
         }
 
@@ -399,11 +401,13 @@ var PluginManager = new Class({
      * @param {function} plugin - The plugin code. This should be the non-instantiated version.
      * @param {boolean} [start=false] - Automatically start the plugin running? This is always `true` if you provide a mapping value.
      * @param {string} [mapping] - If this plugin is injected into the Phaser.Scene class, this is the property key to use.
+     * @param {any} [data] - A value passed to the plugin's `init` method.
      */
-    install: function (key, plugin, start, mapping)
+    install: function (key, plugin, start, mapping, data)
     {
         if (start === undefined) { start = false; }
         if (mapping === undefined) { mapping = null; }
+        if (data === undefined) { data = null; }
 
         if (typeof plugin !== 'function')
         {
@@ -424,12 +428,12 @@ var PluginManager = new Class({
 
         if (!this.game.isBooted)
         {
-            this._pendingGlobal.push({ key: key, plugin: plugin, start: start, mapping: mapping });
+            this._pendingGlobal.push({ key: key, plugin: plugin, start: start, mapping: mapping, data: data });
         }
         else
         {
             //  Add it to the plugin store
-            PluginCache.registerCustom(key, plugin, mapping);
+            PluginCache.registerCustom(key, plugin, mapping, data);
 
             if (start)
             {
@@ -568,12 +572,13 @@ var PluginManager = new Class({
                 key: runAs,
                 plugin: instance,
                 active: true,
-                mapping: entry.mapping
+                mapping: entry.mapping,
+                data: entry.data
             };
 
             this.plugins.push(entry);
 
-            instance.init();
+            instance.init(entry.data);
             instance.start();
         }
 

src/tilemaps/Tilemap.js

@@ -508,7 +508,7 @@ var Tilemap = new Class({
      * @param {(integer|string)} id - Either the id (object), gid (tile object) or name (object or
      * tile object) from Tiled. Ids are unique in Tiled, but a gid is shared by all tile objects
      * with the same graphic. The same name can be used on multiple objects.
-     * @param {object} spriteConfig - The config object to pass into the Sprite creator (i.e.
+     * @param {SpriteConfig} spriteConfig - The config object to pass into the Sprite creator (i.e.
      * scene.make.sprite).
      * @param {Phaser.Scene} [scene=the scene the map is within] - The Scene to create the Sprites within.
      *
@@ -599,7 +599,7 @@ var Tilemap = new Class({
      * @param {(integer|array)} replacements - The tile index, or array of indexes, to change a converted
      * tile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a
      * one-to-one mapping with the indexes array.
-     * @param {object} spriteConfig - The config object to pass into the Sprite creator (i.e.
+     * @param {SpriteConfig} spriteConfig - The config object to pass into the Sprite creator (i.e.
      * scene.make.sprite).
      * @param {Phaser.Scene} [scene=scene the map is within] - The Scene to create the Sprites within.
      * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when determining the world XY

src/tilemaps/components/CreateFromTiles.js

@@ -23,7 +23,7 @@ var ReplaceByIndex = require('./ReplaceByIndex');
  * @param {(integer|array)} replacements - The tile index, or array of indexes, to change a converted
  * tile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a
  * one-to-one mapping with the indexes array.
- * @param {object} spriteConfig - The config object to pass into the Sprite creator (i.e.
+ * @param {SpriteConfig} spriteConfig - The config object to pass into the Sprite creator (i.e.
  * scene.make.sprite).
  * @param {Phaser.Scene} [scene=scene the map is within] - The Scene to create the Sprites within.
  * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when determining the world XY

src/tilemaps/dynamiclayer/DynamicTilemapLayer.js

@@ -134,7 +134,7 @@ var DynamicTilemapLayer = new Class({
         /**
          * You can control if the Cameras should cull tiles before rendering them or not.
          * By default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.
-         * 
+         *
          * However, there are some instances when you may wish to disable this, and toggling this flag allows
          * you to do so. Also see `setSkipCull` for a chainable method that does the same thing.
          *
@@ -166,7 +166,7 @@ var DynamicTilemapLayer = new Class({
 
         /**
          * The amount of extra tiles to add into the cull rectangle when calculating its horizontal size.
-         * 
+         *
          * See the method `setCullPadding` for more details.
          *
          * @name Phaser.Tilemaps.DynamicTilemapLayer#cullPaddingX
@@ -178,7 +178,7 @@ var DynamicTilemapLayer = new Class({
 
         /**
          * The amount of extra tiles to add into the cull rectangle when calculating its vertical size.
-         * 
+         *
          * See the method `setCullPadding` for more details.
          *
          * @name Phaser.Tilemaps.DynamicTilemapLayer#cullPaddingY
@@ -190,15 +190,15 @@ var DynamicTilemapLayer = new Class({
 
         /**
          * The callback that is invoked when the tiles are culled.
-         * 
+         *
          * By default it will call `TilemapComponents.CullTiles` but you can override this to call any function you like.
-         * 
+         *
          * It will be sent 3 arguments:
-         * 
+         *
          * 1) The Phaser.Tilemaps.LayerData object for this Layer
          * 2) The Camera that is culling the layer. You can check its `dirty` property to see if it has changed since the last cull.
          * 3) A reference to the `culledTiles` array, which should be used to store the tiles you want rendered.
-         * 
+         *
          * See the `TilemapComponents.CullTiles` source code for details on implementing your own culling system.
          *
          * @name Phaser.Tilemaps.DynamicTilemapLayer#cullCallback
@@ -270,7 +270,7 @@ var DynamicTilemapLayer = new Class({
      * @param {(integer|array)} replacements - The tile index, or array of indexes, to change a converted
      * tile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a
      * one-to-one mapping with the indexes array.
-     * @param {object} spriteConfig - The config object to pass into the Sprite creator (i.e.
+     * @param {SpriteConfig} spriteConfig - The config object to pass into the Sprite creator (i.e.
      * scene.make.sprite).
      * @param {Phaser.Scene} [scene=scene the map is within] - The Scene to create the Sprites within.
      * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when determining the world XY
@@ -822,9 +822,9 @@ var DynamicTilemapLayer = new Class({
     /**
      * You can control if the Cameras should cull tiles before rendering them or not.
      * By default the camera will try to cull the tiles in this layer, to avoid over-drawing to the renderer.
-     * 
+     *
      * However, there are some instances when you may wish to disable this.
-     * 
+     *
      * @method Phaser.Tilemaps.DynamicTilemapLayer#setSkipCull
      * @since 3.11.0
      *
@@ -842,12 +842,12 @@ var DynamicTilemapLayer = new Class({
     },
 
     /**
-     * When a Camera culls the tiles in this layer it does so using its view into the world, building up a 
+     * When a Camera culls the tiles in this layer it does so using its view into the world, building up a
      * rectangle inside which the tiles must exist or they will be culled. Sometimes you may need to expand the size
      * of this 'cull rectangle', especially if you plan on rotating the Camera viewing the layer. Do so
      * by providing the padding values. The values given are in tiles, not pixels. So if the tile width was 32px
      * and you set `paddingX` to be 4, it would add 32px x 4 to the cull rectangle (adjusted for scale)
-     * 
+     *
      * @method Phaser.Tilemaps.DynamicTilemapLayer#setCullPadding
      * @since 3.11.0
      *

src/tilemaps/staticlayer/StaticTilemapLayer.js

@@ -237,7 +237,7 @@ var StaticTilemapLayer = new Class({
                 var row;
                 var col;
                 var texCoords;
-   
+
                 var vertexBuffer = this.vertexBuffer;
                 var bufferData = this.bufferData;
                 var voffset = -1;
@@ -433,7 +433,7 @@ var StaticTilemapLayer = new Class({
      * @param {(integer|array)} replacements - The tile index, or array of indexes, to change a converted
      * tile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a
      * one-to-one mapping with the indexes array.
-     * @param {object} spriteConfig - The config object to pass into the Sprite creator (i.e.
+     * @param {SpriteConfig} spriteConfig - The config object to pass into the Sprite creator (i.e.
      * scene.make.sprite).
      * @param {Phaser.Scene} [scene=scene the map is within] - The Scene to create the Sprites within.
      * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when determining the world XY