melonjs 10.2.1 → 10.2.2

package/src/particles/emitter.js

@@ -16,8 +16,8 @@ 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
  * @see me.ParticleEmitter
@@ -26,7 +26,7 @@ var ParticleEmitterSettings = {
     /**
      * Width of the particle spawn area.<br>
      * @public
-     * @type Number
+     * @type {number}
      * @name width
      * @memberOf me.ParticleEmitterSettings
      * @default 0
@@ -34,9 +34,9 @@ var ParticleEmitterSettings = {
     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
      * @default 0
@@ -44,9 +44,9 @@ var ParticleEmitterSettings = {
     height : 0,
 
     /**
-     * Image used for particles.<br>
+     * Image used for particles
      * @public
-     * @type CanvasImageSource
+     * @type {CanvasImageSource}
      * @name image
      * @memberOf me.ParticleEmitterSettings
      * @default 1x1 white pixel
@@ -55,9 +55,9 @@ var ParticleEmitterSettings = {
     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
@@ -65,9 +65,9 @@ var 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
@@ -75,9 +75,9 @@ var 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
@@ -85,9 +85,9 @@ var 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
@@ -95,9 +95,9 @@ var 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
@@ -107,7 +107,7 @@ var ParticleEmitterSettings = {
     /**
      * Start speed of particles.<br>
      * @public
-     * @type Number
+     * @type {number}
      * @name speed
      * @default 2
      * @memberOf me.ParticleEmitterSettings
@@ -115,9 +115,9 @@ var 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
@@ -125,9 +125,9 @@ var 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
@@ -135,9 +135,9 @@ var 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
@@ -145,9 +145,9 @@ var 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
@@ -155,9 +155,9 @@ var 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
@@ -165,9 +165,9 @@ var 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
@@ -175,9 +175,9 @@ var 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
@@ -185,9 +185,9 @@ var 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
@@ -196,9 +196,9 @@ var ParticleEmitterSettings = {
     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
@@ -210,7 +210,7 @@ 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
@@ -221,7 +221,7 @@ 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
@@ -231,7 +231,7 @@ var ParticleEmitterSettings = {
     /**
      * 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
@@ -241,7 +241,7 @@ var ParticleEmitterSettings = {
     /**
      * Render particles in screen space. <br>
      * @public
-     * @type Boolean
+     * @type {boolean}
      * @name floating
      * @default false
      * @memberOf me.ParticleEmitterSettings
@@ -251,7 +251,7 @@ var ParticleEmitterSettings = {
     /**
      * 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
@@ -262,7 +262,7 @@ 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
@@ -273,7 +273,7 @@ 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
@@ -284,7 +284,7 @@ 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
@@ -298,11 +298,10 @@ var ParticleEmitterSettings = {
  * @extends Rect
  * @memberOf me
  * @constructor
- * @param {Number} x x-position of the particle emitter
- * @param {Number} y y-position of the particle emitter
+ * @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 +323,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 {
 
@@ -379,7 +377,7 @@ class ParticleEmitter extends Renderable {
 
         /**
          * Floating property for particles, value is forwarded to the particle container <br>
-         * @type Boolean
+         * @type {boolean}
          * @name floating
          * @memberOf me.ParticleEmitter
          */
@@ -432,7 +430,7 @@ class ParticleEmitter extends Renderable {
      * @name getRandomPointX
      * @memberOf me.ParticleEmitter
      * @function
-     * @return {Number}
+     * @returns {number}
      */
     getRandomPointX() {
         return this.pos.x + randomFloat(0, this.width);
@@ -443,7 +441,7 @@ class ParticleEmitter extends Renderable {
      * @name getRandomPointY
      * @memberOf me.ParticleEmitter
      * @function
-     * @return {Number}
+     * @returns {number}
      */
     getRandomPointY() {
         return this.pos.y + randomFloat(0, this.height);
@@ -452,7 +450,7 @@ 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
      */
@@ -484,7 +482,7 @@ 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
      */
@@ -495,7 +493,7 @@ 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
@@ -520,7 +518,7 @@ 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

package/src/particles/particle.js

@@ -101,7 +101,7 @@ class Particle extends Renderable {
      * @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/physics/body.js

@@ -16,7 +16,7 @@ import { world } from "./../game.js";
  * @memberOf me
  * @constructor
  * @param {me.Renderable} ancestor the parent object this body is attached to
- * @param {me.Rect|me.Rect[]|me.Polygon|me.Polygon[]|me.Line|me.Line[]|me.Ellipse|me.Ellipse[]|me.Bounds|me.Bounds[]|Object} [shapes] a initial shape, list of shapes, or JSON object defining the body
+ * @param {me.Rect|me.Rect[]|me.Polygon|me.Polygon[]|me.Line|me.Line[]|me.Ellipse|me.Ellipse[]|me.Bounds|me.Bounds[]|object} [shapes] a initial shape, list of shapes, or JSON object defining the body
  * @param {Function} [onBodyUpdate] callback for when the body is updated (e.g. add/remove shapes)
  */
 class Body {
@@ -27,7 +27,7 @@ class Body {
          * a reference to the parent object that contains this body,
          * or undefined if it has not been added to one.
          * @public
-         * @type me.Renderable
+         * @type {me.Renderable}
          * @default undefined
          * @name me.Body#ancestor
          */
@@ -59,7 +59,7 @@ class Body {
          * The body collision mask, that defines what should collide with what.<br>
          * (by default will collide with all entities)
          * @ignore
-         * @type Number
+         * @type {number}
          * @default me.collision.types.ALL_OBJECT
          * @name collisionMask
          * @see me.collision.types
@@ -70,7 +70,7 @@ class Body {
         /**
          * define the collision type of the body for collision filtering
          * @public
-         * @type Number
+         * @type {number}
          * @default me.collision.types.ENEMY_OBJECT
          * @name collisionType
          * @see me.collision.types
@@ -84,7 +84,7 @@ class Body {
         /**
          * body velocity
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <0,0>
          * @name vel
          * @memberOf me.Body
@@ -98,7 +98,7 @@ class Body {
          * body force or acceleration (automatically) applied to the body.
          * when defining a force, user should also define a max velocity
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <0,0>
          * @name force
          * @see me.Body.setMaxVelocity
@@ -129,7 +129,7 @@ class Body {
         /**
          * body friction
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <0,0>
          * @name friction
          * @memberOf me.Body
@@ -143,7 +143,7 @@ class Body {
          * the body bouciness level when colliding with other solid bodies :
          * a value of 0 will not bounce, a value of 1 will fully rebound.
          * @public
-         * @type {Number}
+         * @type {number}
          * @default 0
          * @name bounce
          * @memberOf me.Body
@@ -153,7 +153,7 @@ class Body {
         /**
          * the body mass
          * @public
-         * @type {Number}
+         * @type {number}
          * @default 1
          * @name mass
          * @memberOf me.Body
@@ -163,7 +163,7 @@ class Body {
         /**
          * max velocity (to limit body velocity)
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <490,490>
          * @name maxVel
          * @memberOf me.Body
@@ -179,7 +179,7 @@ class Body {
          * either this body is a static body or not
          * @readonly
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name isStatic
          * @memberOf me.Body
@@ -191,7 +191,7 @@ class Body {
          * The degree to which this body is affected by the world gravity
          * @public
          * @see me.World.gravity
-         * @type Number
+         * @type {number}
          * @default 1.0
          * @name gravityScale
          * @memberOf me.Body
@@ -202,7 +202,7 @@ class Body {
          * If true this body won't be affected by the world gravity
          * @public
          * @see me.World.gravity
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name ignoreGravity
          * @memberOf me.Body
@@ -215,7 +215,7 @@ class Body {
          * false if the object is standing on something<br>
          * @readonly
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name falling
          * @memberOf me.Body
@@ -227,7 +227,7 @@ class Body {
          * equal true if the body is jumping<br>
          * @readonly
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name jumping
          * @memberOf me.Body
@@ -263,7 +263,7 @@ class Body {
      * @memberOf me.Body
      * @public
      * @function
-     * @param {Boolean} [isStatic=true]
+     * @param {boolean} [isStatic=true]
      */
     setStatic(isStatic = true) {
         this.isStatic = isStatic === true;
@@ -276,8 +276,8 @@ class Body {
      * @memberOf me.Body
      * @public
      * @function
-     * @param {me.Rect|me.Polygon|me.Line|me.Ellipse|me.Bounds|Object} shape a shape or JSON object
-     * @return {Number} the shape array length
+     * @param {me.Rect|me.Polygon|me.Line|me.Ellipse|me.Bounds|object} shape a shape or JSON object
+     * @returns {number} the shape array length
      * @example
      * // add a rectangle shape
      * this.body.addShape(new me.Rect(0, 0, image.width, image.height));
@@ -331,7 +331,7 @@ class Body {
      * @public
      * @function
      * @param {me.Vector2d[]} vertices an array of me.Vector2d points defining a convex hull
-     * @param {Number} [index=0] the shape object for which to set the vertices
+     * @param {number} [index=0] the shape object for which to set the vertices
      * @param {boolean} [clear=true] either to reset the body definition before adding the new vertices
      */
     setVertices(vertices, index = 0, clear = true) {
@@ -358,7 +358,7 @@ class Body {
      * @public
      * @function
      * @param {me.Vector2d[]} vertices an array of me.Vector2d points defining a convex hull
-     * @param {Number} [index=0] the shape object for which to set the vertices
+     * @param {number} [index=0] the shape object for which to set the vertices
      */
     addVertices(vertices, index = 0) {
         this.setVertices(vertices, index, false);
@@ -371,10 +371,10 @@ class Body {
      * @memberOf me.Body
      * @public
      * @function
-     * @param {Object} json a JSON object as exported from a Physics Editor tool
-     * @param {String} [id] an optional shape identifier within the given the json object
+     * @param {object} json a JSON object as exported from a Physics Editor tool
+     * @param {string} [id] an optional shape identifier within the given the json object
      * @see https://www.codeandweb.com/physicseditor
-     * @return {Number} how many shapes were added to the body
+     * @returns {number} how many shapes were added to the body
      * @example
      * // define the body based on the banana shape
      * this.body.fromJSON(me.loader.getJSON("shapesdef").banana);
@@ -415,8 +415,8 @@ class Body {
      * @memberOf me.Body
      * @public
      * @function
-     * @param {Number} [index=0] the shape object at the specified index
-     * @return {me.Polygon|me.Line|me.Ellipse} shape a shape object if defined
+     * @param {number} [index=0] the shape object at the specified index
+     * @returns {me.Polygon|me.Line|me.Ellipse} shape a shape object if defined
      */
     getShape(index) {
         return this.shapes[index || 0];
@@ -427,7 +427,7 @@ class Body {
      * @name getBounds
      * @memberOf me.Body
      * @function
-     * @return {me.Bounds} bounding box Rectangle object
+     * @returns {me.Bounds} bounding box Rectangle object
      */
     getBounds() {
         return this.bounds;
@@ -440,7 +440,7 @@ class Body {
      * @public
      * @function
      * @param {me.Polygon|me.Line|me.Ellipse} shape a shape object
-     * @return {Number} the shape array length
+     * @returns {number} the shape array length
      */
     removeShape(shape) {
         // clear the current bounds
@@ -461,8 +461,8 @@ class Body {
      * @memberOf me.Body
      * @public
      * @function
-     * @param {Number} index the shape object at the specified index
-     * @return {Number} the shape array length
+     * @param {number} index the shape object at the specified index
+     * @returns {number} the shape array length
      */
     removeShapeAt(index) {
         return this.removeShape(this.getShape(index));
@@ -477,7 +477,7 @@ class Body {
      * @public
      * @function
      * @see me.collision.types
-     * @param {Number} [bitmask = me.collision.types.ALL_OBJECT] the collision mask
+     * @param {number} [bitmask = me.collision.types.ALL_OBJECT] the collision mask
      * @example
      * // filter collision detection with collision shapes, enemies and collectables
      * myEntity.body.setCollisionMask(me.collision.types.WORLD_SHAPE | me.collision.types.ENEMY_OBJECT | me.collision.types.COLLECTABLE_OBJECT);
@@ -496,7 +496,7 @@ class Body {
      * @public
      * @function
      * @see me.collision.types
-     * @param {Number} type the collision type
+     * @param {number} type the collision type
      * @example
      * // set the body collision type
      * myEntity.body.collisionType = me.collision.types.PLAYER_OBJECT;
@@ -558,7 +558,7 @@ class Body {
      * @memberOf me.Body.prototype
      * @function
      * @param {Function} callback fnction to execute on each element
-     * @param {Object} [thisArg] value to use as this(i.e reference Object) when executing callback.
+     * @param {object} [thisArg] value to use as this(i.e reference Object) when executing callback.
      * @example
      * // iterate through all shapes of the physic body
      * mySprite.body.forEach((shape) => {
@@ -595,7 +595,7 @@ class Body {
      * @memberOf me.Body
      * @function
      * @param  {me.Vector2d} point
-     * @return {boolean} true if contains
+     * @returns {boolean} true if contains
      */
 
     /**
@@ -603,9 +603,9 @@ class Body {
      * @name contains
      * @memberOf me.Body
      * @function
-     * @param  {Number} x x coordinate
-     * @param  {Number} y y coordinate
-     * @return {boolean} true if contains
+     * @param  {number} x x coordinate
+     * @param  {number} y y coordinate
+     * @returns {boolean} true if contains
      */
     contains() {
         var _x, _y;
@@ -637,9 +637,9 @@ class Body {
      * @name rotate
      * @memberOf me.Body
      * @function
-     * @param {Number} angle The angle to rotate (in radians)
+     * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v=me.Body.getBounds().center] an optional point to rotate around
-     * @return {me.Body} Reference to this object for method chaining
+     * @returns {me.Body} Reference to this object for method chaining
      */
     rotate(angle, v = this.getBounds().center) {
         this.bounds.clear();
@@ -664,8 +664,8 @@ class Body {
      * @name setMaxVelocity
      * @memberOf me.Body
      * @function
-     * @param {Number} x max velocity on x axis
-     * @param {Number} y max velocity on y axis
+     * @param {number} x max velocity on x axis
+     * @param {number} y max velocity on y axis
      * @protected
      */
     setMaxVelocity(x, y) {
@@ -678,8 +678,8 @@ class Body {
      * @name setFriction
      * @memberOf me.Body
      * @function
-     * @param {Number} x horizontal friction
-     * @param {Number} y vertical friction
+     * @param {number} x horizontal friction
+     * @param {number} y vertical friction
      * @protected
      */
     setFriction(x = 0, y = 0) {
@@ -765,8 +765,8 @@ class Body {
      * @ignore
      * @memberOf me.Body
      * @function
-     * @return {boolean} true if resulting velocity is different than 0
-     * @see source code for me.Body.computeVelocity (private member)
+     * @param {number} dt time since the last update in milliseconds.
+     * @returns {boolean} true if resulting velocity is different than 0
      */
     update(dt) {
         // update the velocity