melonjs 10.2.3 → 10.3.0

package/src/physics/quadtree.js

@@ -53,8 +53,7 @@ var QT_VECTOR = new Vector2d();
  * a QuadTree implementation in JavaScript, a 2d spatial subdivision algorithm.
  * @class
  * @name QuadTree
- * @memberOf me
- * @constructor
+ * @memberof me
  * @see me.game.world.broadphase
  * @param {me.Bounds} bounds bounds of the node
  * @param {number} [max_objects=4] max objects a node can hold before splitting into 4 subnodes
@@ -167,7 +166,7 @@ class QuadTree {
     /**
      * Insert the given object container into the node.
      * @name insertContainer
-     * @memberOf me.QuadTree
+     * @memberof me.QuadTree
      * @function
      * @param {me.Container} container group of objects to be added
      */
@@ -196,7 +195,7 @@ class QuadTree {
      * exceeds the capacity, it will split and add all
      * objects to their corresponding subnodes.
      * @name insert
-     * @memberOf me.QuadTree
+     * @memberof me.QuadTree
      * @function
      * @param {object} item object to be added
      */
@@ -241,7 +240,7 @@ class QuadTree {
     /**
      * Return all objects that could collide with the given object
      * @name retrieve
-     * @memberOf me.QuadTree
+     * @memberof me.QuadTree
      * @function
      * @param {object} item object to be checked against
      * @param {object} [fn] a sorting function for the returned array
@@ -277,7 +276,7 @@ class QuadTree {
      * Remove the given item from the quadtree.
      * (this function won't recalculate the impacted node)
      * @name remove
-     * @memberOf me.QuadTree
+     * @memberof me.QuadTree
      * @function
      * @param {object} item object to be removed
      * @returns {boolean} true if the item was found and removed.
@@ -318,7 +317,7 @@ class QuadTree {
     /**
      * return true if the node is prunable
      * @name isPrunable
-     * @memberOf me.QuadTree
+     * @memberof me.QuadTree
      * @function
      * @returns {boolean} true if the node is prunable
      */
@@ -329,7 +328,7 @@ class QuadTree {
     /**
      * return true if the node has any children
      * @name hasChildren
-     * @memberOf me.QuadTree
+     * @memberof me.QuadTree
      * @function
      * @returns {boolean} true if the node has any children
      */
@@ -346,7 +345,7 @@ class QuadTree {
     /**
      * clear the quadtree
      * @name clear
-     * @memberOf me.QuadTree
+     * @memberof me.QuadTree
      * @function
      * @param {me.Bounds} [bounds=this.bounds] the bounds to be cleared
      */

package/src/physics/sat.js

@@ -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; }
     }
@@ -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);
@@ -169,7 +169,7 @@ function isSeparatingAxis(aPos, bPos, aPoints, bPoints, axis, response) {
  */
 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.
@@ -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) {

package/src/physics/world.js

@@ -10,9 +10,8 @@ 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
+ * @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
@@ -40,7 +39,7 @@ class World extends Container {
          * @type {me.Vector2d}
          * @default 60
          * @name fps
-         * @memberOf me.World
+         * @memberof me.World
          * @see me.timer.maxfps
          */
         this.fps = 60;
@@ -51,7 +50,7 @@ class World extends Container {
          * @type {me.Vector2d}
          * @default <0,0.98>
          * @name gravity
-         * @memberOf me.World
+         * @memberof me.World
          */
         this.gravity = new Vector2d(0, 0.98);
 
@@ -65,14 +64,14 @@ class World extends Container {
          * property to your layer (in Tiled).
          * @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,7 +120,7 @@ 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
@@ -136,7 +135,7 @@ 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
@@ -151,7 +150,7 @@ 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

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 = {};
 
@@ -27,7 +27,7 @@ class BasePlugin {
 
 /**
  * @namespace plugin
- * @memberOf me
+ * @memberof me
  */
 export var plugin = {
 
@@ -36,17 +36,16 @@ 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
@@ -91,7 +90,7 @@ export var plugin = {
     /**
      * Register a plugin.
      * @name register
-     * @memberOf me.plugin
+     * @memberof me.plugin
      * @see me.plugin.Base
      * @public
      * @function

package/src/renderable/GUI.js

@@ -10,9 +10,8 @@ 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
+ * @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}
@@ -122,7 +121,7 @@ class GUI_Object extends Sprite {
     /**
      * 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 {me.Pointer} event the event object
@@ -145,7 +144,7 @@ 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 {me.Pointer} event the event object
@@ -166,7 +165,7 @@ 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 {me.Pointer} event the event object
@@ -191,7 +190,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 me.GUI_Object.prototype
      * @public
      * @function
      * @returns {boolean} return false if we need to stop propagating the event
@@ -216,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,15 +1,14 @@
 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
+ * @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}

package/src/renderable/colorlayer.js

@@ -7,9 +7,8 @@ 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
+ * @augments me.Renderable
+ * @memberof me
  * @param {string} name Layer name
  * @param {me.Color|string} color CSS color
  * @param {number} [z = 0] z-index position
@@ -28,7 +27,7 @@ class ColorLayer extends Renderable {
          * @public
          * @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();
     }
 
     /**

package/src/renderable/container.js

@@ -20,9 +20,8 @@ var globalFloatingCounter = 0;
  * @classdesc
  * me.Container represents a collection of child objects
  * @class Container
- * @extends me.Renderable
- * @memberOf me
- * @constructor
+ * @augments me.Renderable
+ * @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
@@ -51,7 +50,7 @@ class Container extends Renderable {
          * @type {boolean}
          * @default false
          * @name root
-         * @memberOf me.Container
+         * @memberof me.Container
          */
         this.root = root;
 
@@ -68,7 +67,7 @@ class Container extends Renderable {
          * @type {string}
          * @default me.game.sortOn
          * @name sortOn
-         * @memberOf me.Container
+         * @memberof me.Container
          */
         this.sortOn = game.sortOn;
 
@@ -78,7 +77,7 @@ class Container extends Renderable {
          * @type {boolean}
          * @default true
          * @name autoSort
-         * @memberOf me.Container
+         * @memberof me.Container
          */
         this.autoSort = true;
 
@@ -88,7 +87,7 @@ class Container extends Renderable {
          * @type {boolean}
          * @default true
          * @name autoDepth
-         * @memberOf me.Container
+         * @memberof me.Container
          */
         this.autoDepth = true;
 
@@ -98,14 +97,14 @@ class Container extends Renderable {
          * @type {boolean}
          * @default false
          * @name clipping
-         * @memberOf me.Container
+         * @memberof me.Container
          */
         this.clipping = false;
 
         /**
          * a callback to be extended, triggered after a child has been added or removed
          * @name onChildChange
-         * @memberOf me.Container#
+         * @memberof me.Container#
          * @function
          * @param {number} index added or removed child index
          */
@@ -121,7 +120,7 @@ class Container extends Renderable {
          * @type {boolean}
          * @default false
          * @name enableChildBoundsUpdate
-         * @memberOf me.Container
+         * @memberof me.Container
          */
         this.enableChildBoundsUpdate = false;
 
@@ -149,7 +148,7 @@ class Container extends Renderable {
     /**
      * reset the container, removing all childrens, and reseting transforms.
      * @name reset
-     * @memberOf me.Container
+     * @memberof me.Container
      * @function
      */
     reset() {
@@ -183,7 +182,7 @@ class Container extends Renderable {
      * orginal container.  Then when the me.game.world.reset() is called the renderable
      * will not be in any container.
      * @name addChild
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @param {me.Renderable} child
      * @param {number} [z] forces the z index of the child to the specified value
@@ -247,7 +246,7 @@ class Container extends Renderable {
      * Add a child to the container at the specified index<br>
      * (the list won't be sorted after insertion)
      * @name addChildAt
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @param {me.Renderable} child
      * @param {number} index
@@ -306,7 +305,7 @@ class Container extends Renderable {
      *    - The index of element in the array. <br>
      *    - The array forEach() was called upon. <br>
      * @name forEach
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @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.
@@ -343,7 +342,7 @@ class Container extends Renderable {
     /**
      * Swaps the position (z-index) of 2 children
      * @name swapChildren
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @param {me.Renderable} child
      * @param {me.Renderable} child2
@@ -369,7 +368,7 @@ class Container extends Renderable {
     /**
      * Returns the Child at the specified index
      * @name getChildAt
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @param {number} index
      * @returns {me.Renderable} the child at the specified index
@@ -386,7 +385,7 @@ class Container extends Renderable {
     /**
      * Returns the index of the given Child
      * @name getChildIndex
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @param {me.Renderable} child
      * @returns {number} index
@@ -398,7 +397,7 @@ class Container extends Renderable {
     /**
      * Returns the next child within the container or undefined if none
      * @name getNextChild
-     * @memberOf me.Container
+     * @memberof me.Container
      * @function
      * @param {me.Renderable} child
      * @returns {me.Renderable} child
@@ -414,7 +413,7 @@ class Container extends Renderable {
     /**
      * Returns true if contains the specified Child
      * @name hasChild
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @param {me.Renderable} child
      * @returns {boolean}
@@ -428,7 +427,7 @@ class Container extends Renderable {
      * note : avoid calling this function every frame since
      * it parses the whole object tree each time
      * @name getChildByProp
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @public
      * @function
      * @param {string} prop Property name
@@ -480,7 +479,7 @@ class Container extends Renderable {
     /**
      * returns the list of childs with the specified class type
      * @name getChildByType
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @public
      * @function
      * @param {object} classType
@@ -507,7 +506,7 @@ class Container extends Renderable {
      * note : avoid calling this function every frame since
      * it parses the whole object list each time
      * @name getChildByName
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @public
      * @function
      * @param {string|RegExp|number|boolean} name child name
@@ -522,7 +521,7 @@ class Container extends Renderable {
      * note : avoid calling this function every frame since
      * it parses the whole object list each time
      * @name getChildByGUID
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @public
      * @function
      * @param {string|RegExp|number|boolean} guid child GUID
@@ -536,7 +535,7 @@ class Container extends Renderable {
     /**
      * return all child in this container
      * @name getChildren
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @public
      * @function
      * @returns {me.Renderable[]} an array of renderable object
@@ -552,7 +551,7 @@ class Container extends Renderable {
      * update the bounding box for this shape.
      * @ignore
      * @name updateBounds
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @returns {me.Bounds} this shape bounding box Rectangle object
      */
@@ -581,7 +580,7 @@ class Container extends Renderable {
      * Checks if this container is root or if it's attached to the root container.
      * @private
      * @name isAttachedToRoot
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @returns {boolean}
      */
@@ -604,7 +603,7 @@ class Container extends Renderable {
      * update the cointainer's bounding rect (private)
      * @ignore
      * @name updateBoundsPos
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      */
     updateBoundsPos(newX, newY) {
@@ -639,7 +638,7 @@ class Container extends Renderable {
     /**
      * Invokes the removeChildNow in a defer, to ensure the child is removed safely after the update & draw stack has completed
      * @name removeChild
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @public
      * @function
      * @param {me.Renderable} child
@@ -659,7 +658,7 @@ class Container extends Renderable {
      * (removal is immediate and unconditional)<br>
      * Never use keepalive=true with objects from {@link me.pool}. Doing so will create a memory leak.
      * @name removeChildNow
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @param {me.Renderable} child
      * @param {boolean} [keepalive=False] True to prevent calling child.destroy()
@@ -712,7 +711,7 @@ class Container extends Renderable {
     /**
      * Automatically set the specified property of all childs to the given value
      * @name setChildsProperty
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @param {string} prop property name
      * @param {object} value property value
@@ -730,7 +729,7 @@ class Container extends Renderable {
     /**
      * Move the child in the group one step forward (z depth).
      * @name moveUp
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @param {me.Renderable} child
      */
@@ -745,7 +744,7 @@ class Container extends Renderable {
     /**
      * Move the child in the group one step backward (z depth).
      * @name moveDown
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @param {me.Renderable} child
      */
@@ -760,7 +759,7 @@ class Container extends Renderable {
     /**
      * Move the specified child to the top(z depth).
      * @name moveToTop
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @param {me.Renderable} child
      */
@@ -778,7 +777,7 @@ class Container extends Renderable {
     /**
      * Move the specified child the bottom (z depth).
      * @name moveToBottom
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @param {me.Renderable} child
      */
@@ -796,7 +795,7 @@ class Container extends Renderable {
     /**
      * Manually trigger the sort of all the childs in the container</p>
      * @name sort
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @public
      * @function
      * @param {boolean} [recursive=false] recursively sort all containers if true
@@ -891,7 +890,7 @@ class Container extends Renderable {
      * container update function. <br>
      * automatically called by the game manager {@link me.game}
      * @name update
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @protected
      * @param {number} dt time since the last update in milliseconds.
@@ -944,7 +943,7 @@ class Container extends Renderable {
      * draw the container. <br>
      * automatically called by the game manager {@link me.game}
      * @name draw
-     * @memberOf me.Container.prototype
+     * @memberof me.Container.prototype
      * @function
      * @protected
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object