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

Author: Jeroen Reurings

src/animations/Animation.js

@@ -11,9 +11,9 @@ var GetValue = require('../utils/object/GetValue');
 /**
  * @classdesc
  * A Frame based Animation.
- * 
+ *
  * This consists of a key, some default values (like the frame rate) and a bunch of Frame objects.
- * 
+ *
  * The Animation Manager creates these. Game Objects don't own an instance of these directly.
  * Game Objects have the Animation Component, which are like playheads to global Animations (these objects)
  * So multiple Game Objects can have playheads all pointing to this one Animation instance.
@@ -303,7 +303,7 @@ var Animation = new Class({
      * @method Phaser.Animations.Animation#addFrame
      * @since 3.0.0
      *
-     * @param {[type]} config - [description]
+     * @param {string|object[]} config - [description]
      *
      * @return {Phaser.Animations.Animation} This Animation object.
      */
@@ -326,7 +326,7 @@ var Animation = new Class({
      * @since 3.0.0
      *
      * @param {integer} index - [description]
-     * @param {[type]} config - [description]
+     * @param {string|object[]} config - [description]
      *
      * @return {Phaser.Animations.Animation} This Animation object.
      */
@@ -436,7 +436,8 @@ var Animation = new Class({
      * @since 3.0.0
      *
      * @param {Phaser.Textures.TextureManager} textureManager - [description]
-     * @param {[type]} frames - [description]
+     * @param {string|object[]} frames - [description]
+     * @param {string} [defaultTextureKey] - [description]
      *
      * @return {Phaser.Animations.AnimationFrame[]} [description]
      */

src/display/canvas/CanvasPool.js

@@ -32,28 +32,28 @@ var CanvasPool = function ()
      * @function Phaser.Display.Canvas.CanvasPool.create
      * @since 3.0.0
      * 
-     * @param {any} parent - [description]
-     * @param {integer} [width=1] - [description]
-     * @param {integer} [height=1] - [description]
-     * @param {integer} [type] - [description]
+     * @param {any} parent - The parent of the Canvas object.
+     * @param {integer} [width=1] - The width of the Canvas.
+     * @param {integer} [height=1] - The height of the Canvas.
+     * @param {integer} [canvasType=Phaser.CANVAS] - The type of the Canvas. Either `Phaser.CANVAS` or `Phaser.WEBGL`.
      * 
      * @return {HTMLCanvasElement} [description]
      */
-    var create = function (parent, width, height, type)
+    var create = function (parent, width, height, canvasType)
     {
         if (width === undefined) { width = 1; }
         if (height === undefined) { height = 1; }
-        if (type === undefined) { type = CONST.CANVAS; }
+        if (canvasType === undefined) { canvasType = CONST.CANVAS; }
 
         var canvas;
-        var container = first(type);
+        var container = first(canvasType);
 
         if (container === null)
         {
             container = {
                 parent: parent,
                 canvas: document.createElement('canvas'),
-                type: type
+                type: canvasType
             };
 
             pool.push(container);
@@ -70,7 +70,7 @@ var CanvasPool = function ()
         canvas.width = width;
         canvas.height = height;
 
-        if (_disableContextSmoothing && type === CONST.CANVAS)
+        if (_disableContextSmoothing && canvasType === CONST.CANVAS)
         {
             Smoothing.disable(canvas.getContext('2d'));
         }
@@ -84,9 +84,9 @@ var CanvasPool = function ()
      * @function Phaser.Display.Canvas.CanvasPool.create2D
      * @since 3.0.0
      * 
-     * @param {any} parent - [description]
-     * @param {integer} [width=1] - [description]
-     * @param {integer} [height=1] - [description]
+     * @param {any} parent - The parent of the Canvas object.
+     * @param {integer} [width=1] - The width of the Canvas.
+     * @param {integer} [height=1] - The height of the Canvas.
      * 
      * @return {HTMLCanvasElement} [description]
      */
@@ -101,9 +101,9 @@ var CanvasPool = function ()
      * @function Phaser.Display.Canvas.CanvasPool.createWebGL
      * @since 3.0.0
      * 
-     * @param {any} parent - [description]
-     * @param {integer} [width=1] - [description]
-     * @param {integer} [height=1] - [description]
+     * @param {any} parent - The parent of the Canvas object.
+     * @param {integer} [width=1] - The width of the Canvas.
+     * @param {integer} [height=1] - The height of the Canvas.
      * 
      * @return {HTMLCanvasElement} [description]
      */
@@ -118,17 +118,17 @@ var CanvasPool = function ()
      * @function Phaser.Display.Canvas.CanvasPool.first
      * @since 3.0.0
      * 
-     * @param {integer} [type] - [description]
+     * @param {integer} [canvasType=Phaser.CANVAS] - The type of the Canvas. Either `Phaser.CANVAS` or `Phaser.WEBGL`.
      * 
      * @return {HTMLCanvasElement} [description]
      */
-    var first = function (type)
+    var first = function (canvasType)
     {
-        if (type === undefined) { type = CONST.CANVAS; }
+        if (canvasType === undefined) { canvasType = CONST.CANVAS; }
 
         pool.forEach(function (container)
         {
-            if (!container.parent && container.type === type)
+            if (!container.parent && container.type === canvasType)
             {
                 return container;
             }

src/display/canvas/Smoothing.js

@@ -18,9 +18,9 @@ var Smoothing = function ()
      *
      * @function Phaser.Display.Canvas.Smoothing.getPrefix
      * @since 3.0.0
-     * 
-     * @param {[type]} context - [description]
-     * 
+     *
+     * @param {CanvasRenderingContext2D|WebGLRenderingContext} context - [description]
+     *
      * @return {string} [description]
      */
     var getPrefix = function (context)
@@ -49,10 +49,10 @@ var Smoothing = function ()
      *
      * @function Phaser.Display.Canvas.Smoothing.enable
      * @since 3.0.0
-     * 
-     * @param {[type]} context - [description]
-     * 
-     * @return {[type]} [description]
+     *
+     * @param {CanvasRenderingContext2D|WebGLRenderingContext} context - [description]
+     *
+     * @return {CanvasRenderingContext2D|WebGLRenderingContext} [description]
      */
     var enable = function (context)
     {
@@ -78,10 +78,10 @@ var Smoothing = function ()
      *
      * @function Phaser.Display.Canvas.Smoothing.disable
      * @since 3.0.0
-     * 
-     * @param {[type]} context - [description]
-     * 
-     * @return {[type]} [description]
+     *
+     * @param {CanvasRenderingContext2D|WebGLRenderingContext} context - [description]
+     *
+     * @return {CanvasRenderingContext2D|WebGLRenderingContext} [description]
      */
     var disable = function (context)
     {
@@ -104,10 +104,10 @@ var Smoothing = function ()
      *
      * @function Phaser.Display.Canvas.Smoothing.isEnabled
      * @since 3.0.0
-     * 
-     * @param {[type]} context - [description]
-     * 
-     * @return {boolean} [description]
+     *
+     * @param {CanvasRenderingContext2D|WebGLRenderingContext} context - [description]
+     *
+     * @return {boolean|null} [description]
      */
     var isEnabled = function (context)
     {

src/display/mask/BitmapMask.js

@@ -16,50 +16,30 @@ var Class = require('../../utils/Class');
  * @since 3.0.0
  *
  * @param {Phaser.Scene} scene - [description]
- * @param {[type]} renderable - [description]
+ * @param {Phaser.GameObjects.GameObject} renderable - A renderable Game Object that uses a texture, such as a Sprite.
  */
 var BitmapMask = new Class({
-    
+
     initialize:
 
     function BitmapMask (scene, renderable)
     {
         var renderer = scene.sys.game.renderer;
 
         /**
-         * [description]
+         * A renderable Game Object that uses a texture, such as a Sprite.
          *
          * @name Phaser.Display.Masks.BitmapMask#bitmapMask
-         * @type {[type]}
+         * @type {Phaser.GameObjects.GameObject}
          * @since 3.0.0
          */
         this.bitmapMask = renderable;
 
-        /**
-         * [description]
-         *
-         * @name Phaser.Display.Masks.BitmapMask#maskRenderTarget
-         * @type {[type]}
-         * @default null
-         * @since 3.0.0
-         */
-        this.maskRenderTarget = null;
-
-        /**
-         * [description]
-         *
-         * @name Phaser.Display.Masks.BitmapMask#mainRenderTarget
-         * @type {[type]}
-         * @default null
-         * @since 3.0.0
-         */
-        this.mainRenderTarget = null;
-
         /**
          * [description]
          *
          * @name Phaser.Display.Masks.BitmapMask#maskTexture
-         * @type {[type]}
+         * @type {WebGLTexture}
          * @default null
          * @since 3.0.0
          */
@@ -69,7 +49,7 @@ var BitmapMask = new Class({
          * [description]
          *
          * @name Phaser.Display.Masks.BitmapMask#mainTexture
-         * @type {[type]}
+         * @type {WebGLTexture}
          * @default null
          * @since 3.0.0
          */
@@ -125,7 +105,7 @@ var BitmapMask = new Class({
             this.maskTexture = renderer.createTexture2D(0, filter, filter, wrap, wrap, gl.RGBA, null, width, height);
             this.mainFramebuffer = renderer.createFramebuffer(width, height, this.mainTexture, false);
             this.maskFramebuffer = renderer.createFramebuffer(width, height, this.maskTexture, false);
-            
+
             renderer.onContextRestored(function (renderer)
             {
                 var width = renderer.width;
@@ -150,7 +130,7 @@ var BitmapMask = new Class({
      * @method Phaser.Display.Masks.BitmapMask#setBitmap
      * @since 3.0.0
      *
-     * @param {[type]} renderable - [description]
+     * @param {Phaser.GameObjects.GameObject} renderable - A renderable Game Object that uses a texture, such as a Sprite.
      */
     setBitmap: function (renderable)
     {
@@ -163,8 +143,8 @@ var BitmapMask = new Class({
      * @method Phaser.Display.Masks.BitmapMask#preRenderWebGL
      * @since 3.0.0
      *
-     * @param {[type]} renderer - [description]
-     * @param {[type]} maskedObject - [description]
+     * @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
+     * @param {Phaser.GameObjects.GameObject} maskedObject - [description]
      * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to render to.
      */
     preRenderWebGL: function (renderer, maskedObject, camera)
@@ -178,7 +158,7 @@ var BitmapMask = new Class({
      * @method Phaser.Display.Masks.BitmapMask#postRenderWebGL
      * @since 3.0.0
      *
-     * @param {[type]} renderer - [description]
+     * @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
      */
     postRenderWebGL: function (renderer)
     {
@@ -191,8 +171,8 @@ var BitmapMask = new Class({
      * @method Phaser.Display.Masks.BitmapMask#preRenderCanvas
      * @since 3.0.0
      *
-     * @param {[type]} renderer - [description]
-     * @param {[type]} mask - [description]
+     * @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
+     * @param {Phaser.GameObjects.GameObject} mask - [description]
      * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to render to.
      */
     preRenderCanvas: function ()
@@ -206,7 +186,7 @@ var BitmapMask = new Class({
      * @method Phaser.Display.Masks.BitmapMask#postRenderCanvas
      * @since 3.0.0
      *
-     * @param {[type]} renderer - [description]
+     * @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
      */
     postRenderCanvas: function ()
     {

src/display/mask/GeometryMask.js

@@ -16,7 +16,7 @@ var Class = require('../../utils/Class');
  * @since 3.0.0
  *
  * @param {Phaser.Scene} scene - [description]
- * @param {[type]} graphicsGeometry - [description]
+ * @param {Phaser.GameObjects.Graphics} graphicsGeometry - [description]
  */
 var GeometryMask = new Class({
 
@@ -53,8 +53,8 @@ var GeometryMask = new Class({
      * @method Phaser.Display.Masks.GeometryMask#preRenderWebGL
      * @since 3.0.0
      *
-     * @param {[type]} renderer - [description]
-     * @param {[type]} mask - [description]
+     * @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
+     * @param {Phaser.GameObjects.GameObject} mask - [description]
      * @param {Phaser.Cameras.Scene2D.Camera} camera - [description]
      */
     preRenderWebGL: function (renderer, mask, camera)
@@ -88,7 +88,7 @@ var GeometryMask = new Class({
      * @method Phaser.Display.Masks.GeometryMask#postRenderWebGL
      * @since 3.0.0
      *
-     * @param {[type]} renderer - [description]
+     * @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
      */
     postRenderWebGL: function (renderer)
     {
@@ -105,8 +105,8 @@ var GeometryMask = new Class({
      * @method Phaser.Display.Masks.GeometryMask#preRenderCanvas
      * @since 3.0.0
      *
-     * @param {[type]} renderer - [description]
-     * @param {[type]} mask - [description]
+     * @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
+     * @param {Phaser.GameObjects.GameObject} mask - [description]
      * @param {Phaser.Cameras.Scene2D.Camera} camera - [description]
      */
     preRenderCanvas: function (renderer, mask, camera)
@@ -126,7 +126,7 @@ var GeometryMask = new Class({
      * @method Phaser.Display.Masks.GeometryMask#postRenderCanvas
      * @since 3.0.0
      *
-     * @param {[type]} renderer - [description]
+     * @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
      */
     postRenderCanvas: function (renderer)
     {

src/gameobjects/GameObjectCreator.js

@@ -120,11 +120,11 @@ var GameObjectCreator = new Class({
 
 //  Static method called directly by the Game Object creator functions
 
-GameObjectCreator.register = function (type, factoryFunction)
+GameObjectCreator.register = function (factoryType, factoryFunction)
 {
-    if (!GameObjectCreator.prototype.hasOwnProperty(type))
+    if (!GameObjectCreator.prototype.hasOwnProperty(factoryType))
     {
-        GameObjectCreator.prototype[type] = factoryFunction;
+        GameObjectCreator.prototype[factoryType] = factoryFunction;
     }
 };
 

src/gameobjects/GameObjectFactory.js

@@ -147,11 +147,11 @@ var GameObjectFactory = new Class({
 
 //  Static method called directly by the Game Object factory functions
 
-GameObjectFactory.register = function (type, factoryFunction)
+GameObjectFactory.register = function (factoryType, factoryFunction)
 {
-    if (!GameObjectFactory.prototype.hasOwnProperty(type))
+    if (!GameObjectFactory.prototype.hasOwnProperty(factoryType))
     {
-        GameObjectFactory.prototype[type] = factoryFunction;
+        GameObjectFactory.prototype[factoryType] = factoryFunction;
     }
 };