melonjs 10.10.0 → 11.0.0

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

@@ -118,11 +118,10 @@ class GUI_Object extends Sprite {
      * @name onClick
      * @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;
     }
 
@@ -141,10 +140,11 @@ class GUI_Object extends Sprite {
      * @name onOver
      * @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
@@ -162,11 +162,10 @@ class GUI_Object extends Sprite {
      * @name onOut
      * @memberof GUI_Object
      * @public
-     * @function
      * @param {Pointer} event the event object
      */
-    onOut(/* event */) {
-
+    onOut(event) { // eslint-disable-line no-unused-vars
+        // to be extended
     }
 
     /**
@@ -187,7 +186,6 @@ class GUI_Object extends Sprite {
      * @name onRelease
      * @memberof GUI_Object
      * @public
-     * @function
      * @returns {boolean} return false if we need to stop propagating the event
      */
     onRelease() {
@@ -212,7 +210,6 @@ class GUI_Object extends Sprite {
      * @name onHold
      * @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();

package/src/renderable/container.js

@@ -100,10 +100,9 @@ class Container extends Renderable {
          * a callback to be extended, triggered after a child has been added or removed
          * @name onChildChange
          * @memberof Container#
-         * @function
          * @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
         };
 
@@ -157,7 +156,6 @@ class Container extends Renderable {
      * reset the container, removing all childrens, and reseting transforms.
      * @name reset
      * @memberof Container
-     * @function
      */
     reset() {
         // cancel any sort operation
@@ -189,11 +187,12 @@ 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
-     * @function
      * @param {Renderable} child
      * @param {number} [z] forces the z index of the child to the specified value
      * @returns {Renderable} the added child
@@ -257,7 +256,6 @@ class Container extends Renderable {
      * (the list won't be sorted after insertion)
      * @name addChildAt
      * @memberof Container
-     * @function
      * @param {Renderable} child
      * @param {number} index
      * @returns {Renderable} the added child
@@ -316,7 +314,6 @@ class Container extends Renderable {
      *    - The array forEach() was called upon. <br>
      * @name forEach
      * @memberof Container
-     * @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.
      * @example
@@ -353,7 +350,6 @@ class Container extends Renderable {
      * Swaps the position (z-index) of 2 children
      * @name swapChildren
      * @memberof Container
-     * @function
      * @param {Renderable} child
      * @param {Renderable} child2
      */
@@ -381,7 +377,6 @@ class Container extends Renderable {
      * Returns the Child at the specified index
      * @name getChildAt
      * @memberof Container
-     * @function
      * @param {number} index
      * @returns {Renderable} the child at the specified index
      */
@@ -398,7 +393,6 @@ class Container extends Renderable {
      * Returns the index of the given Child
      * @name getChildIndex
      * @memberof Container
-     * @function
      * @param {Renderable} child
      * @returns {number} index
      */
@@ -410,7 +404,6 @@ class Container extends Renderable {
      * Returns the next child within the container or undefined if none
      * @name getNextChild
      * @memberof Container
-     * @function
      * @param {Renderable} child
      * @returns {Renderable} child
      */
@@ -426,7 +419,6 @@ class Container extends Renderable {
      * Returns true if contains the specified Child
      * @name hasChild
      * @memberof Container
-     * @function
      * @param {Renderable} child
      * @returns {boolean}
      */
@@ -441,7 +433,6 @@ class Container extends Renderable {
      * @name getChildByProp
      * @memberof Container
      * @public
-     * @function
      * @param {string} prop Property name
      * @param {string|RegExp|number|boolean} value Value of the property
      * @returns {Renderable[]} Array of childs
@@ -493,7 +484,6 @@ class Container extends Renderable {
      * @name getChildByType
      * @memberof Container
      * @public
-     * @function
      * @param {object} classType
      * @returns {Renderable[]} Array of children
      */
@@ -520,7 +510,6 @@ class Container extends Renderable {
      * @name getChildByName
      * @memberof Container
      * @public
-     * @function
      * @param {string|RegExp|number|boolean} name child name
      * @returns {Renderable[]} Array of children
      */
@@ -535,7 +524,6 @@ class Container extends Renderable {
      * @name getChildByGUID
      * @memberof Container
      * @public
-     * @function
      * @param {string|RegExp|number|boolean} guid child GUID
      * @returns {Renderable} corresponding child or null
      */
@@ -549,7 +537,6 @@ class Container extends Renderable {
      * @name getChildren
      * @memberof Container
      * @public
-     * @function
      * @returns {Renderable[]} an array of renderable object
      */
     getChildren() {
@@ -564,7 +551,6 @@ class Container extends Renderable {
      * @ignore
      * @name updateBounds
      * @memberof Renderable
-     * @function
      * @returns {Bounds} this shape bounding box Rectangle object
      */
     updateBounds(forceUpdateChildBounds = false) {
@@ -593,7 +579,6 @@ class Container extends Renderable {
      * @private
      * @name isAttachedToRoot
      * @memberof Container
-     * @function
      * @returns {boolean}
      */
     isAttachedToRoot() {
@@ -616,7 +601,6 @@ class Container extends Renderable {
      * @ignore
      * @name updateBoundsPos
      * @memberof Container
-     * @function
      */
     updateBoundsPos(newX, newY) {
         // call the parent method
@@ -648,11 +632,11 @@ 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
-     * @function
      * @param {Renderable} child
      * @param {boolean} [keepalive=False] True to prevent calling child.destroy()
      */
@@ -671,7 +655,6 @@ class Container extends Renderable {
      * Never use keepalive=true with objects from {@link pool}. Doing so will create a memory leak.
      * @name removeChildNow
      * @memberof Container
-     * @function
      * @param {Renderable} child
      * @param {boolean} [keepalive=False] True to prevent calling child.destroy()
      */
@@ -724,7 +707,6 @@ class Container extends Renderable {
      * Automatically set the specified property of all childs to the given value
      * @name setChildsProperty
      * @memberof Container
-     * @function
      * @param {string} prop property name
      * @param {object} value property value
      * @param {boolean} [recursive=false] recursively apply the value to child containers if true
@@ -742,7 +724,6 @@ class Container extends Renderable {
      * Move the child in the group one step forward (z depth).
      * @name moveUp
      * @memberof Container
-     * @function
      * @param {Renderable} child
      */
     moveUp(child) {
@@ -759,7 +740,6 @@ class Container extends Renderable {
      * Move the child in the group one step backward (z depth).
      * @name moveDown
      * @memberof Container
-     * @function
      * @param {Renderable} child
      */
     moveDown(child) {
@@ -776,7 +756,6 @@ class Container extends Renderable {
      * Move the specified child to the top(z depth).
      * @name moveToTop
      * @memberof Container
-     * @function
      * @param {Renderable} child
      */
     moveToTop(child) {
@@ -796,7 +775,6 @@ class Container extends Renderable {
      * Move the specified child the bottom (z depth).
      * @name moveToBottom
      * @memberof Container
-     * @function
      * @param {Renderable} child
      */
     moveToBottom(child) {
@@ -817,7 +795,6 @@ class Container extends Renderable {
      * @name sort
      * @memberof Container
      * @public
-     * @function
      * @param {boolean} [recursive=false] recursively sort all containers if true
      */
     sort(recursive) {
@@ -911,7 +888,6 @@ class Container extends Renderable {
      * automatically called by the game manager {@link game}
      * @name update
      * @memberof Container
-     * @function
      * @protected
      * @param {number} dt time since the last update in milliseconds.
      * @returns {boolean} true if the Container is dirty
@@ -960,16 +936,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
-     * @function
      * @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();
 
@@ -1011,7 +985,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);

package/src/renderable/dragndrop.js

@@ -33,7 +33,6 @@ export class Draggable extends Renderable {
      * transformed events.
      * @name initEvents
      * @memberof Draggable
-     * @function
      * @private
      */
     initEvents() {
@@ -57,7 +56,6 @@ export class Draggable extends Renderable {
      * Gets called when the user starts dragging the entity
      * @name dragStart
      * @memberof Draggable
-     * @function
      * @param {object} e the pointer event
      * @returns {boolean} false if the object is being dragged
      */
@@ -74,7 +72,6 @@ export class Draggable extends Renderable {
      * Gets called when the user drags this entity around
      * @name dragMove
      * @memberof Draggable
-     * @function
      * @param {object} e the pointer event
      */
     dragMove(e) {
@@ -88,7 +85,6 @@ export class Draggable extends Renderable {
      * Gets called when the user stops dragging the entity
      * @name dragEnd
      * @memberof Draggable
-     * @function
      * @returns {boolean} false if the object stopped being dragged
      */
     dragEnd() {
@@ -102,7 +98,6 @@ export class Draggable extends Renderable {
      * Destructor
      * @name destroy
      * @memberof Draggable
-     * @function
      * @ignore
      */
     destroy() {
@@ -173,7 +168,6 @@ export class DropTarget extends Renderable {
      * Sets the collision method which is going to be used to check a valid drop
      * @name setCheckMethod
      * @memberof DropTarget
-     * @function
      * @param {string} checkMethod the checkmethod (defaults to CHECKMETHOD_OVERLAP)
      */
     setCheckMethod(checkMethod) {
@@ -188,7 +182,6 @@ export class DropTarget extends Renderable {
      * Checks if a dropped entity is dropped on the current entity
      * @name checkOnMe
      * @memberof DropTarget
-     * @function
      * @param {object} e the triggering event
      * @param {Draggable} draggable the draggable object that is dropped
      */
@@ -203,10 +196,9 @@ export class DropTarget extends Renderable {
      * Gets called when a draggable entity is dropped on the current entity
      * @name drop
      * @memberof DropTarget
-     * @function
      * @param {Draggable} draggable the draggable object that is dropped
      */
-    drop() {
+    drop(draggable) {  // eslint-disable-line no-unused-vars
 
     }
 
@@ -214,7 +206,6 @@ export class DropTarget extends Renderable {
      * Destructor
      * @name destroy
      * @memberof DropTarget
-     * @function
      * @ignore
      */
     destroy() {

package/src/renderable/imagelayer.js

@@ -75,7 +75,7 @@ class ImageLayer extends Sprite {
              * - a number, to change the value for both axis <br>
              * - a json expression like `json:{"x":0.5,"y":0.5}` if you wish to specify a different value for both x and y
              * @public
-             * @type {Vector2d}
+             * @member {Vector2d}
              * @default <0.0,0.0>
              * @name ImageLayer#anchorPoint
              */
@@ -160,12 +160,11 @@ class ImageLayer extends Sprite {
      * resize the Image Layer to match the given size
      * @name resize
      * @memberof ImageLayer
-     * @function
      * @param {number} w new width
      * @param {number} h new height
      */
     resize(w, h) {
-        super.resize(
+        return super.resize(
             this.repeatX ? Infinity : w,
             this.repeatY ? Infinity : h
         );
@@ -174,7 +173,6 @@ class ImageLayer extends Sprite {
     /**
      * createPattern function
      * @ignore
-     * @function
      */
     createPattern() {
         this._pattern = renderer.createPattern(this.image, this._repeat);
@@ -183,7 +181,6 @@ class ImageLayer extends Sprite {
     /**
      * updateLayer function
      * @ignore
-     * @function
      */
     updateLayer(vpos) {
         var rx = this.ratio.x,
@@ -246,15 +243,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
-     * @function
      * @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,