melonjs 10.2.0 → 10.3.0

package/src/particles/emitter.js

@@ -16,192 +16,192 @@ var pixel = (function () {
 })();
 
 /**
- * me.ParticleEmitterSettings contains the default settings for me.ParticleEmitter.<br>
- * @private
+ * me.ParticleEmitterSettings contains the default settings for me.ParticleEmitter
+ * @ignore
  * @class
- * @memberOf me
+ * @memberof me
  * @see me.ParticleEmitter
  */
 var ParticleEmitterSettings = {
     /**
      * Width of the particle spawn area.<br>
      * @public
-     * @type Number
+     * @type {number}
      * @name width
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      * @default 0
      */
     width : 0,
 
     /**
-     * Height of the particle spawn area.<br>
+     * Height of the particle spawn area
      * @public
-     * @type Number
+     * @type {number}
      * @name height
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      * @default 0
      */
     height : 0,
 
     /**
-     * Image used for particles.<br>
+     * Image used for particles
      * @public
-     * @type CanvasImageSource
+     * @type {CanvasImageSource}
      * @name image
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      * @default 1x1 white pixel
      * @see http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#canvasimagesource
      */
     image : pixel,
 
     /**
-     * Total number of particles in the emitter.<br>
+     * Total number of particles in the emitter
      * @public
-     * @type Number
+     * @type {number}
      * @name totalParticles
      * @default 50
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     totalParticles : 50,
 
     /**
-     * Start angle for particle launch in Radians.<br>
+     * Start angle for particle launch in Radians
      * @public
-     * @type Number
+     * @type {number}
      * @name angle
      * @default Math.PI / 2
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     angle : Math.PI / 2,
 
     /**
-     * Variation in the start angle for particle launch in Radians.<br>
+     * Variation in the start angle for particle launch in Radians
      * @public
-     * @type Number
+     * @type {number}
      * @name angleVariation
      * @default 0
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     angleVariation : 0,
 
     /**
-     * Minimum time each particle lives once it is emitted in ms.<br>
+     * Minimum time each particle lives once it is emitted in ms
      * @public
-     * @type Number
+     * @type {number}
      * @name minLife
      * @default 1000
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     minLife : 1000,
 
     /**
-     * Maximum time each particle lives once it is emitted in ms.<br>
+     * Maximum time each particle lives once it is emitted in ms
      * @public
-     * @type Number
+     * @type {number}
      * @name maxLife
      * @default 3000
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     maxLife : 3000,
 
     /**
      * Start speed of particles.<br>
      * @public
-     * @type Number
+     * @type {number}
      * @name speed
      * @default 2
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     speed : 2,
 
     /**
-     * Variation in the start speed of particles.<br>
+     * Variation in the start speed of particles
      * @public
-     * @type Number
+     * @type {number}
      * @name speedVariation
      * @default 1
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     speedVariation : 1,
 
     /**
-     * Minimum start rotation for particles sprites in Radians.<br>
+     * Minimum start rotation for particles sprites in Radians
      * @public
-     * @type Number
+     * @type {number}
      * @name minRotation
      * @default 0
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     minRotation : 0,
 
     /**
-     * Maximum start rotation for particles sprites in Radians.<br>
+     * Maximum start rotation for particles sprites in Radians
      * @public
-     * @type Number
+     * @type {number}
      * @name maxRotation
      * @default 0
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     maxRotation : 0,
 
     /**
-     * Minimum start scale ratio for particles (1 = no scaling).<br>
+     * Minimum start scale ratio for particles (1 = no scaling)
      * @public
-     * @type Number
+     * @type {number}
      * @name minStartScale
      * @default 1
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     minStartScale : 1,
 
     /**
-     * Maximum start scale ratio for particles (1 = no scaling).<br>
+     * Maximum start scale ratio for particles (1 = no scaling)
      * @public
-     * @type Number
+     * @type {number}
      * @name maxStartScale
      * @default 1
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     maxStartScale : 1,
 
     /**
-     * Minimum end scale ratio for particles.<br>
+     * Minimum end scale ratio for particles
      * @public
-     * @type Number
+     * @type {number}
      * @name minEndScale
      * @default 0
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     minEndScale : 0,
 
     /**
-     * Maximum end scale ratio for particles.<br>
+     * Maximum end scale ratio for particles
      * @public
-     * @type Number
+     * @type {number}
      * @name maxEndScale
      * @default 0
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     maxEndScale : 0,
 
     /**
-     * Vertical force (Gravity) for each particle.<br>
+     * Vertical force (Gravity) for each particle
      * @public
-     * @type Number
+     * @type {number}
      * @name gravity
      * @default 0
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      * @see me.game.world.gravity
      */
     gravity : 0,
 
     /**
-     * Horizontal force (like a Wind) for each particle.<br>
+     * Horizontal force (like a Wind) for each particle
      * @public
-     * @type Number
+     * @type {number}
      * @name wind
      * @default 0
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     wind : 0,
 
@@ -210,10 +210,10 @@ var ParticleEmitterSettings = {
      * The particle sprite should aim at zero angle (draw from left to right).<br>
      * Override the particle minRotation and maxRotation.<br>
      * @public
-     * @type Boolean
+     * @type {boolean}
      * @name followTrajectory
      * @default false
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     followTrajectory : false,
 
@@ -221,40 +221,40 @@ var ParticleEmitterSettings = {
      * Enable the Texture Additive by canvas composite operation (lighter).<br>
      * WARNING: Composite Operation may decreases performance!.<br>
      * @public
-     * @type Boolean
+     * @type {boolean}
      * @name textureAdditive
      * @default false
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     textureAdditive : false,
 
     /**
      * Update particles only in the viewport, remove it when out of viewport.<br>
      * @public
-     * @type Boolean
+     * @type {boolean}
      * @name onlyInViewport
      * @default true
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     onlyInViewport : true,
 
     /**
      * Render particles in screen space. <br>
      * @public
-     * @type Boolean
+     * @type {boolean}
      * @name floating
      * @default false
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     floating : false,
 
     /**
      * Maximum number of particles launched each time in this emitter (used only if emitter is Stream).<br>
      * @public
-     * @type Number
+     * @type {number}
      * @name maxParticles
      * @default 10
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     maxParticles : 10,
 
@@ -262,10 +262,10 @@ var ParticleEmitterSettings = {
      * How often a particle is emitted in ms (used only if emitter is Stream).<br>
      * Necessary that value is greater than zero.<br>
      * @public
-     * @type Number
+     * @type {number}
      * @name frequency
      * @default 100
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     frequency : 100,
 
@@ -273,10 +273,10 @@ var ParticleEmitterSettings = {
      * Duration that the emitter releases particles in ms (used only if emitter is Stream).<br>
      * After this period, the emitter stop the launch of particles.<br>
      * @public
-     * @type Number
+     * @type {number}
      * @name duration
      * @default Infinity
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     duration : Infinity,
 
@@ -284,10 +284,10 @@ var ParticleEmitterSettings = {
      * Skip n frames after updating the particle system once. <br>
      * This can be used to reduce the performance impact of emitters with many particles.<br>
      * @public
-     * @type Number
+     * @type {number}
      * @name framesToSkip
      * @default 0
-     * @memberOf me.ParticleEmitterSettings
+     * @memberof me.ParticleEmitterSettings
      */
     framesToSkip : 0
 };
@@ -295,14 +295,12 @@ var ParticleEmitterSettings = {
 /**
  * Particle Emitter Object.
  * @class
- * @extends Rect
- * @memberOf me
- * @constructor
- * @param {Number} x x-position of the particle emitter
- * @param {Number} y y-position of the particle emitter
+ * @augments Rect
+ * @memberof me
+ * @param {number} x x-position of the particle emitter
+ * @param {number} y y-position of the particle emitter
  * @param {object} settings An object containing the settings for the particle emitter. See {@link me.ParticleEmitterSettings}
  * @example
- *
  * // Create a basic emitter at position 100, 100
  * var emitter = new me.ParticleEmitter(100, 100);
  *
@@ -324,7 +322,6 @@ var ParticleEmitterSettings = {
  * // At the end, remove emitter from the game world
  * // call this in onDestroyEvent function
  * me.game.world.removeChild(emitter);
- *
  */
 class ParticleEmitter extends Renderable {
 
@@ -361,45 +358,38 @@ class ParticleEmitter extends Renderable {
 
         this.container = new ParticleContainer(this);
 
-        /**
-         * @ignore
-         */
-        Object.defineProperty(this.pos, "z", {
-            /**
-             * @ignore
-             */
-            get : (function () { return this.container.pos.z; }).bind(this),
-            /**
-             * @ignore
-             */
-            set : (function (value) { this.container.pos.z = value; }).bind(this),
-            enumerable : true,
-            configurable : true
-        });
-
-        /**
-         * Floating property for particles, value is forwarded to the particle container <br>
-         * @type Boolean
-         * @name floating
-         * @memberOf me.ParticleEmitter
-         */
-        Object.defineProperty(this, "floating", {
-            /**
-             * @ignore
-             */
-            get : function () { return this.container.floating; },
-            /**
-             * @ignore
-             */
-            set : function (value) { this.container.floating = value; },
-            enumerable : true,
-            configurable : true
-        });
-
         // Reset the emitter to defaults
         this.reset(settings);
     }
 
+    /**
+     * @ignore
+     */
+    get z() {
+        return this.container.pos.z;
+    }
+
+    /**
+     * @ignore
+     */
+    set z(value) {
+        this.container.pos.z = value;
+    }
+
+    /**
+     * Floating property for particles, value is forwarded to the particle container <br>
+     * @type {boolean}
+     * @name floating
+     * @memberof me.ParticleEmitter
+     */
+    get floating() {
+        return this.container.floating;
+    }
+
+    set floating(value) {
+        this.container.floating = value;
+    }
+
     /**
      * @ignore
      */
@@ -430,9 +420,9 @@ class ParticleEmitter extends Renderable {
     /**
      * returns a random point inside the bounds x axis of this emitter
      * @name getRandomPointX
-     * @memberOf me.ParticleEmitter
+     * @memberof me.ParticleEmitter
      * @function
-     * @return {Number}
+     * @returns {number}
      */
     getRandomPointX() {
         return this.pos.x + randomFloat(0, this.width);
@@ -441,9 +431,9 @@ class ParticleEmitter extends Renderable {
     /**
      * returns a random point inside the bounds y axis of this emitter
      * @name getRandomPointY
-     * @memberOf me.ParticleEmitter
+     * @memberof me.ParticleEmitter
      * @function
-     * @return {Number}
+     * @returns {number}
      */
     getRandomPointY() {
         return this.pos.y + randomFloat(0, this.height);
@@ -452,9 +442,9 @@ class ParticleEmitter extends Renderable {
     /**
      * Reset the emitter with default values.<br>
      * @function
-     * @param {Object} settings [optional] object with emitter settings. See {@link me.ParticleEmitterSettings}
+     * @param {object} settings [optional] object with emitter settings. See {@link me.ParticleEmitterSettings}
      * @name reset
-     * @memberOf me.ParticleEmitter
+     * @memberof me.ParticleEmitter
      */
     reset(settings) {
         // check if settings exists and create a dummy object if necessary
@@ -484,9 +474,9 @@ class ParticleEmitter extends Renderable {
     /**
      * Emitter is of type stream and is launching particles <br>
      * @function
-     * @returns {Boolean} Emitter is Stream and is launching particles
+     * @returns {boolean} Emitter is Stream and is launching particles
      * @name isRunning
-     * @memberOf me.ParticleEmitter
+     * @memberof me.ParticleEmitter
      */
     isRunning() {
         return this._enabled && this._stream;
@@ -495,10 +485,10 @@ class ParticleEmitter extends Renderable {
     /**
      * Launch particles from emitter constantly <br>
      * Particles example: Fountains
-     * @param {Number} duration [optional] time that the emitter releases particles in ms
+     * @param {number} duration [optional] time that the emitter releases particles in ms
      * @function
      * @name streamParticles
-     * @memberOf me.ParticleEmitter
+     * @memberof me.ParticleEmitter
      */
     streamParticles(duration) {
         this._enabled = true;
@@ -511,7 +501,7 @@ class ParticleEmitter extends Renderable {
      * Stop the emitter from generating new particles (used only if emitter is Stream) <br>
      * @function
      * @name stopStream
-     * @memberOf me.ParticleEmitter
+     * @memberof me.ParticleEmitter
      */
     stopStream() {
         this._enabled = false;
@@ -520,10 +510,10 @@ class ParticleEmitter extends Renderable {
     /**
      * Launch all particles from emitter and stop <br>
      * Particles example: Explosions <br>
-     * @param {Number} total [optional] number of particles to launch
+     * @param {number} total [optional] number of particles to launch
      * @function
      * @name burstParticles
-     * @memberOf me.ParticleEmitter
+     * @memberof me.ParticleEmitter
      */
     burstParticles(total) {
         this._enabled = true;

package/src/particles/particle.js

@@ -8,9 +8,8 @@ import Renderable from "./../renderable/renderable.js";
  * @classdesc
  * Single Particle Object.
  * @class Particle
- * @extends me.Renderable
- * @memberOf me
- * @constructor
+ * @augments me.Renderable
+ * @memberof me
  * @param {me.ParticleEmitter} particle emitter
  */
 class Particle extends Renderable {
@@ -98,10 +97,10 @@ class Particle extends Renderable {
      * Update the Particle <br>
      * This is automatically called by the game manager {@link me.game}
      * @name update
-     * @memberOf me.Particle
+     * @memberof me.Particle
      * @function
      * @ignore
-     * @param {Number} dt time since the last update in milliseconds
+     * @param {number} dt time since the last update in milliseconds
      */
     update(dt) {
         // move things forward independent of the current frame rate

package/src/particles/particlecontainer.js

@@ -5,9 +5,8 @@ import { viewport } from "./../game.js";
  * @classdesc
  * Particle Container Object.
  * @class ParticleContainer
- * @extends me.Container
- * @memberOf me
- * @constructor
+ * @augments me.Container
+ * @memberof me
  * @param {me.ParticleEmitter} emitter the emitter which owns this container
  */