melonjs 10.2.0 → 10.3.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.<Vector>}
+ * @type {Array.<me.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.<Vector>} points The points to flatten.
- * @param {Vector} normal The unit vector axis to flatten on.
+ * @param {Array.<me.Vector2d>} points The points to flatten.
+ * @param {me.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,15 +70,15 @@ function flattenPointsOn(points, normal, result) {
  * Check whether two convex polygons are separated by the specified
  * axis (must be a unit vector).
  * @ignore
- * @param {Vector} aPos The position of the first polygon.
- * @param {Vector} bPos The position of the second polygon.
- * @param {Array.<Vector>} aPoints The points in the first polygon.
- * @param {Array.<Vector>} bPoints The points in the second polygon.
- * @param {Vector} axis The axis (unit sized) to test against.  The points of both polygons
+ * @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
  *   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.
- * @return {boolean} true if it is a separating axis, false otherwise.  If false,
+ * @returns {boolean} true if it is a separating axis, false otherwise.  If false,
  *   and a response is passed in, information about how much overlap and
  *   the direction of the overlap will be populated.
  */
@@ -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 {Vector} line The line segment.
- * @param {Vector} point The point.
- * @return  {number} LEFT_VORNOI_REGION (-1) if it is the left region,
+ * @param {me.Vector2d} line The line segment.
+ * @param {me.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.
@@ -192,7 +192,7 @@ function vornoiRegion(line, point) {
  * @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 {Response=} response Response object (optional) that will be populated if they intersect.
- * @return {boolean} true if they intersect, false if they don't.
+ * @returns {boolean} true if they intersect, false if they don't.
  */
 export function testPolygonPolygon(a, polyA, b, polyB, response) {
     // specific point for
@@ -247,7 +247,7 @@ export function testPolygonPolygon(a, polyA, b, polyB, response) {
  * @param {me.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.
- * @return {boolean} true if the circles intersect, false if they don't.
+ * @returns {boolean} true if the circles intersect, false if they don't.
  */
 export function testEllipseEllipse(a, ellipseA, b, ellipseB, response) {
     // Check if the distance between the centers of the two
@@ -287,7 +287,7 @@ export function testEllipseEllipse(a, ellipseA, b, ellipseB, response) {
  * @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 {Response=} response Response object (optional) that will be populated if they intersect.
- * @return {boolean} true if they intersect, false if they don't.
+ * @returns {boolean} true if they intersect, false if they don't.
  */
 export function testPolygonEllipse(a, polyA, b, ellipseB, response) {
     // Get the position of the circle relative to the polygon.
@@ -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) {
@@ -450,11 +450,11 @@ export function testPolygonEllipse(a, polyA, b, ellipseB, response) {
  * @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} a a reference to the object B.
+ * @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 {Response=} response Response object (optional) that will be populated if
  *   they intersect.
- * @return {boolean} true if they intersect, false if they don't.
+ * @returns {boolean} true if they intersect, false if they don't.
  */
 export function testEllipsePolygon(a, ellipseA, b, polyB, response) {
     // Test the polygon against the circle.

package/src/physics/world.js

@@ -7,16 +7,15 @@ import { collisionCheck } from "./detector.js";
 import state from "./../state/state.js";
 
 /**
-* @classdesc
+ * @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 me.Container
+ * @memberof me
+ * @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
  */
 class World extends Container {
     /**
@@ -37,10 +36,10 @@ 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 {me.Vector2d}
          * @default 60
          * @name fps
-         * @memberOf me.World
+         * @memberof me.World
          * @see me.timer.maxfps
          */
         this.fps = 60;
@@ -48,10 +47,10 @@ class World extends Container {
         /**
          * world gravity
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <0,0.98>
          * @name gravity
-         * @memberOf me.World
+         * @memberof me.World
          */
         this.gravity = new Vector2d(0, 0.98);
 
@@ -63,16 +62,16 @@ class World extends Container {
          * (amount of layer, layer size, amount of tiles per layer, etc.)<br>
          * note : rendering method is also configurable per layer by adding this
          * property to your layer (in Tiled).
-         * @type {Boolean}
+         * @type {boolean}
          * @default false
-         * @memberOf me.World
+         * @memberof me.World
          */
         this.preRender = false;
 
         /**
          * the active physic bodies in this simulation
          * @name bodies
-         * @memberOf me.World
+         * @memberof me.World
          * @public
          * @type {Set}
          */
@@ -81,7 +80,7 @@ class World extends Container {
         /**
          * the instance of the game world quadtree used for broadphase
          * @name broadphase
-         * @memberOf me.World
+         * @memberof me.World
          * @public
          * @type {me.QuadTree}
          */
@@ -100,7 +99,7 @@ class World extends Container {
     /**
      * reset the game world
      * @name reset
-     * @memberOf me.World
+     * @memberof me.World
      * @function
      */
     reset() {
@@ -121,11 +120,11 @@ class World extends Container {
     /**
      * Add a physic body to the game world
      * @name addBody
-     * @memberOf me.World
+     * @memberof me.World
      * @see me.Container.addChild
      * @function
      * @param {me.Body} body
-     * @return {me.World} this game world
+     * @returns {me.World} this game world
      */
     addBody(body) {
         //add it to the list of active body
@@ -136,11 +135,11 @@ class World extends Container {
     /**
      * Remove a physic body from the game world
      * @name removeBody
-     * @memberOf me.World
+     * @memberof me.World
      * @see me.Container.removeChild
      * @function
      * @param {me.Body} body
-     * @return {me.World} this game world
+     * @returns {me.World} this game world
      */
     removeBody(body) {
         //remove from the list of active body
@@ -151,8 +150,10 @@ class World extends Container {
     /**
      * update the game world
      * @name reset
-     * @memberOf me.World
+     * @memberof me.World
      * @function
+     * @param {number} dt the time passed since the last frame update
+     * @returns {boolean} true if the word is dirty
      */
     update (dt) {
         var isPaused = state.isPaused();

package/src/plugin/plugin.js

@@ -5,7 +5,7 @@ import { version } from "./../index.js";
  * This namespace is a container for all registered plugins.
  * @see me.plugin.register
  * @namespace me.plugins
- * @memberOf me
+ * @memberof me
  */
 export var plugins = {};
 
@@ -17,7 +17,7 @@ class BasePlugin {
          * define the minimum required version of melonJS<br>
          * this can be overridden by the plugin
          * @public
-         * @type String
+         * @type {string}
          * @default "__VERSION__"
          * @name me.plugin.Base#version
          */
@@ -27,7 +27,7 @@ class BasePlugin {
 
 /**
  * @namespace plugin
- * @memberOf me
+ * @memberof me
  */
 export var plugin = {
 
@@ -36,21 +36,20 @@ export var plugin = {
      * plugin must be installed using the register function
      * @see me.plugin
      * @class
-     * @extends me.Object
+     * @augments me.Object
      * @name plugin.Base
-     * @memberOf me
-     * @constructor
+     * @memberof me
      */
     Base : BasePlugin,
 
     /**
      * patch a melonJS function
      * @name patch
-     * @memberOf me.plugin
+     * @memberof me.plugin
      * @public
      * @function
-     * @param {Object} proto target object
-     * @param {String} name target function
+     * @param {object} proto target object
+     * @param {string} name target function
      * @param {Function} fn replacement function
      * @example
      * // redefine the me.game.update function with a new one
@@ -91,13 +90,13 @@ export var plugin = {
     /**
      * Register a plugin.
      * @name register
-     * @memberOf me.plugin
+     * @memberof me.plugin
      * @see me.plugin.Base
      * @public
      * @function
-     * @param {me.plugin.Base} plugin Plugin to instiantiate and register
-     * @param {String} name
-     * @param {} [arguments...] all extra parameters will be passed to the plugin constructor
+     * @param {me.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
      * // register a new plugin
      * me.plugin.register(TestPlugin, "testPlugin");

package/src/renderable/GUI.js

@@ -10,14 +10,12 @@ import { registerPointerEvent, releasePointerEvent} from "./../input/input.js";
  * 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}
+ * @augments me.Sprite
+ * @memberof me
+ * @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) {
@@ -42,7 +40,6 @@ import { registerPointerEvent, releasePointerEvent} from "./../input/input.js";
  *
  * // add the object at pos (10,10)
  * me.game.world.addChild(new myButton(10,10));
- *
  */
 
 class GUI_Object extends Sprite {
@@ -58,7 +55,7 @@ class GUI_Object extends Sprite {
         /**
          * object can be clicked or not
          * @public
-         * @type boolean
+         * @type {boolean}
          * @default true
          * @name me.GUI_Object#isClickable
          */
@@ -75,7 +72,7 @@ class GUI_Object extends Sprite {
         /**
          * object can be tap and hold
          * @public
-         * @type boolean
+         * @type {boolean}
          * @default false
          * @name me.GUI_Object#isHoldable
          */
@@ -84,7 +81,7 @@ class GUI_Object extends Sprite {
         /**
          * true if the pointer is over the object
          * @public
-         * @type boolean
+         * @type {boolean}
          * @default false
          * @name me.GUI_Object#hover
          */
@@ -122,14 +119,13 @@ class GUI_Object extends Sprite {
     }
 
     /**
-     * function called when the object is pressed <br>
-     * to be extended <br>
-     * return false if we need to stop propagating the event
+     * function called when the object is pressed (to be extended)
      * @name onClick
-     * @memberOf me.GUI_Object.prototype
+     * @memberof me.GUI_Object.prototype
      * @public
      * @function
-     * @param {Event} event the event object
+     * @param {me.Pointer} event the event object
+     * @returns {boolean} return false if we need to stop propagating the event
      */
     onClick(/* event */) {
         return false;
@@ -148,10 +144,10 @@ class GUI_Object extends Sprite {
     /**
      * function called when the pointer is over the object
      * @name onOver
-     * @memberOf me.GUI_Object.prototype
+     * @memberof me.GUI_Object.prototype
      * @public
      * @function
-     * @param {Event} event the event object
+     * @param {me.Pointer} event the event object
      */
     onOver(/* event */) {}
 
@@ -169,10 +165,10 @@ class GUI_Object extends Sprite {
     /**
      * function called when the pointer is leaving the object area
      * @name onOut
-     * @memberOf me.GUI_Object.prototype
+     * @memberof me.GUI_Object.prototype
      * @public
      * @function
-     * @param {Event} event the event object
+     * @param {me.Pointer} event the event object
      */
     onOut(/* event */) {
 
@@ -192,14 +188,12 @@ class GUI_Object extends Sprite {
     }
 
     /**
-     * function called when the object is pressed and released <br>
-     * to be extended <br>
-     * return false if we need to stop propagating the event
+     * function called when the object is pressed and released (to be extended)
      * @name onRelease
-     * @memberOf me.GUI_Object.prototype
+     * @memberof me.GUI_Object.prototype
      * @public
      * @function
-     * @param {Event} event the event object
+     * @returns {boolean} return false if we need to stop propagating the event
      */
     onRelease() {
         return false;
@@ -221,7 +215,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 me.GUI_Object.prototype
      * @public
      * @function
      */

package/src/renderable/collectable.js

@@ -1,18 +1,17 @@
 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 me.Sprite
+ * @memberof me
+ * @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}
  */
 
 class Collectable extends Sprite {

package/src/renderable/colorlayer.js

@@ -7,12 +7,11 @@ 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 me.Renderable
+ * @memberof me
+ * @param {string} name Layer name
+ * @param {me.Color|string} color CSS color
+ * @param {number} [z = 0] z-index position
  */
 class ColorLayer extends Renderable {
 
@@ -26,9 +25,9 @@ class ColorLayer extends Renderable {
         /**
          * the layer color component
          * @public
-         * @type me.Color
+         * @type {me.Color}
          * @name color
-         * @memberOf me.ColorLayer#
+         * @memberof me.ColorLayer#
          */
          this.color = pool.pull("Color").parseCSS(color);
 
@@ -50,14 +49,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();
     }
 
     /**