melonjs 10.2.3 → 10.5.0

package/src/physics/sat.js

@@ -26,7 +26,7 @@ var RIGHT_VORNOI_REGION = 1;
 
 /**
  * A pool of `Vector` objects that are used in calculations to avoid allocating memory.
- * @type {Array.<me.Vector2d>}
+ * @type {Array.<Vector2d>}
  * @ignore
  */
 var T_VECTORS = [];
@@ -46,8 +46,8 @@ for (var a = 0; a < 5; a++) { T_ARRAYS.push([]); }
  * resulting in a one dimensional range of the minimum and
  * maximum value on that axis.
  * @ignore
- * @param {Array.<me.Vector2d>} points The points to flatten.
- * @param {me.Vector2d} normal The unit vector axis to flatten on.
+ * @param {Array.<Vector2d>} points The points to flatten.
+ * @param {Vector2d} normal The unit vector axis to flatten on.
  * @param {Array.<number>} result An array.  After calling this function,
  *   result[0] will be the minimum value,
  *   result[1] will be the maximum value.
@@ -58,7 +58,7 @@ function flattenPointsOn(points, normal, result) {
     var len = points.length;
     for (var i = 0; i < len; i++) {
         // The magnitude of the projection of the point onto the normal
-        var dot = points[i].dotProduct(normal);
+        var dot = points[i].dot(normal);
         if (dot < min) { min = dot; }
         if (dot > max) { max = dot; }
     }
@@ -70,11 +70,11 @@ function flattenPointsOn(points, normal, result) {
  * Check whether two convex polygons are separated by the specified
  * axis (must be a unit vector).
  * @ignore
- * @param {me.Vector2d} aPos The position of the first polygon.
- * @param {me.Vector2d} bPos The position of the second polygon.
- * @param {Array.<me.Vector2d>} aPoints The points in the first polygon.
- * @param {Array.<me.Vector2d>} bPoints The points in the second polygon.
- * @param {me.Vector2d} axis The axis (unit sized) to test against.  The points of both polygons
+ * @param {Vector2d} aPos The position of the first polygon.
+ * @param {Vector2d} bPos The position of the second polygon.
+ * @param {Array.<Vector2d>} aPoints The points in the first polygon.
+ * @param {Array.<Vector2d>} bPoints The points in the second polygon.
+ * @param {Vector2d} axis The axis (unit sized) to test against.  The points of both polygons
  *   will be projected onto this axis.
  * @param {Response=} response A Response object (optional) which will be populated
  *   if the axis is not a separating axis.
@@ -87,7 +87,7 @@ function isSeparatingAxis(aPos, bPos, aPoints, bPoints, axis, response) {
     var rangeB = T_ARRAYS.pop();
     // The magnitude of the offset between the two polygons
     var offsetV = T_VECTORS.pop().copy(bPos).sub(aPos);
-    var projectedOffset = offsetV.dotProduct(axis);
+    var projectedOffset = offsetV.dot(axis);
 
     // Project the polygons onto the axis.
     flattenPointsOn(aPoints, axis, rangeA);
@@ -161,15 +161,15 @@ function isSeparatingAxis(aPos, bPos, aPoints, bPoints, axis, response) {
  * </pre>
  *
  * @ignore
- * @param {me.Vector2d} line The line segment.
- * @param {me.Vector2d} point The point.
+ * @param {Vector2d} line The line segment.
+ * @param {Vector2d} point The point.
  * @returns  {number} LEFT_VORNOI_REGION (-1) if it is the left region,
  *          MIDDLE_VORNOI_REGION (0) if it is the middle region,
  *          RIGHT_VORNOI_REGION (1) if it is the right region.
  */
 function vornoiRegion(line, point) {
     var len2 = line.length2();
-    var dp = point.dotProduct(line);
+    var dp = point.dot(line);
     if (dp < 0) {
         // If the point is beyond the start of the line, it is in the
         // left vornoi region.
@@ -187,10 +187,10 @@ function vornoiRegion(line, point) {
 /**
  * Checks whether polygons collide.
  * @ignore
- * @param {me.Renderable} a a reference to the object A.
- * @param {me.Polygon} polyA a reference to the object A Polygon to be tested
- * @param {me.Renderable} b a reference to the object B.
- * @param {me.Polygon} polyB a reference to the object B Polygon to be tested
+ * @param {Renderable} a a reference to the object A.
+ * @param {Polygon} polyA a reference to the object A Polygon to be tested
+ * @param {Renderable} b a reference to the object B.
+ * @param {Polygon} polyB a reference to the object B Polygon to be tested
  * @param {Response=} response Response object (optional) that will be populated if they intersect.
  * @returns {boolean} true if they intersect, false if they don't.
  */
@@ -241,10 +241,10 @@ export function testPolygonPolygon(a, polyA, b, polyB, response) {
 /**
  * Check if two Ellipse collide.
  * @ignore
- * @param {me.Renderable} a a reference to the object A.
- * @param {me.Ellipse} ellipseA a reference to the object A Ellipse to be tested
- * @param {me.Renderable} b a reference to the object B.
- * @param {me.Ellipse} ellipseB a reference to the object B Ellipse to be tested
+ * @param {Renderable} a a reference to the object A.
+ * @param {Ellipse} ellipseA a reference to the object A Ellipse to be tested
+ * @param {Renderable} b a reference to the object B.
+ * @param {Ellipse} ellipseB a reference to the object B Ellipse to be tested
  * @param {Response=} response Response object (optional) that will be populated if
  *   the circles intersect.
  * @returns {boolean} true if the circles intersect, false if they don't.
@@ -282,10 +282,10 @@ export function testEllipseEllipse(a, ellipseA, b, ellipseB, response) {
 /**
  * Check if a polygon and an ellipse collide.
  * @ignore
- * @param {me.Renderable} a a reference to the object A.
- * @param {me.Polygon} polyA a reference to the object A Polygon to be tested
- * @param {me.Renderable} b a reference to the object B.
- * @param {me.Ellipse} ellipseB a reference to the object B Ellipse to be tested
+ * @param {Renderable} a a reference to the object A.
+ * @param {Polygon} polyA a reference to the object A Polygon to be tested
+ * @param {Renderable} b a reference to the object B.
+ * @param {Ellipse} ellipseB a reference to the object B Ellipse to be tested
  * @param {Response=} response Response object (optional) that will be populated if they intersect.
  * @returns {boolean} true if they intersect, false if they don't.
  */
@@ -400,7 +400,7 @@ export function testPolygonEllipse(a, polyA, b, ellipseB, response) {
             normal.copy(polyA.normals[i]);
             // Find the perpendicular distance between the center of the
             // circle and the edge.
-            dist = point.dotProduct(normal);
+            dist = point.dot(normal);
             var distAbs = Math.abs(dist);
             // If the circle is on the outside of the edge, there is no intersection.
             if ((len === 1 || dist > 0) && distAbs > radius) {
@@ -448,10 +448,10 @@ export function testPolygonEllipse(a, polyA, b, ellipseB, response) {
  * **NOTE:** This is slightly less efficient than testPolygonEllipse as it just
  * runs testPolygonEllipse and reverses the response at the end.
  * @ignore
- * @param {me.Renderable} a a reference to the object A.
- * @param {me.Ellipse} ellipseA a reference to the object A Ellipse to be tested
- * @param {me.Renderable} b a reference to the object B.
- * @param {me.Polygon} polyB a reference to the object B Polygon to be tested
+ * @param {Renderable} a a reference to the object A.
+ * @param {Ellipse} ellipseA a reference to the object A Ellipse to be tested
+ * @param {Renderable} b a reference to the object B.
+ * @param {Polygon} polyB a reference to the object B Polygon to be tested
  * @param {Response=} response Response object (optional) that will be populated if
  *   they intersect.
  * @returns {boolean} true if they intersect, false if they don't.

package/src/physics/world.js

@@ -9,21 +9,16 @@ import state from "./../state/state.js";
 /**
  * @classdesc
  * an object representing the physic world, and responsible for managing and updating all childs and physics
- * @class World
- * @extends me.Container
- * @memberOf me
- * @constructor
- * @param {number} [x=0] position of the container (accessible via the inherited pos.x property)
- * @param {number} [y=0] position of the container (accessible via the inherited pos.y property)
- * @param {number} [w=me.game.viewport.width] width of the container
- * @param {number} [h=me.game.viewport.height] height of the container
+ * @augments Container
  */
 class World extends Container {
     /**
-     * @ignore
+     * @param {number} [x=0] position of the container (accessible via the inherited pos.x property)
+     * @param {number} [y=0] position of the container (accessible via the inherited pos.y property)
+     * @param {number} [width=game.viewport.width] width of the container
+     * @param {number} [height=game.viewport.height] height of the container
      */
     constructor(x = 0, y = 0, width = Infinity, height = Infinity) {
-
         // call the super constructor
         super(x, y, width, height, true);
 
@@ -37,21 +32,21 @@ class World extends Container {
          * the rate at which the game world is updated,
          * may be greater than or lower than the display fps
          * @public
-         * @type {me.Vector2d}
+         * @type {Vector2d}
          * @default 60
          * @name fps
-         * @memberOf me.World
-         * @see me.timer.maxfps
+         * @memberof World
+         * @see timer.maxfps
          */
         this.fps = 60;
 
         /**
          * world gravity
          * @public
-         * @type {me.Vector2d}
+         * @type {Vector2d}
          * @default <0,0.98>
          * @name gravity
-         * @memberOf me.World
+         * @memberof World
          */
         this.gravity = new Vector2d(0, 0.98);
 
@@ -65,14 +60,14 @@ class World extends Container {
          * property to your layer (in Tiled).
          * @type {boolean}
          * @default false
-         * @memberOf me.World
+         * @memberof World
          */
         this.preRender = false;
 
         /**
          * the active physic bodies in this simulation
          * @name bodies
-         * @memberOf me.World
+         * @memberof World
          * @public
          * @type {Set}
          */
@@ -81,9 +76,9 @@ class World extends Container {
         /**
          * the instance of the game world quadtree used for broadphase
          * @name broadphase
-         * @memberOf me.World
+         * @memberof World
          * @public
-         * @type {me.QuadTree}
+         * @type {QuadTree}
          */
         this.broadphase = new QuadTree(this.getBounds().clone(), collision.maxChildren, collision.maxDepth);
 
@@ -100,7 +95,7 @@ class World extends Container {
     /**
      * reset the game world
      * @name reset
-     * @memberOf me.World
+     * @memberof World
      * @function
      */
     reset() {
@@ -121,11 +116,11 @@ class World extends Container {
     /**
      * Add a physic body to the game world
      * @name addBody
-     * @memberOf me.World
-     * @see me.Container.addChild
+     * @memberof World
+     * @see Container.addChild
      * @function
-     * @param {me.Body} body
-     * @returns {me.World} this game world
+     * @param {Body} body
+     * @returns {World} this game world
      */
     addBody(body) {
         //add it to the list of active body
@@ -136,11 +131,11 @@ class World extends Container {
     /**
      * Remove a physic body from the game world
      * @name removeBody
-     * @memberOf me.World
-     * @see me.Container.removeChild
+     * @memberof World
+     * @see Container.removeChild
      * @function
-     * @param {me.Body} body
-     * @returns {me.World} this game world
+     * @param {Body} body
+     * @returns {World} this game world
      */
     removeBody(body) {
         //remove from the list of active body
@@ -151,7 +146,7 @@ class World extends Container {
     /**
      * update the game world
      * @name reset
-     * @memberOf me.World
+     * @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

@@ -3,9 +3,8 @@ import { version } from "./../index.js";
 
 /**
  * This namespace is a container for all registered plugins.
- * @see me.plugin.register
- * @namespace me.plugins
- * @memberOf me
+ * @see plugin.register
+ * @namespace plugins
  */
 export var plugins = {};
 
@@ -19,7 +18,7 @@ class BasePlugin {
          * @public
          * @type {string}
          * @default "__VERSION__"
-         * @name me.plugin.Base#version
+         * @name plugin.Base#version
          */
         this.version = "__VERSION__";
     }
@@ -27,26 +26,23 @@ class BasePlugin {
 
 /**
  * @namespace plugin
- * @memberOf me
  */
 export var plugin = {
 
     /**
      * a base Object for plugin <br>
      * plugin must be installed using the register function
-     * @see me.plugin
+     * @see plugin
      * @class
-     * @extends me.Object
-     * @name plugin.Base
-     * @memberOf me
-     * @constructor
+     * @name Base
+     * @memberof plugin
      */
     Base : BasePlugin,
 
     /**
      * patch a melonJS function
      * @name patch
-     * @memberOf me.plugin
+     * @memberof plugin
      * @public
      * @function
      * @param {object} proto target object
@@ -66,7 +62,7 @@ export var plugin = {
         if (typeof proto.prototype !== "undefined") {
             proto = proto.prototype;
         }
-        // reuse the logic behind me.Object.extend
+        // reuse the logic behind object extends
         if (typeof(proto[name]) === "function") {
             // save the original function
             var _parent = proto[name];
@@ -91,11 +87,11 @@ export var plugin = {
     /**
      * Register a plugin.
      * @name register
-     * @memberOf me.plugin
-     * @see me.plugin.Base
+     * @memberof plugin
+     * @see Base
      * @public
      * @function
-     * @param {me.plugin.Base} pluginObj Plugin object to instantiate and register
+     * @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
      * @example

package/src/renderable/GUI.js

@@ -9,44 +9,38 @@ import { registerPointerEvent, releasePointerEvent} from "./../input/input.js";
  * A very basic object to manage GUI elements <br>
  * The object simply register on the "pointerdown" <br>
  * or "touchstart" event and call the onClick function"
- * @class GUI_Object
- * @extends me.Sprite
- * @memberOf me
- * @constructor
- * @param {number} x the x coordinate of the GUI Object
- * @param {number} y the y coordinate of the GUI Object
- * @param {object} settings See {@link me.Sprite}
- * @example
- * // create a basic GUI Object
- * class myButton extends GUI_Object {
- *    constructor(x, y) {
- *       var settings = {}
- *       settings.image = "button";
- *       settings.framewidth = 100;
- *       settings.frameheight = 50;
- *       // super constructor
- *       super(x, y, settings);
- *       // define the object z order
- *       this.pos.z = 4;
- *    }
- *
- *    // output something in the console
- *    // when the object is clicked
- *    onClick:function (event) {
- *       console.log("clicked!");
- *       // don't propagate the event
- *       return false;
- *    }
- * });
- *
- * // add the object at pos (10,10)
- * me.game.world.addChild(new myButton(10,10));
+ * @augments Sprite
  */
-
 class GUI_Object extends Sprite {
-
     /**
-     * @ignore
+     * @param {number} x the x coordinate of the GUI Object
+     * @param {number} y the y coordinate of the GUI Object
+     * @param {object} settings See {@link Sprite}
+     * @example
+     * // create a basic GUI Object
+     * class myButton extends GUI_Object {
+     *    constructor(x, y) {
+     *       var settings = {}
+     *       settings.image = "button";
+     *       settings.framewidth = 100;
+     *       settings.frameheight = 50;
+     *       // super constructor
+     *       super(x, y, settings);
+     *       // define the object z order
+     *       this.pos.z = 4;
+     *    }
+     *
+     *    // output something in the console
+     *    // when the object is clicked
+     *    onClick:function (event) {
+     *       console.log("clicked!");
+     *       // don't propagate the event
+     *       return false;
+     *    }
+     * });
+     *
+     * // add the object at pos (10,10)
+     * me.game.world.addChild(new myButton(10,10));
      */
     constructor(x, y, settings) {
 
@@ -58,7 +52,7 @@ class GUI_Object extends Sprite {
          * @public
          * @type {boolean}
          * @default true
-         * @name me.GUI_Object#isClickable
+         * @name GUI_Object#isClickable
          */
         this.isClickable = true;
 
@@ -66,7 +60,7 @@ class GUI_Object extends Sprite {
          * Tap and hold threshold timeout in ms
          * @type {number}
          * @default 250
-         * @name me.GUI_Object#holdThreshold
+         * @name GUI_Object#holdThreshold
          */
         this.holdThreshold = 250;
 
@@ -75,7 +69,7 @@ class GUI_Object extends Sprite {
          * @public
          * @type {boolean}
          * @default false
-         * @name me.GUI_Object#isHoldable
+         * @name GUI_Object#isHoldable
          */
         this.isHoldable = false;
 
@@ -84,7 +78,7 @@ class GUI_Object extends Sprite {
          * @public
          * @type {boolean}
          * @default false
-         * @name me.GUI_Object#hover
+         * @name GUI_Object#hover
          */
         this.hover = false;
 
@@ -122,10 +116,10 @@ class GUI_Object extends Sprite {
     /**
      * function called when the object is pressed (to be extended)
      * @name onClick
-     * @memberOf me.GUI_Object.prototype
+     * @memberof GUI_Object.prototype
      * @public
      * @function
-     * @param {me.Pointer} event the event object
+     * @param {Pointer} event the event object
      * @returns {boolean} return false if we need to stop propagating the event
      */
     onClick(/* event */) {
@@ -145,10 +139,10 @@ class GUI_Object extends Sprite {
     /**
      * function called when the pointer is over the object
      * @name onOver
-     * @memberOf me.GUI_Object.prototype
+     * @memberof GUI_Object.prototype
      * @public
      * @function
-     * @param {me.Pointer} event the event object
+     * @param {Pointer} event the event object
      */
     onOver(/* event */) {}
 
@@ -166,10 +160,10 @@ class GUI_Object extends Sprite {
     /**
      * function called when the pointer is leaving the object area
      * @name onOut
-     * @memberOf me.GUI_Object.prototype
+     * @memberof GUI_Object.prototype
      * @public
      * @function
-     * @param {me.Pointer} event the event object
+     * @param {Pointer} event the event object
      */
     onOut(/* event */) {
 
@@ -191,7 +185,7 @@ class GUI_Object extends Sprite {
     /**
      * function called when the object is pressed and released (to be extended)
      * @name onRelease
-     * @memberOf me.GUI_Object.prototype
+     * @memberof GUI_Object.prototype
      * @public
      * @function
      * @returns {boolean} return false if we need to stop propagating the event
@@ -216,7 +210,7 @@ class GUI_Object extends Sprite {
      * function called when the object is pressed and held<br>
      * to be extended <br>
      * @name onHold
-     * @memberOf me.GUI_Object.prototype
+     * @memberof GUI_Object.prototype
      * @public
      * @function
      */

package/src/renderable/collectable.js

@@ -1,23 +1,18 @@
 import Sprite from "./sprite.js";
 import Body from "./../physics/body.js";
-import Rect from "./../shapes/rectangle.js";
+import Rect from "./../geometries/rectangle.js";
 import collision from "./../physics/collision.js";
 
 /**
  * @classdesc
  * a basic collectable helper class for immovable object (e.g. a coin)
- * @class Collectable
- * @extends me.Sprite
- * @memberOf me
- * @constructor
- * @param {number} x the x coordinates of the collectable
- * @param {number} y the y coordinates of the collectable
- * @param {object} settings See {@link me.Sprite}
+ * @augments Sprite
  */
-
 class Collectable extends Sprite {
     /**
-     * @ignore
+     * @param {number} x the x coordinates of the collectable
+     * @param {number} y the y coordinates of the collectable
+     * @param {object} settings See {@link Sprite}
      */
     constructor(x, y, settings) {
 

package/src/renderable/colorlayer.js

@@ -6,18 +6,13 @@ import Renderable from "./renderable.js";
 /**
  * @classdesc
  * a generic Color Layer Object.  Fills the entire Canvas with the color not just the container the object belongs to.
- * @class ColorLayer
- * @extends me.Renderable
- * @memberOf me
- * @constructor
- * @param {string} name Layer name
- * @param {me.Color|string} color CSS color
- * @param {number} [z = 0] z-index position
+ * @augments Renderable
  */
 class ColorLayer extends Renderable {
-
     /**
-     * @ignore
+     * @param {string} name Layer name
+     * @param {Color|string} color CSS color
+     * @param {number} [z = 0] z-index position
      */
     constructor(name, color, z) {
         // parent constructor
@@ -26,9 +21,9 @@ class ColorLayer extends Renderable {
         /**
          * the layer color component
          * @public
-         * @type {me.Color}
+         * @type {Color}
          * @name color
-         * @memberOf me.ColorLayer#
+         * @memberof ColorLayer#
          */
          this.color = pool.pull("Color").parseCSS(color);
 
@@ -50,14 +45,14 @@ class ColorLayer extends Renderable {
      * @ignore
      */
     draw(renderer, rect) {
-        var color = renderer.getColor();
         var vpos = viewport.pos;
-        renderer.setColor(this.color);
-        renderer.fillRect(
+        renderer.save();
+        renderer.clipRect(
             rect.left - vpos.x, rect.top - vpos.y,
             rect.width, rect.height
         );
-        renderer.setColor(color);
+        renderer.clearColor(this.color);
+        renderer.restore();
     }
 
     /**