melonjs 15.3.0 → 15.4.0

package/src/math/vector3.js

@@ -5,7 +5,7 @@ import pool from "./../system/pooling.js";
  * @classdesc
  * a generic 3D Vector Object
  */
- export default class Vector3d {
+export default class Vector3d {
     /**
      * @param {number} [x=0] - x value of the vector
      * @param {number} [y=0] - y value of the vector
@@ -38,8 +38,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * set the Vector x and y properties to the given values<br>
-     * @name set
-     * @memberof Vector3d
      * @param {number} x
      * @param {number} y
      * @param {number} [z=0]
@@ -84,8 +82,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * set the Vector x and y properties to 0
-     * @name setZero
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     setZero() {
@@ -94,8 +90,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * set the Vector x and y properties using the passed vector
-     * @name setV
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -105,8 +99,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Add the passed vector to this vector
-     * @name add
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -116,8 +108,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Substract the passed vector to this vector
-     * @name sub
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -127,8 +117,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Multiply this vector values by the given scalar
-     * @name scale
-     * @memberof Vector3d
      * @param {number} x
      * @param {number} [y=x]
      * @param {number} [z=1]
@@ -140,8 +128,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Multiply this vector values by the passed vector
-     * @name scaleV
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -151,8 +137,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Convert this vector into isometric coordinate space
-     * @name toIso
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     toIso() {
@@ -161,8 +145,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Convert this vector into 2d coordinate space
-     * @name to2d
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     to2d() {
@@ -171,8 +153,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Divide this vector values by the passed value
-     * @name div
-     * @memberof Vector3d
      * @param {number} n - the value to divide the vector by
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -182,8 +162,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Update this vector values to absolute values
-     * @name abs
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     abs() {
@@ -192,8 +170,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Clamp the vector value within the specified value range
-     * @name clamp
-     * @memberof Vector3d
      * @param {number} low
      * @param {number} high
      * @returns {Vector3d} new me.Vector3d
@@ -204,8 +180,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Clamp this vector value within the specified value range
-     * @name clampSelf
-     * @memberof Vector3d
      * @param {number} low
      * @param {number} high
      * @returns {Vector3d} Reference to this object for method chaining
@@ -216,8 +190,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Update this vector with the minimum value between this and the passed vector
-     * @name minV
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -228,8 +200,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Update this vector with the maximum value between this and the passed vector
-     * @name maxV
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -240,8 +210,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Floor the vector values
-     * @name floor
-     * @memberof Vector3d
      * @returns {Vector3d} new me.Vector3d
      */
     floor() {
@@ -250,8 +218,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Floor this vector values
-     * @name floorSelf
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     floorSelf() {
@@ -260,8 +226,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Ceil the vector values
-     * @name ceil
-     * @memberof Vector3d
      * @returns {Vector3d} new me.Vector3d
      */
     ceil() {
@@ -270,8 +234,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Ceil this vector values
-     * @name ceilSelf
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     ceilSelf() {
@@ -280,8 +242,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Negate the vector values
-     * @name negate
-     * @memberof Vector3d
      * @returns {Vector3d} new me.Vector3d
      */
     negate() {
@@ -290,8 +250,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Negate this vector values
-     * @name negateSelf
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     negateSelf() {
@@ -300,8 +258,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Copy the components of the given vector into this one
-     * @name copy
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -310,19 +266,9 @@ import pool from "./../system/pooling.js";
     }
 
     /**
-     * return true if the two vectors are the same
-     * @name equals
-     * @memberof Vector3d
-     * @method
-     * @param {Vector2d|Vector3d} v
-     * @returns {boolean}
-     */
-    /**
-     * return true if this vector is equal to the given values
-     * @name equals
-     * @memberof Vector3d
-     * @param {number} x
-     * @param {number} y
+     * return true if this vector is equal to the given values or vector
+     * @param {number|Vector2d|ObservableVector2d|Vector3d|ObservableVector3d} x
+     * @param {number} [y]
      * @param {number} [z]
      * @returns {boolean}
      */
@@ -349,8 +295,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * normalize this vector (scale the vector so that its magnitude is 1)
-     * @name normalize
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     normalize() {
@@ -360,8 +304,6 @@ import pool from "./../system/pooling.js";
     /**
      * change this vector to be perpendicular to what it was before.<br>
      * (Effectively rotates it 90 degrees in a clockwise direction around the z axis)
-     * @name perp
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     perp() {
@@ -370,8 +312,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Rotate this vector (counter-clockwise) by the specified angle (in radians) around the z axis
-     * @name rotate
-     * @memberof Vector3d
      * @param {number} angle - The angle to rotate (in radians)
      * @param {Vector2d|ObservableVector2d} [v] - an optional point to rotate around (on the same z axis)
      * @returns {Vector3d} Reference to this object for method chaining
@@ -397,8 +337,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return the dot product of this vector and the passed one
-     * @name dot
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {number} The dot product.
      */
@@ -408,8 +346,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * calculate the cross product of this vector and the passed one
-     * @name cross
-     * @memberof Vector3d
      * @param {Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -424,10 +360,8 @@ import pool from "./../system/pooling.js";
         return this;
     }
 
-   /**
+    /**
     * return the square length of this vector
-    * @name length2
-    * @memberof Vector3d
     * @returns {number} The length^2 of this vector.
     */
     length2() {
@@ -436,8 +370,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return the length (magnitude) of this vector
-     * @name length
-     * @memberof Vector3d
      * @returns {number} the length of this vector
      */
     length() {
@@ -446,8 +378,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Linearly interpolate between this vector and the given one.
-     * @name lerp
-     * @memberof Vector3d
      * @param {Vector3d} v
      * @param {number} alpha - distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
      * @returns {Vector3d} Reference to this object for method chaining
@@ -461,8 +391,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * interpolate the position of this vector on the x and y axis towards the given one by the given maximum step.
-     * @name moveTowards
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} target
      * @param {number} step - the maximum step per iteration (Negative values will push the vector away from the target)
      * @returns {Vector3d} Reference to this object for method chaining
@@ -487,8 +415,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return the distance between this vector and the passed one
-     * @name distance
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {number}
      */
@@ -501,8 +427,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return the angle between this vector and the passed one
-     * @name angle
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {number} angle in radians
      */
@@ -512,8 +436,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * project this vector on to another vector.
-     * @name project
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v - The vector to project onto.
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -525,8 +447,6 @@ import pool from "./../system/pooling.js";
     /**
      * Project this vector onto a vector of unit length.<br>
      * This is slightly more efficient than `project` when dealing with unit vectors.
-     * @name projectN
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v - The unit vector to project onto.
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -537,8 +457,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return a clone copy of this vector
-     * @name clone
-     * @memberof Vector3d
      * @returns {Vector3d} new me.Vector3d
      */
     clone() {
@@ -547,8 +465,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * convert the object to a string representation
-     * @name toString
-     * @memberof Vector3d
      * @returns {string}
      */
     toString() {

package/src/particles/emitter.js

@@ -21,7 +21,7 @@ function createDefaultParticleTexture(w = 8, h = 8) {
  * Particle Emitter Object.
  * @augments Container
  */
- export default class ParticleEmitter extends Container {
+export default class ParticleEmitter extends Container {
     /**
      * @param {number} x - x position of the particle emitter
      * @param {number} y - y position of the particle emitter

package/src/particles/particle.js

@@ -8,7 +8,7 @@ import Renderable from "./../renderable/renderable.js";
  * Single Particle Object.
  * @augments Renderable
  */
- export default class Particle extends Renderable {
+export default class Particle extends Renderable {
     /**
      * @param {ParticleEmitter} emitter - the particle emitter
      */

package/src/physics/body.js

@@ -14,7 +14,7 @@ import Point from "../geometries/point.js";
  * a Generic Physic Body Object with some physic properties and behavior functionality, to as a member of a Renderable.
  * @see Renderable.body
  */
- export default class Body {
+export default class Body {
     /**
      * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} ancestor - the parent object this body is attached to
      * @param {Rect|Rect[]|Polygon|Polygon[]|Line|Line[]|Ellipse|Ellipse[]|Point|Point[]|Bounds|Bounds[]|object} [shapes] - a initial shape, list of shapes, or JSON object defining the body
@@ -516,32 +516,34 @@ import Point from "../geometries/point.js";
 
     /**
      * Returns true if the any of the shape composing the body contains the given point.
-     * @method Body#contains
-     * @param {Vector2d} point
-     * @returns {boolean} true if contains
-     */
-    /**
-     * Returns true if the any of the shape composing the body contains the given point.
-     * @param  {number} x -  x coordinate
-     * @param  {number} y -  y coordinate
+     * @param {number|Vector2d} x -  x coordinate or a vector point to check
+     * @param {number} [y] -  y coordinate
      * @returns {boolean} true if contains
+     * @example
+     * if (mySprite.body.contains(10, 10)) {
+     *   // do something
+     * }
+     * // or
+     * if (mySprite.body.contains(myVector2d)) {
+     *   // do something
+     * }
      */
     contains() {
         let _x, _y;
 
         if (arguments.length === 2) {
-          // x, y
-          _x = arguments[0];
-          _y = arguments[1];
+            // x, y
+            _x = arguments[0];
+            _y = arguments[1];
         } else {
-          // vector
-          _x = arguments[0].x;
-          _y = arguments[0].y;
+            // vector
+            _x = arguments[0].x;
+            _y = arguments[0].y;
         }
 
         if (this.getBounds().contains(_x, _y)) {
-             // cannot use forEach here as cannot break out with a return
-             for (let i = this.shapes.length, shape; i--, (shape = this.shapes[i]);) {
+            // cannot use forEach here as cannot break out with a return
+            for (let i = this.shapes.length, shape; i--, (shape = this.shapes[i]);) {
                 if (shape.contains(_x, _y)) {
                     return true;
                 }
@@ -633,7 +635,7 @@ import Point from "../geometries/point.js";
 
             this.vel.x = (
                 (nx < 0) ? nx :
-                ( x > 0) ? x  : 0
+                    ( x > 0) ? x  : 0
             );
         }
         if (this.friction.y > 0) {
@@ -643,7 +645,7 @@ import Point from "../geometries/point.js";
 
             this.vel.y = (
                 (ny < 0) ? ny :
-                ( y > 0) ? y  : 0
+                    ( y > 0) ? y  : 0
             );
         }
 

package/src/physics/bounds.js

@@ -5,7 +5,7 @@ import Vector2d from "./../math/vector2.js";
  * @classdesc
  * a bound object contains methods for creating and manipulating axis-aligned bounding boxes (AABB).
  */
- export default class Bounds {
+export default class Bounds {
     /**
      * @param {Vector2d[]|Point[]} [vertices] - an array of Vector2d or Point
      */
@@ -254,17 +254,17 @@ import Vector2d from "./../math/vector2.js";
 
     /**
      * Returns true if the bounds contains the given point.
-     * @name contains
-     * @memberof Bounds
-     * @method
-     * @param {Vector2d} point
-     * @returns {boolean} True if the bounds contain the point, otherwise false
-     */
-    /**
-     * Returns true if the bounds contains the given point.
-     * @param {number} x
-     * @param {number} y
+     * @param {number|Vector2d} x -  x coordinate or a vector point to check
+     * @param {number} [y] - y coordinate
      * @returns {boolean} True if the bounds contain the point, otherwise false
+     * @example
+     * if (bounds.contains(10, 10)) {
+     *   // do something
+     * }
+     * // or
+     * if (bounds.contains(myVector2d)) {
+     *   // do something
+     * }
      */
     contains() {
         let arg0 = arguments[0];
@@ -274,8 +274,8 @@ import Vector2d from "./../math/vector2.js";
             _x1 = _x2 = arg0;
             _y1 = _y2 = arguments[1];
         } else {
-            if (arg0 instanceof Bounds) {
-                // bounds
+            if (typeof arg0.max !== "undefined") {
+                // only bounds define min and max properties
                 _x1 = arg0.min.x;
                 _x2 = arg0.max.x;
                 _y1 = arg0.min.y;
@@ -310,16 +310,13 @@ import Vector2d from "./../math/vector2.js";
     }
 
     /**
-     * Translates the bounds by the given vector.
-     * @name translate
-     * @memberof Bounds
-     * @method
-     * @param {Vector2d} vector
-     */
-    /**
-     * Translates the bounds by x on the x axis, and y on the y axis
-     * @param {number} x
-     * @param {number} y
+     * Translates the bounds by the given point
+     * @param {number|Vector2d} x -  x coordinate or a vector point to translate by
+     * @param {number} [y]
+     * @example
+     * bounds.translate(10, 10);
+     * // or
+     * bounds.translate(myVector2d);
      */
     translate() {
         let _x, _y;
@@ -338,17 +335,14 @@ import Vector2d from "./../math/vector2.js";
         this.max.y += _y;
     }
 
-    /**
-     * Shifts the bounds to the given position vector.
-     * @name shift
-     * @memberof Bounds
-     * @method
-     * @param {Vector2d} position
-     */
     /**
      * Shifts the bounds to the given x, y position.
-     * @param {number} x
-     * @param {number} y
+     * @param {number|Vector2d} x -  x coordinate or a vector point to shift to
+     * @param {number} [y]
+     * @example
+     * bounds.shift(10, 10);
+     * // or
+     * bounds.shift(myVector2d);
      */
     shift() {
         let _x, _y;

package/src/physics/collision.js

@@ -8,7 +8,7 @@ import { game } from "../index.js";
 
 let collision = {
 
-     /**
+    /**
       * The maximum number of children that a quadtree node can contain before it is split into sub-nodes.
       * @name maxChildren
       * @memberof collision
@@ -17,9 +17,9 @@ let collision = {
       * @default 8
       * @see game.world.broadphase
       */
-     maxChildren : 8,
+    maxChildren : 8,
 
-     /**
+    /**
       * The maximum number of levels that the quadtree will create.
       * @name maxDepth
       * @memberof collision
@@ -28,7 +28,7 @@ let collision = {
       * @default 4
       * @see game.world.broadphase
       */
-     maxDepth : 4,
+    maxDepth : 4,
 
     /**
      * Enum for collision type values.

package/src/physics/detector.js

@@ -62,7 +62,7 @@ export default class Detector {
      * detect collision between two bodies.
      * @param {Body} bodyA - a reference to body A.
      * @param {Body} bodyB - a reference to body B.
-     * @returns {Boolean} true if colliding
+     * @returns {boolean} true if colliding
      */
     collides(bodyA, bodyB, response = this.response) {
         // for each shape in body A
@@ -71,13 +71,13 @@ export default class Detector {
             for (let indexB = bodyB.shapes.length, shapeB; indexB--, (shapeB = bodyB.shapes[indexB]);) {
                 // full SAT collision check
                 if (SAT["test" + shapeA.shapeType + shapeB.shapeType].call(
-                        this,
-                        bodyA.ancestor, // a reference to the object A
-                        shapeA,
-                        bodyB.ancestor,  // a reference to the object B
-                        shapeB,
-                        // clear response object before reusing
-                        response.clear()) === true
+                    this,
+                    bodyA.ancestor, // a reference to the object A
+                    shapeA,
+                    bodyB.ancestor,  // a reference to the object B
+                    shapeB,
+                    // clear response object before reusing
+                    response.clear()) === true
                 ) {
 
                     // set the shape index
@@ -190,7 +190,7 @@ export default class Detector {
                             shapeA,
                             objB,  // a reference to the object B
                             shapeB
-                    )) {
+                        )) {
                         // we touched something !
                         result[collisionCounter] = objB;
                         collisionCounter++;

package/src/physics/quadtree.js

@@ -51,7 +51,7 @@ let QT_VECTOR = new Vector2d();
  * a QuadTree implementation in JavaScript, a 2d spatial subdivision algorithm.
  * @see game.world.broadphase
  */
- export default class QuadTree {
+export default class QuadTree {
     /**
      * @param {World} world - the physic world this QuadTree belongs to
      * @param {Bounds} bounds - bounds of the node
@@ -83,7 +83,7 @@ let QT_VECTOR = new Vector2d();
             left = this.bounds.left,
             top = this.bounds.top;
 
-         //top right node
+        //top right node
         this.nodes[0] = QT_ARRAY_POP(
             this.world,
             {
@@ -279,7 +279,7 @@ let QT_VECTOR = new Vector2d();
             if (index !== -1) {
                 returnObjects = returnObjects.concat(this.nodes[index].retrieve(item));
             } else {
-                 //if rect does not fit into a subnode, check it against all subnodes
+                //if rect does not fit into a subnode, check it against all subnodes
                 for (let i = 0; i < this.nodes.length; i = i + 1) {
                     returnObjects = returnObjects.concat(this.nodes[i].retrieve(item));
                 }
@@ -301,7 +301,7 @@ let QT_VECTOR = new Vector2d();
      * @param {object} item - object to be removed
      * @returns {boolean} true if the item was found and removed.
      */
-     remove(item) {
+    remove(item) {
         let found = false;
 
         if (typeof (item.getBounds) === "undefined") {

package/src/physics/sat.js

@@ -205,10 +205,9 @@ export function testPolygonPolygon(a, polyA, b, polyB, response) {
     // aboslute shape position
     let posA = T_VECTORS.pop().copy(a.pos).add(a.ancestor.getAbsolutePosition()).add(polyA.pos);
     let posB = T_VECTORS.pop().copy(b.pos).add(b.ancestor.getAbsolutePosition()).add(polyB.pos);
-    let i;
 
     // If any of the edge normals of A is a separating axis, no intersection.
-    for (i = 0; i < aLen; i++) {
+    for (let i = 0; i < aLen; i++) {
         if (isSeparatingAxis(posA, posB, aPoints, bPoints, aNormals[i], response)) {
             T_VECTORS.push(posA);
             T_VECTORS.push(posB);
@@ -217,7 +216,7 @@ export function testPolygonPolygon(a, polyA, b, polyB, response) {
     }
 
     // If any of the edge normals of B is a separating axis, no intersection.
-    for (i = 0; i < bLen; i++) {
+    for (let i = 0; i < bLen; i++) {
         if (isSeparatingAxis(posA, posB, aPoints, bPoints, bNormals[i], response)) {
             T_VECTORS.push(posA);
             T_VECTORS.push(posB);