melonjs 10.11.0 → 10.12.0

package/dist/melonjs.module.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v10.11.0
+ * melonJS Game Engine - v10.12.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -309,10 +309,10 @@ var store$2 = sharedStore;
 (shared$3.exports = function (key, value) {
   return store$2[key] || (store$2[key] = value !== undefined ? value : {});
 })('versions', []).push({
-  version: '3.23.0',
+  version: '3.23.1',
   mode: 'global',
   copyright: '© 2014-2022 Denis Pushkarev (zloirock.ru)',
-  license: 'https://github.com/zloirock/core-js/blob/v3.23.0/LICENSE',
+  license: 'https://github.com/zloirock/core-js/blob/v3.23.1/LICENSE',
   source: 'https://github.com/zloirock/core-js'
 });
 
@@ -1737,7 +1737,7 @@ class ObjectPool {
         return (typeof className !== "undefined") &&
                 (typeof obj.onResetEvent === "function") &&
                 (className in this.objectClass) &&
-                (this.objectClass[className].pool !== "undefined");
+                (typeof this.objectClass[className].pool !== "undefined");
 
     }
 
@@ -10291,10 +10291,9 @@ earcut.flatten = function (data) {
  * (which means that all angles are less than 180 degrees), as described here below : <br>
  * <center><img src="images/convex_polygon.png"/></center><br>
  *
- * A polygon's `winding` is clockwise iff its vertices (points) are declared turning to the right. The image above shows COUNTERCLOCKWISE winding.
+ * A polygon's `winding` is clockwise if its vertices (points) are declared turning to the right. The image above shows COUNTERCLOCKWISE winding.
  */
 class Polygon {
-
     /**
      * @param {number} x origin point of the Polygon
      * @param {number} y origin point of the Polygon
@@ -10944,7 +10943,7 @@ class Rect extends Polygon {
      * @name centerOn
      * @memberof Rect
      * @param {number} x the x coordinate around which to center this rectangle
-     * @param {number} x the y coordinate around which to center this rectangle
+     * @param {number} y the y coordinate around which to center this rectangle
      * @returns {Rect} this rectangle
      */
     centerOn(x, y) {
@@ -14456,14 +14455,14 @@ class Renderable extends Rect {
     }
 
     /**
-     * object draw. <br>
-     * automatically called by the game manager {@link game}
+     * draw this renderable (automatically called by melonJS)
      * @name draw
      * @memberof Renderable
      * @protected
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer instance
+     * @param {Camera2d} [viewport] the viewport to (re)draw
      */
-    draw(renderer) {  // eslint-disable-line no-unused-vars
+    draw(renderer, viewport) {  // eslint-disable-line no-unused-vars
         // empty one !
     }
 
@@ -14496,7 +14495,7 @@ class Renderable extends Rect {
      * when this renderable body is colliding with another one
      * @name onCollision
      * @memberof Renderable
-     * @param {collision.ResponseObject} response the collision response object
+     * @param {ResponseObject} response the collision response object
      * @param {Renderable} other the other renderable touching this one (a reference to response.a or response.b)
      * @returns {boolean} true if the object should respond to the collision (its position and velocity will be corrected)
      * @example
@@ -14513,7 +14512,7 @@ class Renderable extends Rect {
      *     return true;
      * },
      */
-    onCollision() {
+    onCollision(response, other) { // eslint-disable-line no-unused-vars
         return false;
     }
 
@@ -14733,7 +14732,7 @@ class Ellipse {
      * @param {Matrix2d} matrix the transformation matrix
      * @returns {Polygon} Reference to this object for method chaining
      */
-    transform(/* m */) {
+    transform(matrix) { // eslint-disable-line no-unused-vars
         // TODO
         return this;
     }
@@ -15301,7 +15300,7 @@ function testPolygonEllipse(a, polyA, b, ellipseB, response) {
  */
 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;
@@ -15324,36 +15323,6 @@ var SAT = /*#__PURE__*/Object.freeze({
 	testEllipsePolygon: testEllipsePolygon
 });
 
-// a dummy object when using Line for raycasting
-var dummyObj = {
-    pos : new Vector2d(0, 0),
-    ancestor : {
-        _absPos : new Vector2d(0, 0),
-        getAbsolutePosition : function () {
-            return this._absPos;
-        }
-    }
-};
-
-/**
- * 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
- * @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
- */
-function shouldCollide(a, b) {
-    return (
-        a.isKinematic !== true && b.isKinematic !== true &&
-        typeof a.body === "object" && typeof b.body === "object" &&
-        !(a.body.isStatic === true && b.body.isStatic === true) &&
-        (a.body.collisionMask & b.body.collisionType) !== 0 &&
-        (a.body.collisionType & b.body.collisionMask) !== 0
-    );
-}
 /**
  * @classdesc
  * An object representing the result of an intersection.
@@ -15367,7 +15336,6 @@ function shouldCollide(a, b) {
  * @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 {
@@ -15389,7 +15357,6 @@ class ResponseObject {
      * Response object for multiple intersection tests <br>
      * (recommended as it will avoid allocating extra memory) <br>
      * @name clear
-     * @memberof collision.ResponseObject
      * @public
      * @returns {object} this object for chaining
      */
@@ -15403,15 +15370,47 @@ class ResponseObject {
     }
 }
 
-// @ignore
-var globalResponse = new ResponseObject();
+// a dummy object when using Line for raycasting
+let dummyObj = {
+    pos : new Vector2d(0, 0),
+    ancestor : {
+        _absPos : new Vector2d(0, 0),
+        getAbsolutePosition : function () {
+            return this._absPos;
+        }
+    }
+};
+
+// 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
+ * @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
+ */
+function shouldCollide(a, b) {
+    return (
+        a.isKinematic !== true && b.isKinematic !== true &&
+        typeof a.body === "object" && typeof b.body === "object" &&
+        !(a.body.isStatic === true && b.body.isStatic === true) &&
+        (a.body.collisionMask & b.body.collisionType) !== 0 &&
+        (a.body.collisionType & b.body.collisionMask) !== 0
+    );
+}
+
 
 /**
  * find all the collisions for the specified object
  * @name collisionCheck
  * @ignore
  * @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
  */
 function collisionCheck(objA, response = globalResponse) {
@@ -15641,17 +15640,6 @@ 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
@@ -15684,6 +15672,7 @@ var collision = {
 /**
  * @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 {
     /**
@@ -16109,7 +16098,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
@@ -16243,7 +16232,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;
@@ -16254,7 +16242,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;
@@ -16362,7 +16349,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
@@ -16476,7 +16463,7 @@ class Container extends Renderable {
          * @memberof Container#
          * @param {number} index added or removed child index
          */
-        this.onChildChange = function (/* index */) {
+        this.onChildChange = function (index) {   // eslint-disable-line no-unused-vars
             // to be extended
         };
 
@@ -16560,8 +16547,10 @@ class Container extends Renderable {
      * Adding a child to the container will automatically remove it from its other container.
      * Meaning a child can only have one parent.  This is important if you add a renderable
      * to a container then add it to the me.game.world container it will move it out of the
-     * orginal container.  Then when the me.game.world.reset() is called the renderable
-     * will not be in any container.
+     * orginal container. Then when the me.game.world.reset() is called the renderable
+     * will not be in any container. <br>
+     * if the given child implements a onActivateEvent method, that method will be called
+     * once the child is added to this container.
      * @name addChild
      * @memberof Container
      * @param {Renderable} child
@@ -17003,7 +16992,8 @@ class Container extends Renderable {
     }
 
     /**
-     * Invokes the removeChildNow in a defer, to ensure the child is removed safely after the update & draw stack has completed
+     * Invokes the removeChildNow in a defer, to ensure the child is removed safely after the update & draw stack has completed. <br>
+     * if the given child implements a onDeactivateEvent() method, that method will be called once the child is removed from this container.
      * @name removeChild
      * @memberof Container
      * @public
@@ -17305,15 +17295,14 @@ class Container extends Renderable {
     }
 
     /**
-     * draw the container. <br>
-     * automatically called by the game manager {@link game}
+      * draw this renderable (automatically called by melonJS)
      * @name draw
      * @memberof Container
      * @protected
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
-     * @param {Rect|Bounds} [rect] the area or viewport to (re)draw
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer instance
+     * @param {Camera2d} [viewport] the viewport to (re)draw
      */
-    draw(renderer, rect) {
+    draw(renderer, viewport) {
         var isFloating = false;
         var bounds = this.getBounds();
 
@@ -17355,7 +17344,7 @@ class Container extends Renderable {
                     obj.preDraw(renderer);
 
                     // draw the object
-                    obj.draw(renderer, rect);
+                    obj.draw(renderer, viewport);
 
                     // postdraw (clean-up);
                     obj.postDraw(renderer);
@@ -19684,6 +19673,24 @@ var state = {
         }
     },
 
+    /**
+     * returns the stage associated with the specified state
+     * (or the current one if none is specified)
+     * @name set
+     * @memberof state
+     * @public
+     * @param {number} [state] State ID (see constants)
+     * @returns {Stage}
+     */
+    get(state = _state) {
+        if (typeof _stages[state] !== "undefined") {
+            return _stages[state].stage;
+        } else {
+            return undefined;
+        }
+
+    },
+
     /**
      * return a reference to the current stage<br>
      * useful to call a object specific method
@@ -19693,9 +19700,7 @@ var state = {
      * @returns {Stage}
      */
     current() {
-        if (typeof _stages[_state] !== "undefined") {
-            return _stages[_state].stage;
-        }
+        return this.get();
     },
 
     /**
@@ -21094,6 +21099,8 @@ class TextureAtlas {
      * add uvs mapping for the given region
      * @param {object} atlas the atlas dictionnary where the region is define
      * @param {object} name region (or frame) name
+     * @param {number} w the width of the region
+     * @param {number} h the height of the region
      * @returns {Float32Array} the created region UVs
      */
     addUVs(atlas, name, w, h) {
@@ -21801,14 +21808,14 @@ class Sprite extends Renderable {
     }
 
     /**
-     * sprite draw. <br>
-     * automatically called by the game manager {@link game}
+     * draw this srite (automatically called by melonJS)
      * @name draw
      * @memberof Sprite
      * @protected
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer instance
+     * @param {Camera2d} [viewport] the viewport to (re)draw
      */
-    draw(renderer) {
+    draw(renderer, viewport) {   // eslint-disable-line no-unused-vars
         // do nothing if we are flickering
         if (this._flicker.isFlickering) {
             this._flicker.state = !this._flicker.state;
@@ -22456,10 +22463,10 @@ class Path2D {
      * adds a circular arc to the path with the given control points and radius, connected to the previous point by a straight line.
      * @name arcTo
      * @memberof Path2D
-     * @param {number} x the x-axis coordinate of the first control point.
-     * @param {number} y the y-axis coordinate of the first control point.
-     * @param {number} x the x-axis coordinate of the second control point.
-     * @param {number} y the y-axis coordinate of the second control point.
+     * @param {number} x1 the x-axis coordinate of the first control point.
+     * @param {number} y1 the y-axis coordinate of the first control point.
+     * @param {number} x2 the x-axis coordinate of the second control point.
+     * @param {number} y2 the y-axis coordinate of the second control point.
      * @param {number} radius the arc's radius. Must be positive.
      */
     arcTo(x1, y1, x2, y2, radius) {
@@ -32793,10 +32800,10 @@ class BasePlugin {
          * this can be overridden by the plugin
          * @public
          * @type {string}
-         * @default "10.11.0"
+         * @default "10.12.0"
          * @name plugin.Base#version
          */
-        this.version = "10.11.0";
+        this.version = "10.12.0";
     }
 }
 
@@ -34089,11 +34096,14 @@ const runits = ["ex", "em", "pt", "px"];
 const toPX = [12, 24, 0.75, 1];
 
 // return a valid 2d context for Text rendering/styling
-var getContext2d = function (renderer, text) {
+var getContext2d = function (renderer$1, text) {
     if (text.offScreenCanvas === true) {
         return text.canvasTexture.context;
     } else {
-        return renderer.getFontContext();
+        if (typeof renderer$1 === "undefined") {
+            renderer$1 = renderer;
+        }
+        return renderer$1.getFontContext();
     }
 };
 
@@ -34401,12 +34411,12 @@ class Text extends Renderable {
 
     /**
      * measure the given text size in pixels
-     * @param {CanvasRenderer|WebGLRenderer} [renderer] reference to the active renderer
+     * @param {CanvasRenderer|WebGLRenderer} renderer reference to the active renderer
      * @param {string} [text] the text to be measured
      * @returns {TextMetrics} a TextMetrics object defining the dimensions of the given piece of text
      */
-    measureText(renderer$1 = renderer, text = this._text) {
-        return this.metrics.measureText(text, getContext2d(renderer$1, this));
+    measureText(renderer, text = this._text) {
+        return this.metrics.measureText(text, getContext2d(renderer, this));
     }
 
 
@@ -34418,7 +34428,7 @@ class Text extends Renderable {
      * @param {number} [y]
      * @param {boolean} [stroke=false] draw stroke the the text if true
      */
-    draw(renderer, text, x, y, stroke) {
+    draw(renderer, text, x = this.pos.x, y = this.pos.y, stroke = false) {
         // "hacky patch" for backward compatibilty
         if (typeof this.ancestor === "undefined") {
 
@@ -35134,15 +35144,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();
@@ -35318,7 +35331,7 @@ class ImageLayer extends Sprite {
      * @param {number} h new height
      */
     resize(w, h) {
-        super.resize(
+        return super.resize(
             this.repeatX ? Infinity : w,
             this.repeatY ? Infinity : h
         );
@@ -35397,14 +35410,14 @@ class ImageLayer extends Sprite {
     }
 
     /**
-     * draw the ImageLayer. <br>
-     * automatically called by the game manager {@link game}
+     * draw this ImageLayer (automatically called by melonJS)
      * @name draw
      * @memberof ImageLayer
      * @protected
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer instance
+     * @param {Camera2d} [viewport] the viewport to (re)draw
      */
-    draw(renderer) {
+    draw(renderer, viewport) {
         var width = this.width,
             height = this.height,
             bw = viewport.bounds.width,
@@ -35778,7 +35791,7 @@ class GUI_Object extends Sprite {
      * @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;
     }
 
@@ -35799,7 +35812,9 @@ class GUI_Object extends Sprite {
      * @public
      * @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
@@ -35819,8 +35834,8 @@ class GUI_Object extends Sprite {
      * @public
      * @param {Pointer} event the event object
      */
-    onOut(/* event */) {
-
+    onOut(event) { // eslint-disable-line no-unused-vars
+        // to be extended
     }
 
     /**
@@ -36067,8 +36082,15 @@ class Trigger extends Renderable {
         }
     }
 
-    /** @ignore */
-    onCollision() {
+    /**
+     * onCollision callback, triggered in case of collision with this trigger
+     * @name onCollision
+     * @memberof Trigger
+     * @param {ResponseObject} response the collision response object
+     * @param {Renderable} other the other renderable touching this one (a reference to response.a or response.b)
+     * @returns {boolean} true if the object should respond to the collision (its position and velocity will be corrected)
+     */
+    onCollision(response, other) { // eslint-disable-line no-unused-vars
         if (this.name === "Trigger") {
             this.triggerEvent.apply(this);
         }
@@ -36166,10 +36188,14 @@ class Light2d extends Renderable {
     }
 
     /**
-     * object draw (Called internally by the engine).
-     * @ignore
+     * draw this Light2d (automatically called by melonJS)
+     * @name draw
+     * @memberof Light2d
+     * @protected
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer instance
+     * @param {Camera2d} [viewport] the viewport to (re)draw
      */
-    draw(renderer) {
+    draw(renderer, viewport) {   // eslint-disable-line no-unused-vars
         renderer.drawImage(this.texture.canvas, this.getBounds().x, this.getBounds().y);
     }
 
@@ -36382,7 +36408,7 @@ class DropTarget extends Renderable {
      * @memberof DropTarget
      * @param {Draggable} draggable the draggable object that is dropped
      */
-    drop() {
+    drop(draggable) {  // eslint-disable-line no-unused-vars
 
     }
 
@@ -37315,23 +37341,21 @@ class Entity extends Renderable {
     }
 
     /**
-     * object draw<br>
-     * not to be called by the end user<br>
-     * called by the game manager on each game loop
+     * draw this entity (automatically called by melonJS)
      * @name draw
      * @memberof Entity
      * @protected
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
-     * @param {Rect} rect region to draw
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer instance
+     * @param {Camera2d} [viewport] the viewport to (re)draw
      */
-    draw(renderer, rect) {
+    draw(renderer, viewport) {
         var renderable = this.renderable;
         if (renderable instanceof Renderable) {
             // predraw (apply transforms)
             renderable.preDraw(renderer);
 
             // draw the object
-            renderable.draw(renderer, rect);
+            renderable.draw(renderer, viewport);
 
             // postdraw (clean-up);
             renderable.postDraw(renderer);
@@ -37502,7 +37526,7 @@ class DroptargetEntity extends DropTarget {
  * @name version
  * @type {string}
  */
-const version = "10.11.0";
+const version = "10.12.0";
 
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "melonjs",
-  "version": "10.11.0",
+  "version": "10.12.0",
   "description": "melonJS Game Engine",
   "homepage": "http://www.melonjs.org/",
   "keywords": [
@@ -55,13 +55,13 @@
   ],
   "dependencies": {
     "@teppeis/multimaps": "^2.0.0",
-    "core-js": "^3.23.0",
+    "core-js": "^3.23.1",
     "earcut": "2.2.3",
     "eventemitter3": "^4.0.7",
     "howler": "2.2.3"
   },
   "devDependencies": {
-    "@melonjs/webdoc-theme": "^1.1.0",
+    "@melonjs/webdoc-theme": "^1.1.1",
     "@rollup/plugin-buble": "^0.21.3",
     "@rollup/plugin-commonjs": "^22.0.0",
     "@rollup/plugin-node-resolve": "^13.3.0",
@@ -69,19 +69,19 @@
     "@types/offscreencanvas": "^2019.7.0",
     "@webdoc/cli": "^1.6.6",
     "del-cli": "^4.0.1",
-    "eslint": "^8.17.0",
+    "eslint": "^8.18.0",
     "jasmine-core": "^4.2.0",
-    "karma": "^6.3.20",
+    "karma": "^6.4.0",
     "karma-chrome-launcher": "^3.1.1",
     "karma-coverage": "^2.2.0",
     "karma-html-detailed-reporter": "^2.1.0",
-    "karma-jasmine": "^5.0.1",
+    "karma-jasmine": "^5.1.0",
     "karma-nyan-reporter": "0.2.5",
     "rollup": "^2.75.6",
     "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-string": "^3.0.0",
     "terser": "^5.14.1",
-    "typescript": "^4.7.3"
+    "typescript": "^4.7.4"
   },
   "scripts": {
     "build": "npm run lint && rollup -c --silent",