melonjs 10.9.0 → 10.12.0

package/src/physics/body.js

@@ -13,6 +13,7 @@ import { world } from "./../game.js";
 /**
  * @classdesc
  * a Generic Physic Body Object with some physic properties and behavior functionality, to as a member of a Renderable.
+ * @see Renderable.body
  */
 class Body {
     /**
@@ -368,7 +369,6 @@ class Body {
 
     /**
      * returns the AABB bounding box for this body
-     * @function
      * @returns {Bounds} bounding box Rectangle object
      */
     getBounds() {
@@ -439,7 +439,7 @@ class Body {
 
     /**
      * the built-in function to solve the collision response
-     * @param {object} response the collision response object (see {@link collision.ResponseObject})
+     * @param {object} response the collision response object (see {@link ResponseObject})
      */
     respondToCollision(response) {
         // the overlap vector
@@ -510,6 +510,7 @@ class Body {
 
     /**
      * 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
      */
@@ -573,7 +574,6 @@ class Body {
      * cap the body velocity (body.maxVel property) to the specified value<br>
      * @param {number} x max velocity on x axis
      * @param {number} y max velocity on y axis
-     * @protected
      */
     setMaxVelocity(x, y) {
         this.maxVel.x = x;
@@ -584,7 +584,6 @@ class Body {
      * set the body default friction
      * @param {number} x horizontal friction
      * @param {number} y vertical friction
-     * @protected
      */
     setFriction(x = 0, y = 0) {
         this.friction.x = x;
@@ -692,7 +691,7 @@ class Body {
         pool.push(this.friction);
         pool.push(this.maxVel);
         this.shapes.forEach((shape) => {
-            pool.push(shape);
+            pool.push(shape, false);
         });
 
         // set to undefined

package/src/physics/bounds.js

@@ -34,7 +34,6 @@ class Bounds {
      * reset the bound
      * @name clear
      * @memberof Bounds
-     * @function
      */
     clear() {
         this.setMinMax(Infinity, Infinity, -Infinity, -Infinity);
@@ -45,7 +44,6 @@ class Bounds {
      * sets the bounds to the given min and max value
      * @name setMinMax
      * @memberof Bounds
-     * @function
      * @param {number} minX
      * @param {number} minY
      * @param {number} maxX
@@ -205,7 +203,6 @@ class Bounds {
      * Updates bounds using the given vertices
      * @name update
      * @memberof Bounds
-     * @function
      * @param {Vector2d[]} vertices an array of me.Vector2d points
      */
     update(vertices) {
@@ -216,7 +213,6 @@ class Bounds {
      * add the given vertices to the bounds definition.
      * @name add
      * @memberof Bounds
-     * @function
      * @param {Vector2d[]} vertices an array of me.Vector2d points
      * @param {boolean} [clear=false] either to reset the bounds before adding the new vertices
      */
@@ -237,7 +233,6 @@ class Bounds {
      * add the given bounds to the bounds definition.
      * @name addBounds
      * @memberof Bounds
-     * @function
      * @param {Bounds} bounds
      * @param {boolean} [clear=false] either to reset the bounds before adding the new vertices
      */
@@ -256,7 +251,6 @@ class Bounds {
      * add the given point to the bounds definition.
      * @name addPoint
      * @memberof Bounds
-     * @function
      * @param {Vector2d} v
      * @param {Matrix2d} [m] an optional transform to apply to the given point
      */
@@ -274,7 +268,6 @@ class Bounds {
      * add the given quad coordinates to this bound definition, multiplied by the given matrix
      * @name addFrame
      * @memberof Bounds
-     * @function
      * @param {number} x0 - left X coordinates of the quad
      * @param {number} y0 - top Y coordinates of the quad
      * @param {number} x1 - right X coordinates of the quad
@@ -282,7 +275,7 @@ class Bounds {
      * @param {Matrix2d} [m] an optional transform to apply to the given frame coordinates
      */
     addFrame(x0, y0, x1, y1, m) {
-        var v = me.pool.pull("Vector2d");
+        var v = pool.pull("Vector2d");
 
         // transform all points and add to the bound definition
         this.addPoint(v.set(x0, y0), m);
@@ -290,14 +283,14 @@ class Bounds {
         this.addPoint(v.set(x0, y1), m);
         this.addPoint(v.set(x1, y1), m);
 
-        me.pool.push(v);
+        pool.push(v);
     }
 
     /**
      * Returns true if the bounds contains the given point.
      * @name contains
      * @memberof Bounds
-     * @function
+     * @method
      * @param {Vector2d} point
      * @returns {boolean} True if the bounds contain the point, otherwise false
      */
@@ -305,7 +298,6 @@ class Bounds {
      * Returns true if the bounds contains the given point.
      * @name contains
      * @memberof Bounds
-     * @function
      * @param {number} x
      * @param {number} y
      * @returns {boolean} True if the bounds contain the point, otherwise false
@@ -339,7 +331,6 @@ class Bounds {
      * Returns true if the two bounds intersect.
      * @name overlaps
      * @memberof Bounds
-     * @function
      * @param {Bounds|Rect} bounds
      * @returns {boolean} True if the bounds overlap, otherwise false
      */
@@ -352,7 +343,6 @@ class Bounds {
      * determines whether all coordinates of this bounds are finite numbers.
      * @name isFinite
      * @memberof Bounds
-     * @function
      * @returns {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
      */
     isFinite() {
@@ -363,14 +353,13 @@ class Bounds {
      * Translates the bounds by the given vector.
      * @name translate
      * @memberof Bounds
-     * @function
+     * @method
      * @param {Vector2d} vector
      */
     /**
      * Translates the bounds by x on the x axis, and y on the y axis
      * @name translate
      * @memberof Bounds
-     * @function
      * @param {number} x
      * @param {number} y
      */
@@ -395,14 +384,13 @@ class Bounds {
      * Shifts the bounds to the given position vector.
      * @name shift
      * @memberof Bounds
-     * @function
+     * @method
      * @param {Vector2d} position
      */
     /**
      * Shifts the bounds to the given x, y position.
      * @name shift
      * @memberof Bounds
-     * @function
      * @param {number} x
      * @param {number} y
      */
@@ -432,7 +420,6 @@ class Bounds {
      * clone this bounds
      * @name clone
      * @memberof Bounds
-     * @function
      * @returns {Bounds}
      */
     clone() {
@@ -445,7 +432,6 @@ class Bounds {
      * Returns a polygon whose edges are the same as this bounds.
      * @name toPolygon
      * @memberof Bounds
-     * @function
      * @returns {Polygon} a new Polygon that represents this bounds.
      */
     toPolygon () {

package/src/physics/collision.js

@@ -1,4 +1,4 @@
-import { rayCast, globalResponse } from "./detector.js";
+import { rayCast } from "./detector.js";
 
 /**
  * Collision detection (and projection-based collision response) of 2D shapes.<br>
@@ -91,23 +91,11 @@ var collision = {
         ALL_OBJECT          : 0xFFFFFFFF // all objects
     },
 
-
-    /**
-     * a global instance of a response object used for collision detection <br>
-     * this object will be reused amongst collision detection call if not user-defined response is specified
-     * @name response
-     * @memberof collision
-     * @public
-     * @type {collision.ResponseObject}
-     */
-    response : globalResponse,
-
     /**
      * Checks for object colliding with the given line
      * @name rayCast
      * @memberof collision
      * @public
-     * @function
      * @param {Line} line line to be tested for collision
      * @param {Array.<Renderable>} [result] a user defined array that will be populated with intersecting physic objects.
      * @returns {Array.<Renderable>} an array of intersecting physic objects

package/src/physics/detector.js

@@ -1,9 +1,10 @@
 import * as SAT from "./sat.js";
+import ResponseObject from "./response.js";
 import Vector2d from "./../math/vector2.js";
 import { world } from "./../game.js";
 
 // a dummy object when using Line for raycasting
-var dummyObj = {
+let dummyObj = {
     pos : new Vector2d(0, 0),
     ancestor : {
         _absPos : new Vector2d(0, 0),
@@ -13,13 +14,15 @@ var dummyObj = {
     }
 };
 
+// the global response object used for collisions
+let globalResponse = new ResponseObject();
+
 /**
  * a function used to determine if two objects should collide (based on both respective objects collision mask and type).<br>
  * you can redefine this function if you need any specific rules over what should collide with what.
  * @name shouldCollide
  * @memberof collision
  * @ignore
- * @function
  * @param {Renderable} a a reference to the object A.
  * @param {Renderable} b a reference to the object B.
  * @returns {boolean} true if they should collide, false otherwise
@@ -34,66 +37,14 @@ function shouldCollide(a, b) {
     );
 };
 
-/**
- * @classdesc
- * An object representing the result of an intersection.
- * @property {Renderable} a The first object participating in the intersection
- * @property {Renderable} b The second object participating in the intersection
- * @property {number} overlap Magnitude of the overlap on the shortest colliding axis
- * @property {Vector2d} overlapV The overlap vector (i.e. `overlapN.scale(overlap, overlap)`). If this vector is subtracted from the position of a, a and b will no longer be colliding
- * @property {Vector2d} overlapN The shortest colliding axis (unit-vector)
- * @property {boolean} aInB Whether the first object is entirely inside the second
- * @property {boolean} bInA Whether the second object is entirely inside the first
- * @property {number} indexShapeA The index of the colliding shape for the object a body
- * @property {number} indexShapeB The index of the colliding shape for the object b body
- * @name ResponseObject
- * @memberof collision
- * @public
- */
-class ResponseObject {
-    constructor() {
-        this.a = null;
-        this.b = null;
-        this.overlapN = new Vector2d();
-        this.overlapV = new Vector2d();
-        this.aInB = true;
-        this.bInA = true;
-        this.indexShapeA = -1;
-        this.indexShapeB = -1;
-        this.overlap = Number.MAX_VALUE;
-    }
-
-    /**
-     * Set some values of the response back to their defaults. <br>
-     * Call this between tests if you are going to reuse a single <br>
-     * Response object for multiple intersection tests <br>
-     * (recommended as it will avoid allocating extra memory) <br>
-     * @name clear
-     * @memberof collision.ResponseObject
-     * @public
-     * @function
-     * @returns {object} this object for chaining
-     */
-    clear () {
-        this.aInB = true;
-        this.bInA = true;
-        this.overlap = Number.MAX_VALUE;
-        this.indexShapeA = -1;
-        this.indexShapeB = -1;
-        return this;
-    }
-}
 
-// @ignore
-export var globalResponse = new ResponseObject();
 
 /**
  * find all the collisions for the specified object
  * @name collisionCheck
  * @ignore
- * @function
  * @param {Renderable} objA object to be tested for collision
- * @param {collision.ResponseObject} [response=collision.response] a user defined response object that will be populated if they intersect.
+ * @param {ResponseObject} [response] a user defined response object that will be populated if they intersect.
  * @returns {boolean} in case of collision, false otherwise
  */
 export function collisionCheck(objA, response = globalResponse) {
@@ -163,7 +114,6 @@ export function collisionCheck(objA, response = globalResponse) {
  * Checks for object colliding with the given line
  * @name rayCast
  * @ignore
- * @function
  * @param {Line} line line to be tested for collision
  * @param {Array.<Renderable>} [result] a user defined array that will be populated with intersecting physic objects.
  * @returns {Array.<Renderable>} an array of intersecting physic objects

package/src/physics/quadtree.js

@@ -165,7 +165,6 @@ class QuadTree {
      * Insert the given object container into the node.
      * @name insertContainer
      * @memberof QuadTree
-     * @function
      * @param {Container} container group of objects to be added
      */
     insertContainer(container) {
@@ -194,7 +193,6 @@ class QuadTree {
      * objects to their corresponding subnodes.
      * @name insert
      * @memberof QuadTree
-     * @function
      * @param {object} item object to be added
      */
     insert(item) {
@@ -239,7 +237,6 @@ class QuadTree {
      * Return all objects that could collide with the given object
      * @name retrieve
      * @memberof QuadTree
-     * @function
      * @param {object} item object to be checked against
      * @param {object} [fn] a sorting function for the returned array
      * @returns {object[]} array with all detected objects
@@ -275,7 +272,6 @@ class QuadTree {
      * (this function won't recalculate the impacted node)
      * @name remove
      * @memberof QuadTree
-     * @function
      * @param {object} item object to be removed
      * @returns {boolean} true if the item was found and removed.
      */
@@ -316,7 +312,6 @@ class QuadTree {
      * return true if the node is prunable
      * @name isPrunable
      * @memberof QuadTree
-     * @function
      * @returns {boolean} true if the node is prunable
      */
     isPrunable() {
@@ -327,7 +322,6 @@ class QuadTree {
      * return true if the node has any children
      * @name hasChildren
      * @memberof QuadTree
-     * @function
      * @returns {boolean} true if the node has any children
      */
     hasChildren() {
@@ -344,7 +338,6 @@ class QuadTree {
      * clear the quadtree
      * @name clear
      * @memberof QuadTree
-     * @function
      * @param {Bounds} [bounds=this.bounds] the bounds to be cleared
      */
     clear(bounds) {

package/src/physics/response.js

@@ -0,0 +1,48 @@
+import Vector2d from "./../math/vector2.js";
+
+/**
+ * @classdesc
+ * An object representing the result of an intersection.
+ * @property {Renderable} a The first object participating in the intersection
+ * @property {Renderable} b The second object participating in the intersection
+ * @property {number} overlap Magnitude of the overlap on the shortest colliding axis
+ * @property {Vector2d} overlapV The overlap vector (i.e. `overlapN.scale(overlap, overlap)`). If this vector is subtracted from the position of a, a and b will no longer be colliding
+ * @property {Vector2d} overlapN The shortest colliding axis (unit-vector)
+ * @property {boolean} aInB Whether the first object is entirely inside the second
+ * @property {boolean} bInA Whether the second object is entirely inside the first
+ * @property {number} indexShapeA The index of the colliding shape for the object a body
+ * @property {number} indexShapeB The index of the colliding shape for the object b body
+ * @name ResponseObject
+ * @public
+ */
+export default class ResponseObject {
+    constructor() {
+        this.a = null;
+        this.b = null;
+        this.overlapN = new Vector2d();
+        this.overlapV = new Vector2d();
+        this.aInB = true;
+        this.bInA = true;
+        this.indexShapeA = -1;
+        this.indexShapeB = -1;
+        this.overlap = Number.MAX_VALUE;
+    }
+
+    /**
+     * Set some values of the response back to their defaults. <br>
+     * Call this between tests if you are going to reuse a single <br>
+     * Response object for multiple intersection tests <br>
+     * (recommended as it will avoid allocating extra memory) <br>
+     * @name clear
+     * @public
+     * @returns {object} this object for chaining
+     */
+    clear () {
+        this.aInB = true;
+        this.bInA = true;
+        this.overlap = Number.MAX_VALUE;
+        this.indexShapeA = -1;
+        this.indexShapeB = -1;
+        return this;
+    }
+}

package/src/physics/sat.js

@@ -9,19 +9,19 @@ import Vector2d from "./../math/vector2.js";
  * Constants for Vornoi regions
  * @ignore
  */
-var LEFT_VORNOI_REGION = -1;
+const LEFT_VORNOI_REGION = -1;
 
 /**
  * Constants for Vornoi regions
  * @ignore
  */
-var MIDDLE_VORNOI_REGION = 0;
+const MIDDLE_VORNOI_REGION = 0;
 
 /**
  * Constants for Vornoi regions
  * @ignore
  */
-var RIGHT_VORNOI_REGION = 1;
+const RIGHT_VORNOI_REGION = 1;
 
 
 /**
@@ -458,7 +458,7 @@ export function testPolygonEllipse(a, polyA, b, ellipseB, response) {
  */
 export function testEllipsePolygon(a, ellipseA, b, polyB, response) {
     // Test the polygon against the circle.
-    var result = this.testPolygonEllipse(b, polyB, a, ellipseA, response);
+    var result = testPolygonEllipse(b, polyB, a, ellipseA, response);
     if (result && response) {
         // Swap A and B in the response.
         var resa = response.a;

package/src/physics/world.js

@@ -96,7 +96,6 @@ class World extends Container {
      * reset the game world
      * @name reset
      * @memberof World
-     * @function
      */
     reset() {
         // clear the quadtree
@@ -118,7 +117,6 @@ class World extends Container {
      * @name addBody
      * @memberof World
      * @see Container.addChild
-     * @function
      * @param {Body} body
      * @returns {World} this game world
      */
@@ -133,7 +131,6 @@ class World extends Container {
      * @name removeBody
      * @memberof World
      * @see Container.removeChild
-     * @function
      * @param {Body} body
      * @returns {World} this game world
      */
@@ -147,7 +144,6 @@ class World extends Container {
      * update the game world
      * @name reset
      * @memberof World
-     * @function
      * @param {number} dt the time passed since the last frame update
      * @returns {boolean} true if the word is dirty
      */

package/src/plugin/plugin.js

@@ -44,7 +44,6 @@ export var plugin = {
      * @name patch
      * @memberof plugin
      * @public
-     * @function
      * @param {object} proto target object
      * @param {string} name target function
      * @param {Function} fn replacement function
@@ -90,7 +89,6 @@ export var plugin = {
      * @memberof plugin
      * @see Base
      * @public
-     * @function
      * @param {plugin.Base} pluginObj Plugin object to instantiate and register
      * @param {string} name
      * @param {object} [...arguments] all extra parameters will be passed to the plugin constructor

package/src/polyfill/roundrect.js

@@ -218,8 +218,10 @@
     }
   }
 
-  if (typeof Path2D.prototype.roundRect === "undefined") {
-      Path2D.prototype.roundRect = roundRect;
+  if (globalThis.CanvasRenderingContext2D) {
+    if (typeof globalThis.Path2D.prototype.roundRect === "undefined") {
+        globalThis.Path2D.prototype.roundRect = roundRect;
+    }
   }
   if (globalThis.CanvasRenderingContext2D) {
     if (typeof globalThis.CanvasRenderingContext2D.prototype.roundRect === "undefined") {

package/src/renderable/GUI.js

@@ -116,13 +116,12 @@ class GUI_Object extends Sprite {
     /**
      * function called when the object is pressed (to be extended)
      * @name onClick
-     * @memberof GUI_Object.prototype
+     * @memberof GUI_Object
      * @public
-     * @function
      * @param {Pointer} event the event object
      * @returns {boolean} return false if we need to stop propagating the event
      */
-    onClick(/* event */) {
+    onClick(event) { // eslint-disable-line no-unused-vars
         return false;
     }
 
@@ -139,12 +138,13 @@ class GUI_Object extends Sprite {
     /**
      * function called when the pointer is over the object
      * @name onOver
-     * @memberof GUI_Object.prototype
+     * @memberof GUI_Object
      * @public
-     * @function
      * @param {Pointer} event the event object
      */
-    onOver(/* event */) {}
+    onOver(event) { // eslint-disable-line no-unused-vars
+        // to be extended
+    }
 
     /**
      * function callback for the pointerLeave event
@@ -160,13 +160,12 @@ class GUI_Object extends Sprite {
     /**
      * function called when the pointer is leaving the object area
      * @name onOut
-     * @memberof GUI_Object.prototype
+     * @memberof GUI_Object
      * @public
-     * @function
      * @param {Pointer} event the event object
      */
-    onOut(/* event */) {
-
+    onOut(event) { // eslint-disable-line no-unused-vars
+        // to be extended
     }
 
     /**
@@ -185,9 +184,8 @@ class GUI_Object extends Sprite {
     /**
      * function called when the object is pressed and released (to be extended)
      * @name onRelease
-     * @memberof GUI_Object.prototype
+     * @memberof GUI_Object
      * @public
-     * @function
      * @returns {boolean} return false if we need to stop propagating the event
      */
     onRelease() {
@@ -210,9 +208,8 @@ class GUI_Object extends Sprite {
      * function called when the object is pressed and held<br>
      * to be extended <br>
      * @name onHold
-     * @memberof GUI_Object.prototype
+     * @memberof GUI_Object
      * @public
-     * @function
      */
     onHold() {}
 

package/src/renderable/collectable.js

@@ -1,6 +1,7 @@
 import Sprite from "./sprite.js";
 import Body from "./../physics/body.js";
 import collision from "./../physics/collision.js";
+import pool from "./../system/pooling.js";
 
 /**
  * @classdesc

package/src/renderable/colorlayer.js

@@ -1,5 +1,4 @@
 import pool from "./../system/pooling.js";
-import { viewport } from "./../game.js";
 import Renderable from "./renderable.js";
 
 
@@ -41,15 +40,18 @@ class ColorLayer extends Renderable {
     }
 
     /**
-     * draw the color layer
-     * @ignore
+     * draw this color layer (automatically called by melonJS)
+     * @name draw
+     * @memberof ColorLayer
+     * @protected
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer instance
+     * @param {Camera2d} [viewport] the viewport to (re)draw
      */
-    draw(renderer, rect) {
-        var vpos = viewport.pos;
+    draw(renderer, viewport) {
         renderer.save();
         renderer.clipRect(
-            rect.left - vpos.x, rect.top - vpos.y,
-            rect.width, rect.height
+            0, 0,
+            viewport.width, viewport.height
         );
         renderer.clearColor(this.color);
         renderer.restore();