melonjs 10.2.0 → 10.3.0

package/src/entity/draggable.js

@@ -4,26 +4,17 @@ import * as event from "./../system/event.js";
 import Entity from "./entity.js";
 
 /**
-* Used to make a game entity draggable
-* @class
-* @extends me.Entity
-* @memberOf me
-* @constructor
-* @param {Number} x the x coordinates of the entity object
-* @param {Number} y the y coordinates of the entity object
-* @param {Object} settings Entity properties (see {@link me.Entity})
-*/
+ * @classdesc
+ * Used to make a game entity draggable
+ * @class DraggableEntity
+ * @augments me.Entity
+ * @memberof me
+ * @param {number} x the x coordinates of the entity object
+ * @param {number} y the y coordinates of the entity object
+ * @param {object} settings Entity properties (see {@link me.Entity})
+ */
 class DraggableEntity extends Entity {
 
-    /**
-     * Constructor
-     * @name init
-     * @memberOf me.DraggableEntity
-     * @function
-     * @param {Number} x the x postion of the entity
-     * @param {Number} y the y postion of the entity
-     * @param {Object} settings the additional entity settings
-     */
     constructor(x, y, settings) {
         super(x, y, settings);
         this.dragging = false;
@@ -41,7 +32,7 @@ class DraggableEntity extends Entity {
      * this module testable. Then we subscribe this module to the
      * transformed events.
      * @name initEvents
-     * @memberOf me.DraggableEntity
+     * @memberof me.DraggableEntity
      * @function
      */
     initEvents() {
@@ -68,10 +59,10 @@ class DraggableEntity extends Entity {
     /**
      * Translates a pointer event to a me.event
      * @name translatePointerEvent
-     * @memberOf me.DraggableEntity
+     * @memberof me.DraggableEntity
      * @function
-     * @param {Object} e the pointer event you want to translate
-     * @param {String} translation the me.event you want to translate the event to
+     * @param {object} e the pointer event you want to translate
+     * @param {string} translation the me.event you want to translate the event to
      */
     translatePointerEvent(e, translation) {
         event.emit(translation, e);
@@ -80,9 +71,10 @@ class DraggableEntity extends Entity {
     /**
      * Gets called when the user starts dragging the entity
      * @name dragStart
-     * @memberOf me.DraggableEntity
+     * @memberof me.DraggableEntity
      * @function
-     * @param {Object} x the pointer event
+     * @param {object} e the pointer event
+     * @returns {boolean} false if the object is being dragged
      */
     dragStart(e) {
         if (this.dragging === false) {
@@ -96,9 +88,9 @@ class DraggableEntity extends Entity {
     /**
      * Gets called when the user drags this entity around
      * @name dragMove
-     * @memberOf me.DraggableEntity
+     * @memberof me.DraggableEntity
      * @function
-     * @param {Object} x the pointer event
+     * @param {object} e the pointer event
      */
     dragMove(e) {
         if (this.dragging === true) {
@@ -110,9 +102,9 @@ class DraggableEntity extends Entity {
     /**
      * Gets called when the user stops dragging the entity
      * @name dragEnd
-     * @memberOf me.DraggableEntity
+     * @memberof me.DraggableEntity
      * @function
-     * @param {Object} x the pointer event
+     * @returns {boolean} false if the object stopped being dragged
      */
     dragEnd() {
         if (this.dragging === true) {
@@ -124,7 +116,7 @@ class DraggableEntity extends Entity {
     /**
      * Destructor
      * @name destroy
-     * @memberOf me.DraggableEntity
+     * @memberof me.DraggableEntity
      * @function
      */
     destroy() {

package/src/entity/droptarget.js

@@ -2,53 +2,45 @@ import * as event from "./../system/event.js";
 import Entity from "./entity.js";
 
 /**
-* Used to make a game entity a droptarget
-* @class
-* @extends me.Entity
-* @memberOf me
-* @constructor
-* @param {Number} x the x coordinates of the entity object
-* @param {Number} y the y coordinates of the entity object
-* @param {Object} settings Entity properties (see {@link me.Entity})
-*/
+ * @classdesc
+ * Used to make a game entity a droptarget
+ * @class DroptargetEntity
+ * @augments me.Entity
+ * @memberof me
+ * @param {number} x the x coordinates of the entity object
+ * @param {number} y the y coordinates of the entity object
+ * @param {object} settings Entity properties (see {@link me.Entity})
+ */
 
 class DroptargetEntity extends Entity {
-    /**
-     * Constructor
-     * @name init
-     * @memberOf me.DroptargetEntity
-     * @function
-     * @param {Number} x the x postion of the entity
-     * @param {Number} y the y postion of the entity
-     * @param {Object} settings the additional entity settings
-     */
+
     constructor(x, y, settings) {
         super(x, y, settings);
         /**
          * constant for the overlaps method
          * @public
          * @constant
-         * @type String
+         * @type {string}
          * @name CHECKMETHOD_OVERLAP
-         * @memberOf me.DroptargetEntity
+         * @memberof me.DroptargetEntity
          */
         this.CHECKMETHOD_OVERLAP = "overlaps";
         /**
          * constant for the contains method
          * @public
          * @constant
-         * @type String
+         * @type {string}
          * @name CHECKMETHOD_CONTAINS
-         * @memberOf me.DroptargetEntity
+         * @memberof me.DroptargetEntity
          */
         this.CHECKMETHOD_CONTAINS = "contains";
         /**
          * the checkmethod we want to use
          * @public
          * @constant
-         * @type String
+         * @type {string}
          * @name checkMethod
-         * @memberOf me.DroptargetEntity
+         * @memberof me.DroptargetEntity
          */
         this.checkMethod = null;
         event.on(event.DRAGEND, this.checkOnMe, this);
@@ -58,9 +50,9 @@ class DroptargetEntity extends Entity {
     /**
      * Sets the collision method which is going to be used to check a valid drop
      * @name setCheckMethod
-     * @memberOf me.DroptargetEntity
+     * @memberof me.DroptargetEntity
      * @function
-     * @param {Constant} checkMethod the checkmethod (defaults to CHECKMETHOD_OVERLAP)
+     * @param {string} checkMethod the checkmethod (defaults to CHECKMETHOD_OVERLAP)
      */
     setCheckMethod(checkMethod) {
         //  We can improve this check,
@@ -73,9 +65,10 @@ class DroptargetEntity extends Entity {
     /**
      * Checks if a dropped entity is dropped on the current entity
      * @name checkOnMe
-     * @memberOf me.DroptargetEntity
+     * @memberof me.DroptargetEntity
      * @function
-     * @param {Object} draggableEntity the draggable entity that is dropped
+     * @param {object} e the triggering event
+     * @param {object} draggableEntity the draggable entity that is dropped
      */
     checkOnMe(e, draggableEntity) {
         if (draggableEntity && this.checkMethod(draggableEntity.getBounds())) {
@@ -87,9 +80,9 @@ class DroptargetEntity extends Entity {
     /**
      * Gets called when a draggable entity is dropped on the current entity
      * @name drop
-     * @memberOf me.DroptargetEntity
+     * @memberof me.DroptargetEntity
      * @function
-     * @param {Object} draggableEntity the draggable entity that is dropped
+     * @param {object} draggableEntity the draggable entity that is dropped
      */
     drop() {
 
@@ -98,7 +91,7 @@ class DroptargetEntity extends Entity {
     /**
      * Destructor
      * @name destroy
-     * @memberOf me.DroptargetEntity
+     * @memberof me.DroptargetEntity
      * @function
      */
     destroy() {

package/src/entity/entity.js

@@ -2,30 +2,30 @@ import Vector2d from "./../math/vector2.js";
 import Renderable from "./../renderable/renderable.js";
 import Sprite from "./../renderable/sprite.js";
 import Body from "./../physics/body.js";
-import Polygon from "./../shapes/poly.js";
+import Polygon from "./../geometries/poly.js";
 
 
 /**
+ * @classdesc
  * a Generic Object Entity
  * @class Entity
- * @extends me.Renderable
- * @memberOf me
+ * @augments me.Renderable
+ * @memberof me
  * @see me.Renderable
- * @constructor
- * @param {Number} x the x coordinates of the entity object
- * @param {Number} y the y coordinates of the entity object
- * @param {Object} settings Entity properties, to be defined through Tiled or when calling the entity constructor
+ * @param {number} x the x coordinates of the entity object
+ * @param {number} y the y coordinates of the entity object
+ * @param {object} settings Entity properties, to be defined through Tiled or when calling the entity constructor
  * <img src="images/object_properties.png"/>
- * @param {Number} settings.width the physical width the entity takes up in game
- * @param {Number} settings.height the physical height the entity takes up in game
- * @param {String} [settings.name] object entity name
- * @param {String} [settings.id] object unique IDs
- * @param {Image|String} [settings.image] resource name of a spritesheet to use for the entity renderable component
+ * @param {number} settings.width the physical width the entity takes up in game
+ * @param {number} settings.height the physical height the entity takes up in game
+ * @param {string} [settings.name] object entity name
+ * @param {string} [settings.id] object unique IDs
+ * @param {Image|string} [settings.image] resource name of a spritesheet to use for the entity renderable component
  * @param {me.Vector2d} [settings.anchorPoint=0.0] Entity anchor point
- * @param {Number} [settings.framewidth=settings.width] width of a single frame in the given spritesheet
- * @param {Number} [settings.frameheight=settings.width] height of a single frame in the given spritesheet
- * @param {String} [settings.type] object type
- * @param {Number} [settings.collisionMask] Mask collision detection for this object
+ * @param {number} [settings.framewidth=settings.width] width of a single frame in the given spritesheet
+ * @param {number} [settings.frameheight=settings.width] height of a single frame in the given spritesheet
+ * @param {string} [settings.type] object type
+ * @param {number} [settings.collisionMask] Mask collision detection for this object
  * @param {me.Rect[]|me.Polygon[]|me.Line[]|me.Ellipse[]} [settings.shapes] the initial list of collision shapes (usually populated through Tiled)
  */
 
@@ -74,18 +74,18 @@ class Entity extends Renderable {
         /**
          * object type (as defined in Tiled)
          * @public
-         * @type String
+         * @type {string}
          * @name type
-         * @memberOf me.Entity
+         * @memberof me.Entity
          */
         this.type = settings.type || "";
 
         /**
          * object unique ID (as defined in Tiled)
          * @public
-         * @type Number
+         * @type {number}
          * @name id
-         * @memberOf me.Entity
+         * @memberof me.Entity
          */
         this.id = settings.id || "";
 
@@ -93,18 +93,18 @@ class Entity extends Renderable {
          * dead/living state of the entity<br>
          * default value : true
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name alive
-         * @memberOf me.Entity
+         * @memberof me.Entity
          */
         this.alive = true;
 
         /**
          * the entity body object
          * @public
-         * @type me.Body
+         * @type {me.Body}
          * @name body
-         * @memberOf me.Entity
+         * @memberof me.Entity
          */
         // initialize the default body
         if (typeof settings.shapes === "undefined") {
@@ -134,20 +134,15 @@ class Entity extends Renderable {
     /**
      * The entity renderable component (can be any objects deriving from me.Renderable, like me.Sprite for example)
      * @public
-     * @type me.Renderable
+     * @type {me.Renderable}
      * @name renderable
-     * @memberOf me.Entity
+     * @memberof me.Entity
      */
 
-    /**
-     * @ignore
-     */
     get renderable() {
         return this.children[0];
     }
-    /**
-     * @ignore
-     */
+
     set renderable(value) {
         if (value instanceof Renderable) {
             this.children[0] = value;
@@ -167,10 +162,11 @@ class Entity extends Renderable {
 
     /**
      * update the bounds position when the body is modified
-     * @private
+     * @ignore
      * @name onBodyUpdate
-     * @memberOf me.Entity
+     * @memberof me.Entity
      * @function
+     * @param {me.Body} body the body whose bounds to update
      */
     onBodyUpdate(body) {
         // update the entity bounds to include the body bounds
@@ -204,12 +200,12 @@ class Entity extends Renderable {
      * not to be called by the end user<br>
      * called by the game manager on each game loop
      * @name draw
-     * @memberOf me.Entity
+     * @memberof me.Entity
      * @function
      * @protected
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
-     * @param {me.Rect} region to draw
-     **/
+     * @param {me.Rect} rect region to draw
+     */
     draw(renderer, rect) {
         var renderable = this.renderable;
         if (renderable instanceof Renderable) {
@@ -243,7 +239,7 @@ class Entity extends Renderable {
      * onDeactivateEvent Notification function<br>
      * Called by engine before deleting the object
      * @name onDeactivateEvent
-     * @memberOf me.Entity
+     * @memberof me.Entity
      * @function
      */
     onDeactivateEvent() {

package/src/game.js

@@ -9,7 +9,7 @@ import World from "./physics/world.js";
  * tilemap layers, current viewport, collision map, etc...<br>
  * me.game is also responsible for updating (each frame) the object status and draw them.
  * @namespace me.game
- * @memberOf me
+ * @memberof me
  */
 
 // to know when we have to refresh the display
@@ -49,7 +49,7 @@ event.on(event.BOOT, () => {
  * @public
  * @type {me.Camera2d}
  * @name viewport
- * @memberOf me.game
+ * @memberof me.game
  */
 export let viewport;
 
@@ -59,7 +59,7 @@ export let viewport;
  * @public
  * @type {me.World}
  * @name world
- * @memberOf me.game
+ * @memberof me.game
  */
 export let world;
 
@@ -70,7 +70,7 @@ export let world;
  * @type {boolean}
  * @default true
  * @name mergeGroup
- * @memberOf me.game
+ * @memberof me.game
  */
 export let mergeGroup = true;
 
@@ -81,7 +81,7 @@ export let mergeGroup = true;
  * @type {string}
  * @default "z"
  * @name sortOn
- * @memberOf me.game
+ * @memberof me.game
  */
 export let sortOn = "z";
 
@@ -93,7 +93,7 @@ export let sortOn = "z";
  * @public
  * @type {DOMHighResTimeStamp}
  * @name lastUpdate
- * @memberOf me.game
+ * @memberof me.game
  */
 export let lastUpdate = window.performance.now();
 
@@ -151,7 +151,7 @@ export function updateFrameRate() {
  * Returns the parent container of the specified Child in the game world
  * @function me.game.getParentContainer
  * @param {me.Renderable} child
- * @return {me.Container}
+ * @returns {me.Container}
  */
 export function getParentContainer(child) {
     return child.ancestor;
@@ -170,7 +170,7 @@ export function repaint() {
  * update all objects of the game manager
  * @ignore
  * @function me.game.update
- * @param {Number} time current timestamp as provided by the RAF callback
+ * @param {number} time current timestamp as provided by the RAF callback
  * @param {me.Stage} stage the current stage
  */
 export function update(time, stage) {

package/src/{shapes → geometries}/ellipse.js

@@ -5,13 +5,12 @@ import pool from "./../system/pooling.js";
  * @classdesc
  * an ellipse Object
  * @class Ellipse
- * @extends me.Object
- * @memberOf me
- * @constructor
- * @param {Number} x the center x coordinate of the ellipse
- * @param {Number} y the center y coordinate of the ellipse
- * @param {Number} w width (diameter) of the ellipse
- * @param {Number} h height (diameter) of the ellipse
+ * @augments me.Object
+ * @memberof me
+ * @param {number} x the center x coordinate of the ellipse
+ * @param {number} y the center y coordinate of the ellipse
+ * @param {number} w width (diameter) of the ellipse
+ * @param {number} h height (diameter) of the ellipse
  */
 
 class Ellipse {
@@ -22,7 +21,7 @@ class Ellipse {
          * @public
          * @type {me.Vector2d}
          * @name pos
-         * @memberOf me.Ellipse#
+         * @memberof me.Ellipse#
          */
         this.pos = new Vector2d();
 
@@ -31,16 +30,16 @@ class Ellipse {
          * @private
          * @type {me.Bounds}
          * @name _bounds
-         * @memberOf me.Ellipse#
+         * @memberof me.Ellipse#
          */
         this._bounds = undefined;
 
         /**
          * Maximum radius of the ellipse
          * @public
-         * @type {Number}
+         * @type {number}
          * @name radius
-         * @memberOf me.Ellipse
+         * @memberof me.Ellipse
          */
         this.radius = NaN;
 
@@ -49,7 +48,7 @@ class Ellipse {
          * @public
          * @type {me.Vector2d}
          * @name radiusV
-         * @memberOf me.Ellipse#
+         * @memberof me.Ellipse#
          */
         this.radiusV = new Vector2d();
 
@@ -58,7 +57,7 @@ class Ellipse {
          * @public
          * @type {me.Vector2d}
          * @name radiusSq
-         * @memberOf me.Ellipse#
+         * @memberof me.Ellipse#
          */
         this.radiusSq = new Vector2d();
 
@@ -67,7 +66,7 @@ class Ellipse {
          * @public
          * @type {me.Vector2d}
          * @name ratio
-         * @memberOf me.Ellipse#
+         * @memberof me.Ellipse#
          */
         this.ratio = new Vector2d();
 
@@ -84,12 +83,13 @@ class Ellipse {
     /**
      * set new value to the Ellipse shape
      * @name setShape
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
-     * @param {Number} x the center x coordinate of the ellipse
-     * @param {Number} y the center y coordinate of the ellipse
-     * @param {Number} w width (diameter) of the ellipse
-     * @param {Number} h height (diameter) of the ellipse
+     * @param {number} x the center x coordinate of the ellipse
+     * @param {number} y the center y coordinate of the ellipse
+     * @param {number} w width (diameter) of the ellipse
+     * @param {number} h height (diameter) of the ellipse
+     * @returns {me.Ellipse} this instance for objecf chaining
      */
     setShape(x, y, w, h) {
         var hW = w / 2;
@@ -113,11 +113,11 @@ class Ellipse {
     /**
      * Rotate this Ellipse (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
-     * @param {Number} angle The angle to rotate (in radians)
+     * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
-     * @return {me.Ellipse} Reference to this object for method chaining
+     * @returns {me.Ellipse} Reference to this object for method chaining
      */
     rotate(angle, v) {
         // TODO : only works for circle
@@ -130,11 +130,11 @@ class Ellipse {
     /**
      * Scale this Ellipse by the specified scalar.
      * @name scale
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
-     * @param {Number} x
-     * @param {Number} [y=x]
-     * @return {me.Ellipse} Reference to this object for method chaining
+     * @param {number} x
+     * @param {number} [y=x]
+     * @returns {me.Ellipse} Reference to this object for method chaining
      */
     scale(x, y) {
         y = typeof (y) !== "undefined" ? y : x;
@@ -149,10 +149,10 @@ class Ellipse {
     /**
      * Scale this Ellipse by the specified vector.
      * @name scale
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @param {me.Vector2d} v
-     * @return {me.Ellipse} Reference to this object for method chaining
+     * @returns {me.Ellipse} Reference to this object for method chaining
      */
     scaleV(v) {
         return this.scale(v.x, v.y);
@@ -161,10 +161,10 @@ class Ellipse {
     /**
      * apply the given transformation matrix to this ellipse
      * @name transform
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @param {me.Matrix2d} matrix the transformation matrix
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     transform(/* m */) {
         // TODO
@@ -174,19 +174,19 @@ class Ellipse {
     /**
      * translate the circle/ellipse by the specified offset
      * @name translate
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
-     * @param {Number} x x offset
-     * @param {Number} y y offset
-     * @return {me.Ellipse} this ellipse
+     * @param {number} x x offset
+     * @param {number} y y offset
+     * @returns {me.Ellipse} this ellipse
      */
     /**
      * translate the circle/ellipse by the specified vector
      * @name translate
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @param {me.Vector2d} v vector offset
-     * @return {me.Ellipse} this ellipse
+     * @returns {me.Ellipse} this ellipse
      */
     translate() {
         var _x, _y;
@@ -211,20 +211,20 @@ class Ellipse {
     /**
      * check if this circle/ellipse contains the specified point
      * @name contains
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @param  {me.Vector2d} point
-     * @return {boolean} true if contains
+     * @returns {boolean} true if contains
      */
 
     /**
      * check if this circle/ellipse contains the specified point
      * @name contains
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
-     * @param  {Number} x x coordinate
-     * @param  {Number} y y coordinate
-     * @return {boolean} true if contains
+     * @param  {number} x x coordinate
+     * @param  {number} y y coordinate
+     * @returns {boolean} true if contains
      */
     contains() {
         var _x, _y;
@@ -252,9 +252,9 @@ class Ellipse {
     /**
      * returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
      * @name getBounds
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
-     * @return {me.Bounds} this shape bounding box Rectangle object
+     * @returns {me.Bounds} this shape bounding box Rectangle object
      */
     getBounds() {
         if (typeof this._bounds === "undefined") {
@@ -266,9 +266,9 @@ class Ellipse {
     /**
      * clone this Ellipse
      * @name clone
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
-     * @return {me.Ellipse} new Ellipse
+     * @returns {me.Ellipse} new Ellipse
      */
     clone() {
         return new Ellipse(