Merge branch 'master' into rendering-cleanup

Author: bitnenfer

src/animations/Animation.js

@@ -462,8 +462,6 @@ var Animation = new Class({
             });
         }
 
-        // console.table(frames);
-
         if (!Array.isArray(frames) || frames.length === 0)
         {
             return out;
@@ -480,23 +478,17 @@ var Animation = new Class({
                 continue;
             }
 
+            //  Could be an integer or a string
             var frame = GetValue(item, 'frame', 0);
 
+            //  The actual texture frame
             var textureFrame = textureManager.getFrame(key, frame);
 
             animationFrame = new Frame(key, frame, index, textureFrame);
 
             animationFrame.duration = GetValue(item, 'duration', 0);
             animationFrame.onUpdate = GetValue(item, 'onUpdate', null);
 
-            var visible = GetValue(item, 'visible', null);
-
-            if (visible !== null)
-            {
-                animationFrame.setVisible = true;
-                animationFrame.visible = visible;
-            }
-
             animationFrame.isFirst = (!prev);
 
             //  The previously created animationFrame

src/animations/AnimationFrame.js

@@ -1,156 +1,156 @@
 var Class = require('../utils/Class');
 
-//  Phaser.Animations.AnimationFrame
-
 var AnimationFrame = new Class({
 
     initialize:
 
     /**
-     * [description]
+     * A single frame in an Animation sequence.
+     *
+     * An AnimationFrame consists of a reference to the Texture it uses for rendering, references to other
+     * frames in the animation, and index data. It also has the ability to fire its own `onUpdate` callback
+     * and modify the animation timing.
+     *
+     * AnimationFrames are generated automatically by the Animation class.
      *
      * @class AnimationFrame
-     * @memberOf Phaser.Animations.AnimationFrame
+     * @memberOf Phaser.Animations
      * @constructor
      * @since 3.0.0
      *
-     * @param {undefined} textureKey - [description]
-     * @param {undefined} textureFrame - [description]
-     * @param {undefined} index - [description]
-     * @param {undefined} frame - [description]
+     * @param {string} textureKey - The key of the Texture this AnimationFrame uses.
+     * @param {string|integer} textureFrame - The key of the Frame within the Texture that this AnimationFrame uses.
+     * @param {integer} index - The index of this AnimationFrame within the Animation sequence.
+     * @param {Phaser.Textures.Frame} frame - A reference to the Texture Frame this AnimationFrame uses for rendering.
      */
     function AnimationFrame (textureKey, textureFrame, index, frame)
     {
-        //  The keys into the Texture Manager of the texture + frame this uses
-
         /**
-         * [description]
+         * The key of the Texture this AnimationFrame uses.
          *
          * @property {string} textureKey
+         * @since 3.0.0
          */
         this.textureKey = textureKey;
 
         /**
-         * [description]
+         * The key of the Frame within the Texture that this AnimationFrame uses.
          *
-         * @property {Phaser.Textures.Frame} textureFrame
+         * @property {string|integer} textureFrame
+         * @since 3.0.0
          */
         this.textureFrame = textureFrame;
 
-        //  The index of this frame within the Animation.frames array
-
         /**
-         * [description]
+         * The index of this AnimationFrame within the Animation sequence.
          *
          * @property {integer} index
+         * @since 3.0.0
          */
         this.index = index;
 
-        //  Texture Frame
-
         /**
-         * [description]
+         * A reference to the Texture Frame this AnimationFrame uses for rendering.
          *
          * @property {Phaser.Textures.Frame} frame
+         * @since 3.0.0
          */
         this.frame = frame;
 
-        //  Read-only
-
         /**
-         * [description]
+         * Is this the first frame in an animation sequence?
          *
          * @property {boolean} isFirst
          * @default false
+         * @readOnly
+         * @since 3.0.0
          */
         this.isFirst = false;
 
-        //  Read-only
-
         /**
-         * [description]
+         * Is this the last frame in an animation sequence?
          *
          * @property {boolean} isLast
          * @default false
+         * @readOnly
+         * @since 3.0.0
          */
         this.isLast = false;
 
-        //  The frame that comes before this one in the animation (if any)
-        //  Read-only
-
         /**
-         * [description]
+         * A reference to the AnimationFrame that comes before this one in the animation, if any.
          *
-         * @property {?[type]} prevFrame
+         * @property {?Phaser.Animations.AnimationFrame} prevFrame
          * @default null
+         * @readOnly
+         * @since 3.0.0
          */
         this.prevFrame = null;
 
-        //  The frame that comes after this one in the animation (if any)
-        //  Read-only
-
         /**
-         * [description]
+         * A reference to the AnimationFrame that comes after this one in the animation, if any.
          *
-         * @property {?[type]} nextFrame
+         * @property {?Phaser.Animations.AnimationFrame} nextFrame
          * @default null
+         * @readOnly
+         * @since 3.0.0
          */
         this.nextFrame = null;
 
-        //   Additional time (in ms) this frame should appear for - added onto the msPerFrame
-
         /**
-         * [description]
+         * Additional time (in ms) that this frame should appear for during playback.
+         * The value is added onto the msPerFrame set by the animation.
          *
          * @property {number} duration
          * @default 0
+         * @since 3.0.0
          */
         this.duration = 0;
 
-        //   What % through the animation progress is this frame?
-        //  Read-only
-
         /**
-         * [description]
+         * What % through the animation does this frame come?
+         * This value is generated when the animation is created and cached here.
          *
          * @property {number} progress
          * @default 0
+         * @readOnly
+         * @since 3.0.0
          */
         this.progress = 0;
 
-        //  Callback if this frame gets displayed
-
         /**
-         * [description]
+         * A frame specific callback, invoked if this frame gets displayed and the callback is set.
          *
-         * @property {?[type]} onUpdate
+         * @property {?function} onUpdate
          * @default null
+         * @since 3.0.0
          */
         this.onUpdate = null;
-
-        //  When this frame hits, set sprite.visible to this
-
-        /**
-         * [description]
-         *
-         * @property {boolean} setVisible
-         * @default false
-         */
-        this.setVisible = false;
-
-        this.visible = false;
     },
 
+    /**
+     * Generates a JavaScript object suitable for converting to JSON.
+     *
+     * @method Phaser.Animations.AnimationFrame#toJSON
+     * @since 3.0.0
+     * 
+     * @return {object} The AnimationFrame data.
+     */
     toJSON: function ()
     {
         return {
             key: this.textureKey,
             frame: this.textureFrame,
-            duration: this.duration,
-            visible: this.visible
+            duration: this.duration
         };
     },
 
+    /**
+     * Destroys this object by removing references to external resources and callbacks.
+     *
+     * @method Phaser.Animations.AnimationFrame#destroy
+     * @since 3.0.0
+     */
     destroy: function ()
     {
         this.frame = undefined;

src/boot/Config.js

@@ -23,9 +23,22 @@ var ValueToColor = require('../display/color/ValueToColor');
  */
 
 /**
- * @typedef {object} GameConfig
+ * @typedef {object} LoaderConfig
  *
- * @todo Add Physics Config
+ * @property {string} [baseURL] - [description]
+ * @property {string} [path] - [description]
+ * @property {boolean} [enableParallel=true] - [description]
+ * @property {integer} [maxParallelDownloads=4] - [description]
+ * @property {string|undefined} [crossOrigin=undefined] - [description]
+ * @property {string} [responseType] - [description]
+ * @property {boolean} [async=true] - [description]
+ * @property {string} [user] - [description]
+ * @property {string} [password] - [description]
+ * @property {integer} [timeout=0] - [description]
+ */
+
+/**
+ * @typedef {object} GameConfig
  *
  * @property {integer|string} [width=1024] - [description]
  * @property {integer|string} [height=768] - [description]
@@ -59,11 +72,10 @@ var ValueToColor = require('../display/color/ValueToColor');
  * @property {boolean} [transparent=false] - [description]
  * @property {boolean} [clearBeforeRender=true] - [description]
  * @property {string|number} [backgroundColor=0x000000] - [description]
- * @property {boolean} [preserveDrawingBuffer=false] - [description]
  * @property {object} [?callbacks] - [description]
  * @property {function} [callbacks.preBoot=NOOP] - [description]
  * @property {function} [callbacks.postBoot=NOOP] - [description]
- * @property {boolean} [useTicker=false] - [description]
+ * @property {LoaderConfig} [?loader] - [description]
  * @property {object} [?images] - [description]
  * @property {string} [images.default] - [description]
  * @property {string} [images.missing] - [description]
@@ -164,14 +176,11 @@ var Config = new Class({
         this.transparent = GetValue(config, 'transparent', false);
         this.clearBeforeRender = GetValue(config, 'clearBeforeRender', true);
         this.backgroundColor = ValueToColor(GetValue(config, 'backgroundColor', 0));
-        this.preserveDrawingBuffer = GetValue(config, 'preserveDrawingBuffer', false);
 
         //  Callbacks
         this.preBoot = GetValue(config, 'callbacks.preBoot', NOOP);
         this.postBoot = GetValue(config, 'callbacks.postBoot', NOOP);
 
-        this.useTicker = GetValue(config, 'useTicker', false);
-
         //  Physics
         //  physics: {
         //      system: 'impact',

src/boot/CreateRenderer.js

@@ -1,15 +1,17 @@
-var CONST = require('../const');
+var CanvasInterpolation = require('../display/canvas/CanvasInterpolation');
 var CanvasPool = require('../display/canvas/CanvasPool');
+var CONST = require('../const');
 var Features = require('../device/Features');
-var CanvasInterpolation = require('../display/canvas/CanvasInterpolation');
 
 /**
- * [description]
+ * Called automatically by Phaser.Game and responsible for creating the renderer it will use.
+ *
+ * Relies upon two webpack global flags to be defined: `WEBGL_RENDERER` and `CANVAS_RENDERER` during build time, but not at run-time.
  *
  * @function Phaser.Boot.CreateRenderer
  * @since 3.0.0
  *
- * @param {Phaser.Game} game - [description]
+ * @param {Phaser.Game} game - The Phaser.Game instance on which the renderer will be set.
  */
 var CreateRenderer = function (game)
 {

src/boot/DebugHeader.js

@@ -1,13 +1,15 @@
-var CONST = require('../const');
 var CHECKSUM = require('../checksum');
+var CONST = require('../const');
 
 /**
- * [description]
+ * Called automatically by Phaser.Game and responsible for creating the console.log debug header.
+ *
+ * You can customize or disable the header via the Game Config object.
  *
  * @function Phaser.Boot.DebugHeader
  * @since 3.0.0
  *
- * @param {Phaser.Game} game - [description]
+ * @param {Phaser.Game} game - The Phaser.Game instance which will output this debug header.
  */
 var DebugHeader = function (game)
 {
@@ -25,11 +27,11 @@ var DebugHeader = function (game)
 
     var audioType;
 
-    if(deviceAudio.webAudio && !(audioConfig && audioConfig.disableWebAudio))
+    if (deviceAudio.webAudio && !(audioConfig && audioConfig.disableWebAudio))
     {
         audioType = 'Web Audio';
     }
-    else if((audioConfig && audioConfig.noAudio) || (!deviceAudio.webAudio && !deviceAudio.audioData))
+    else if ((audioConfig && audioConfig.noAudio) || (!deviceAudio.webAudio && !deviceAudio.audioData))
     {
         audioType = 'No Audio';
     }
@@ -38,9 +40,7 @@ var DebugHeader = function (game)
         audioType = 'HTML5 Audio';
     }
 
-    var ie = false;
-
-    if (!ie)
+    if (!game.device.Browser.ie)
     {
         var c = '';
         var args = [ c ];
@@ -103,9 +103,6 @@ var DebugHeader = function (game)
     {
         console.log('Phaser v' + CONST.VERSION + ' / http://phaser.io');
     }
-
-    // Keep this during dev build only
-    // console.log(CHECKSUM.build);
 };
 
 module.exports = DebugHeader;