melonjs 10.3.0 → 10.4.0

package/src/physics/world.js

@@ -9,20 +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
- * @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
+ * @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);
 
@@ -36,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);
 
@@ -64,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}
          */
@@ -80,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);
 
@@ -99,7 +95,7 @@ class World extends Container {
     /**
      * reset the game world
      * @name reset
-     * @memberof me.World
+     * @memberof World
      * @function
      */
     reset() {
@@ -120,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
@@ -135,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
@@ -150,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,25 +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
-     * @augments me.Object
-     * @name plugin.Base
-     * @memberof me
+     * @name Base
+     * @memberof plugin
      */
     Base : BasePlugin,
 
     /**
      * patch a melonJS function
      * @name patch
-     * @memberof me.plugin
+     * @memberof plugin
      * @public
      * @function
      * @param {object} proto target object
@@ -65,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];
@@ -90,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,43 +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
- * @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) {
- *       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) {
 
@@ -57,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;
 
@@ -65,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;
 
@@ -74,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;
 
@@ -83,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;
 
@@ -121,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 */) {
@@ -144,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 */) {}
 
@@ -165,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 */) {
 
@@ -190,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
@@ -215,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

@@ -6,17 +6,13 @@ import collision from "./../physics/collision.js";
 /**
  * @classdesc
  * a basic collectable helper class for immovable object (e.g. a coin)
- * @class Collectable
- * @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}
+ * @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,17 +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
- * @augments me.Renderable
- * @memberof me
- * @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
@@ -25,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);