melonjs 10.1.0 → 10.2.2

package/src/physics/quadtree.js

@@ -57,9 +57,9 @@ var QT_VECTOR = new Vector2d();
  * @constructor
  * @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
- * @param {Number} [max_levels=4] total max levels inside root Quadtree
- * @param {Number} [level] deepth level, required for subnodes
+ * @param {number} [max_objects=4] max objects a node can hold before splitting into 4 subnodes
+ * @param {number} [max_levels=4] total max levels inside root Quadtree
+ * @param {number} [level] deepth level, required for subnodes
  */
 class QuadTree {
 
@@ -120,23 +120,24 @@ class QuadTree {
     /*
      * Determine which node the object belongs to
      * @param {me.Rect} rect bounds of the area to be checked
-     * @return Integer index of the subnode (0-3), or -1 if rect cannot completely fit within a subnode and is part of the parent node
+     * @returns Integer index of the subnode (0-3), or -1 if rect cannot completely fit within a subnode and is part of the parent node
      */
     getIndex(item) {
         var pos;
+        var bounds = item.getBounds();
 
         // use game world coordinates for floating items
-        if (item.floating || (item.ancestor && item.ancestor.floating)) {
-            pos = viewport.localToWorld(item.left, item.top, QT_VECTOR);
+        if (item.isFloating === true) {
+            pos = viewport.localToWorld(bounds.left, bounds.top, QT_VECTOR);
         } else {
-            pos = QT_VECTOR.set(item.left, item.top);
+            pos = QT_VECTOR.set(bounds.left, bounds.top);
         }
 
         var index = -1,
             rx = pos.x,
             ry = pos.y,
-            rw = item.width,
-            rh = item.height,
+            rw = bounds.width,
+            rh = bounds.height,
             verticalMidpoint = this.bounds.left + (this.bounds.width / 2),
             horizontalMidpoint = this.bounds.top + (this.bounds.height / 2),
             //rect can completely fit within the top quadrants
@@ -197,7 +198,7 @@ class QuadTree {
      * @name insert
      * @memberOf me.QuadTree
      * @function
-     * @param {Object} item object to be added
+     * @param {object} item object to be added
      */
     insert(item) {
         var index = -1;
@@ -242,9 +243,9 @@ class QuadTree {
      * @name retrieve
      * @memberOf me.QuadTree
      * @function
-     * @param {Object} object object to be checked against
-     * @param {Object} [function] a sorting function for the returned array
-     * @return {Object[]} array with all detected objects
+     * @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
      */
     retrieve(item, fn) {
         var returnObjects = this.objects;
@@ -278,8 +279,8 @@ class QuadTree {
      * @name remove
      * @memberOf me.QuadTree
      * @function
-     * @param {Object} object object to be removed
-     * @return true if the item was found and removed.
+     * @param {object} item object to be removed
+     * @returns {boolean} true if the item was found and removed.
      */
      remove(item) {
         var found = false;
@@ -319,7 +320,7 @@ class QuadTree {
      * @name isPrunable
      * @memberOf me.QuadTree
      * @function
-     * @return true if the node is prunable
+     * @returns {boolean} true if the node is prunable
      */
     isPrunable() {
         return !(this.hasChildren() || (this.objects.length > 0));
@@ -330,7 +331,7 @@ class QuadTree {
      * @name hasChildren
      * @memberOf me.QuadTree
      * @function
-     * @return true if the node has any children
+     * @returns {boolean} true if the node has any children
      */
     hasChildren() {
         for (var i = 0; i < this.nodes.length; i = i + 1) {
@@ -347,6 +348,7 @@ class QuadTree {
      * @name clear
      * @memberOf me.QuadTree
      * @function
+     * @param {me.Bounds} [bounds=this.bounds] the bounds to be cleared
      */
     clear(bounds) {
         this.objects.length = 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.
@@ -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.
  */
@@ -161,9 +161,9 @@ 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.
  */
@@ -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.
@@ -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,15 +7,16 @@ import { collisionCheck } from "./detector.js";
 import state from "./../state/state.js";
 
 /**
+ * @classdesc
  * an object representing the physic world, and responsible for managing and updating all childs and physics
- * @class
+ * @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
+ * @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 {
     /**
@@ -36,7 +37,7 @@ 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
@@ -47,7 +48,7 @@ class World extends Container {
         /**
          * world gravity
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <0,0.98>
          * @name gravity
          * @memberOf me.World
@@ -62,7 +63,7 @@ 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
          */
@@ -124,7 +125,7 @@ class World extends Container {
      * @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
@@ -139,7 +140,7 @@ class World extends Container {
      * @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
@@ -152,6 +153,8 @@ class World extends Container {
      * @name reset
      * @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

@@ -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
          */
@@ -49,8 +49,8 @@ export var 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
@@ -95,9 +95,9 @@ export var 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

@@ -13,11 +13,10 @@ import { registerPointerEvent, releasePointerEvent} from "./../input/input.js";
  * @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}
+ * @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 +41,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 +56,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 +73,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 +82,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 +120,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
      * @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;
@@ -151,7 +148,7 @@ class GUI_Object extends Sprite {
      * @memberOf me.GUI_Object.prototype
      * @public
      * @function
-     * @param {Event} event the event object
+     * @param {me.Pointer} event the event object
      */
     onOver(/* event */) {}
 
@@ -172,7 +169,7 @@ class GUI_Object extends Sprite {
      * @memberOf me.GUI_Object.prototype
      * @public
      * @function
-     * @param {Event} event the event object
+     * @param {me.Pointer} event the event object
      */
     onOut(/* event */) {
 
@@ -192,14 +189,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
      * @public
      * @function
-     * @param {Event} event the event object
+     * @returns {boolean} return false if we need to stop propagating the event
      */
     onRelease() {
         return false;

package/src/renderable/collectable.js

@@ -10,9 +10,9 @@ import collision from "./../physics/collision.js";
  * @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}
+ * @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

@@ -10,9 +10,9 @@ import Renderable from "./renderable.js";
  * @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
+ * @param {string} name Layer name
+ * @param {me.Color|string} color CSS color
+ * @param {number} [z = 0] z-index position
  */
 class ColorLayer extends Renderable {
 
@@ -26,7 +26,7 @@ class ColorLayer extends Renderable {
         /**
          * the layer color component
          * @public
-         * @type me.Color
+         * @type {me.Color}
          * @name color
          * @memberOf me.ColorLayer#
          */