melonjs 15.1.5 → 15.2.0

package/src/index.js

@@ -42,7 +42,8 @@ import Light2d from "./renderable/light2d.js";
 import Text from "./text/text.js";
 import BitmapText from "./text/bitmaptext.js";
 import BitmapTextData from "./text/bitmaptextdata.js";
-import { Draggable, DropTarget } from "./renderable/dragndrop.js";
+import { Draggable } from "./renderable/draggable.js";
+import { DropTarget } from "./renderable/dragndrop.js";
 import TMXRenderer from "./level/tiled/renderer/TMXRenderer.js";
 import TMXOrthogonalRenderer from "./level/tiled/renderer/TMXOrthogonalRenderer.js";
 import TMXIsometricRenderer from "./level/tiled/renderer/TMXIsometricRenderer.js";
@@ -71,9 +72,10 @@ import * as event from "./system/event.js";
 import * as device from "./system/device.js";
 import * as loader from "./loader/loader.js";
 import * as Math from "./math/math.js";
-import utils from "./utils/utils.js";
+import * as utils from "./utils/utils.js";
 import * as input from "./input/input.js";
-import { plugin, plugins } from "./plugin/plugin.js";
+import * as plugin from "./plugin/plugin.js";
+import { cache as plugins } from "./plugin/plugin.js";
 import * as video from "./video/video.js";
 import save from "./system/save.js";
 import timer from "./system/timer.js";

package/src/lang/deprecated.js

@@ -1,6 +1,7 @@
 import { TextureAtlas } from "./../video/texture/atlas.js";
 import Renderer from "./../video/renderer.js";
-import { Draggable, DropTarget } from "./../renderable/dragndrop.js";
+import { Draggable } from "./../renderable/draggable.js";
+import { DropTarget } from "./../renderable/dragndrop.js";
 import UISpriteElement from "./../renderable/ui/uispriteelement.js";
 import { warning } from "./console.js";
 

package/src/level/level.js

@@ -1,4 +1,5 @@
-import utils from "./../utils/utils.js";
+import { resetGUID } from "./../utils/utils.js";
+import { defer } from "../utils/function.js";
 import * as event from "./../system/event.js";
 import state from "./../state/state.js";
 import { getTMX } from "./../loader/loader.js";
@@ -62,7 +63,7 @@ function loadTMXLevel(levelId, container, flatten, setViewportBounds) {
 
     // reset the GUID generator
     // and pass the level id as parameter
-    utils.resetGUID(levelId, level.nextobjectid);
+    resetGUID(levelId, level.nextobjectid);
 
     // Tiled use 0,0 anchor coordinates
     container.anchorPoint.set(0, 0);
@@ -178,7 +179,7 @@ let level = {
                 // some silly side effects
                 state.stop();
 
-                utils.function.defer(safeLoadLevel, this, levelId, options, true);
+                defer(safeLoadLevel, this, levelId, options, true);
             }
             else {
                 safeLoadLevel(levelId, options);

package/src/level/tiled/TMXTileMap.js

@@ -1,7 +1,7 @@
 import pool from "./../../system/pooling.js";
 import * as event from "./../../system/event.js";
 import { game } from "../../index.js";
-import utils from "./../../utils/utils.js";
+import { checkVersion } from "./../../utils/utils.js";
 import collision from "./../../physics/collision.js";
 import Body from "./../../physics/body.js";
 import TMXTileset from "./TMXTileset.js";
@@ -198,7 +198,7 @@ function readObjectGroup(map, data, z) {
         // if version is undefined or empty it usually means the map was not created with Tiled
         if (this.version !== "undefined" && this.version !== "") {
             // deprecation warning if map tiled version is older than 1.5
-            if (utils.checkVersion(this.version, "1.5") < 0) {
+            if (checkVersion(this.version, "1.5") < 0) {
                 warning("("+this.name+") Tiled Map format version 1.4 and below", "format 1.5 or higher", "10.4.4");
             }
         }

package/src/level/tiled/TMXUtils.js

@@ -1,4 +1,5 @@
-import utils from "../../utils/utils.js";
+import { isBoolean, isNumeric } from "../../utils/string.js";
+import * as utils from "../../utils/utils.js";
 
 /**
  * set and interpret a TMX property value
@@ -25,11 +26,11 @@ function setTMXValue(name, type, value) {
 
         default :
             // try to parse it anyway
-            if (!value || utils.string.isBoolean(value)) {
+            if (!value || isBoolean(value)) {
                 // if value not defined or boolean
                 value = value ? (value === "true") : true;
             }
-            else if (utils.string.isNumeric(value)) {
+            else if (isNumeric(value)) {
                 // check if numeric
                 value = Number(value);
             }

package/src/physics/body.js

@@ -16,7 +16,7 @@ import Point from "../geometries/point.js";
  */
  export default class Body {
     /**
-     * @param {Renderable} ancestor - the parent object this body is attached to
+     * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} ancestor - the parent object this body is attached to
      * @param {Rect|Rect[]|Polygon|Polygon[]|Line|Line[]|Ellipse|Ellipse[]|Point|Point[]|Bounds|Bounds[]|object} [shapes] - a initial shape, list of shapes, or JSON object defining the body
      * @param {Function} [onBodyUpdate] - callback for when the body is updated (e.g. add/remove shapes)
      */
@@ -26,7 +26,7 @@ import Point from "../geometries/point.js";
          * a reference to the parent object that contains this body,
          * or undefined if it has not been added to one.
          * @public
-         * @type {Renderable}
+         * @type {Renderable|Container|Entity|Sprite|NineSliceSprite}
          * @default undefined
          */
         this.ancestor = ancestor;

package/src/physics/detector.js

@@ -40,8 +40,8 @@ export default class Detector {
     /**
      * determine if two objects should collide (based on both respective objects body collision mask and type).<br>
      * you can redefine this function if you need any specific rules over what should collide with what.
-     * @param {Renderable} a - a reference to the object A.
-     * @param {Renderable} b - a reference to the object B.
+     * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} a - a reference to the object A.
+     * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} b - a reference to the object B.
      * @returns {boolean} true if they should collide, false otherwise
      */
     shouldCollide(a, b) {
@@ -94,7 +94,7 @@ export default class Detector {
     /**
      * find all the collisions for the specified object using a broadphase algorithm
      * @ignore
-     * @param {Renderable} objA - object to be tested for collision
+     * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} objA - object to be tested for collision
      * @returns {boolean} in case of collision, false otherwise
      */
     collisions(objA) {

package/src/physics/sat.js

@@ -187,9 +187,9 @@ function vornoiRegion(line, point) {
 /**
  * Checks whether polygons collide.
  * @ignore
- * @param {Renderable} a - a reference to the object A.
+ * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} a - a reference to the object A.
  * @param {Polygon} polyA - a reference to the object A Polygon to be tested
- * @param {Renderable} b - a reference to the object B.
+ * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} b - a reference to the object B.
  * @param {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.
  * @returns {boolean} true if they intersect, false if they don't.
@@ -241,9 +241,9 @@ export function testPolygonPolygon(a, polyA, b, polyB, response) {
 /**
  * Check if two Ellipse collide.
  * @ignore
- * @param {Renderable} a - a reference to the object A.
+ * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} a - a reference to the object A.
  * @param {Ellipse} ellipseA - a reference to the object A Ellipse to be tested
- * @param {Renderable} b - a reference to the object B.
+ * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} b - a reference to the object B.
  * @param {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.
@@ -282,9 +282,9 @@ export function testEllipseEllipse(a, ellipseA, b, ellipseB, response) {
 /**
  * Check if a polygon and an ellipse collide.
  * @ignore
- * @param {Renderable} a - a reference to the object A.
+ * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} a - a reference to the object A.
  * @param {Polygon} polyA - a reference to the object A Polygon to be tested
- * @param {Renderable} b - a reference to the object B.
+ * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} b - a reference to the object B.
  * @param {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.
  * @returns {boolean} true if they intersect, false if they don't.
@@ -448,9 +448,9 @@ export function testPolygonEllipse(a, polyA, b, ellipseB, response) {
  * **NOTE:** This is slightly less efficient than testPolygonEllipse as it just
  * runs testPolygonEllipse and reverses the response at the end.
  * @ignore
- * @param {Renderable} a - a reference to the object A.
+ * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} a - a reference to the object A.
  * @param {Ellipse} ellipseA - a reference to the object A Ellipse to be tested
- * @param {Renderable} b - a reference to the object B.
+ * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} b - a reference to the object B.
  * @param {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.

package/src/plugin/plugin.js

@@ -1,132 +1,130 @@
-import utils from "./../utils/utils.js";
+import { checkVersion } from "./../utils/utils.js";
 import { version } from "./../index.js";
 
 /**
- * This namespace is a container for all registered plugins.
- * @see plugin.register
- * @namespace plugins
+ * Contains all registered plugins.
+ * @name cache
+ * @memberof plugin
  */
-export let plugins = {};
+export let cache = {};
 
+/**
+ * @namespace plugin
+ */
 
-class BasePlugin {
+/**
+ * a base Object class for plugin
+ * (plugin must be installed using the register function)
+ * @class
+ * @name BasePlugin
+ * @memberof plugin
+ */
+export class BasePlugin {
 
     constructor() {
         /**
          * define the minimum required version of melonJS<br>
          * this can be overridden by the plugin
-         * @public
          * @type {string}
          * @default "__VERSION__"
-         * @name plugin.Base#version
          */
         this.version = "__VERSION__";
     }
 }
 
+
 /**
- * @namespace plugin
+ * @class
+ * @name Base
+ * @memberof plugin
+ * @deprecated since 15.1.6, see {@link plugin.BasePlugin}
  */
-export let plugin = {
-
-    /**
-     * a base Object for plugin <br>
-     * plugin must be installed using the register function
-     * @see plugin
-     * @class
-     * @name Base
-     * @memberof plugin
-     */
-    Base : BasePlugin,
-
-    /**
-     * patch a melonJS function
-     * @name patch
-     * @memberof plugin
-     * @public
-     * @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
-     * me.plugin.patch(me.game, "update", function () {
-     *   // display something in the console
-     *   console.log("duh");
-     *   // call the original me.game.update function
-     *   this._patched();
-     * });
-     */
-    patch : function (proto, name, fn) {
-        // use the object prototype if possible
-        if (typeof proto.prototype !== "undefined") {
-            proto = proto.prototype;
-        }
-        // reuse the logic behind object extends
-        if (typeof(proto[name]) === "function") {
-            // save the original function
-            let _parent = proto[name];
-            // override the function with the new one
-            Object.defineProperty(proto, name, {
-                "configurable" : true,
-                "value" : (function (name, fn) {
-                    return function () {
-                        this._patched = _parent;
-                        let ret = fn.apply(this, arguments);
-                        this._patched = null;
-                        return ret;
-                    };
-                })(name, fn)
-            });
-        }
-        else {
-            throw new Error(name + " is not an existing function");
-        }
-    },
+export class Base extends BasePlugin {}
 
-    /**
-     * Register a plugin.
-     * @name register
-     * @memberof plugin
-     * @see Base
-     * @public
-     * @param {plugin.Base} pluginObj - Plugin object to instantiate and register
-     * @param {string} [name=pluginObj.constructor.name] - a unique name for this plugin
-     * @param {object} [...arguments] - all extra parameters will be passed to the plugin constructor
-     * @example
-     * // register a new plugin
-     * me.plugin.register(TestPlugin, "testPlugin");
-     * // the plugin then also become available
-     * // under then me.plugins namespace
-     * me.plugins.testPlugin.myfunction ();
-     */
-    register : function (pluginObj, name = pluginObj.toString().match(/ (\w+)/)[1]) {
-        // ensure me.plugins[name] is not already "used"
-        if (plugins[name]) {
-            throw new Error("plugin " + name + " already registered");
-        }
+/**
+ * patch a melonJS function
+ * @name patch
+ * @memberof plugin
+ * @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
+ * me.plugin.patch(me.game, "update", function () {
+ *   // display something in the console
+ *   console.log("duh");
+ *   // call the original me.game.update function
+ *   this._patched();
+ * });
+ */
+export function patch(proto, name, fn) {
+    // use the object prototype if possible
+    if (typeof proto.prototype !== "undefined") {
+        proto = proto.prototype;
+    }
+    // reuse the logic behind object extends
+    if (typeof(proto[name]) === "function") {
+        // save the original function
+        let _parent = proto[name];
+        // override the function with the new one
+        Object.defineProperty(proto, name, {
+            "configurable" : true,
+            "value" : (function (name, fn) {
+                return function () {
+                    this._patched = _parent;
+                    let ret = fn.apply(this, arguments);
+                    this._patched = null;
+                    return ret;
+                };
+            })(name, fn)
+        });
+    }
+    else {
+        throw new Error(name + " is not an existing function");
+    }
+}
 
-        // get extra arguments
-        let _args = [];
-        if (arguments.length > 2) {
-            // store extra arguments if any
-            _args = Array.prototype.slice.call(arguments, 1);
-        }
+/**
+ * Register a plugin.
+ * @name register
+ * @memberof plugin
+ * @param {plugin.BasePlugin} plugin - Plugin object to instantiate and register
+ * @param {string} [name=plugin.constructor.name] - a unique name for this plugin
+ * @param {object} [...arguments] - all extra parameters will be passed to the plugin constructor
+ * @example
+ * // register a new plugin
+ * me.plugin.register(TestPlugin, "testPlugin");
+ * // the plugin then also become available
+ * // under then me.plugins namespace
+ * me.plugins.testPlugin.myfunction ();
+ */
+export function register(plugin, name = plugin.toString().match(/ (\w+)/)[1]) {
+    // ensure me.plugins[name] is not already "used"
+    if (cache[name]) {
+        throw new Error("plugin " + name + " already registered");
+    }
 
-        // try to instantiate the plugin
-        _args[0] = pluginObj;
-        let instance = new (pluginObj.bind.apply(pluginObj, _args))();
+    // get extra arguments
+    let _args = [];
+    if (arguments.length > 2) {
+        // store extra arguments if any
+        _args = Array.prototype.slice.call(arguments, 1);
+    }
 
-        // inheritance check
-        if (typeof instance === "undefined" || !(instance instanceof plugin.Base)) {
-            throw new Error("Plugin should extend the me.plugin.Base Class !");
-        }
+    // try to instantiate the plugin
+    _args[0] = plugin;
+    let instance = new (plugin.bind.apply(plugin, _args))();
 
-        // compatibility testing
-        if (utils.checkVersion(instance.version, version) > 0) {
-            throw new Error("Plugin version mismatch, expected: " + instance.version + ", got: " + version);
-        }
+    // inheritance check
+    if (typeof instance === "undefined" || !(instance instanceof BasePlugin)) {
+        throw new Error("Plugin should extend the BasePlugin Class !");
+    }
 
-        // create a reference to the new plugin
-        plugins[name] = instance;
+    // compatibility testing
+    if (checkVersion(instance.version, version) > 0) {
+        throw new Error("Plugin version mismatch, expected: " + instance.version + ", got: " + version);
     }
-};
+
+    // create a reference to the new plugin
+    cache[name] = instance;
+}

package/src/renderable/container.js

@@ -1,5 +1,6 @@
 import Renderable from "./renderable";
-import utils from "../utils/utils.js";
+import { createGUID } from "../utils/utils";
+import { defer } from "../utils/function";
 import { game } from "../index.js";
 import * as event from "../system/event.js";
 import pool from "../system/pooling.js";
@@ -176,7 +177,7 @@ let globalFloatingCounter = 0;
      * will not be in any container. <br>
      * if the given child implements a onActivateEvent method, that method will be called
      * once the child is added to this container.
-     * @param {Renderable} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
      * @param {number} [z] - forces the z index of the child to the specified value
      * @returns {Renderable} the added child
      */
@@ -189,7 +190,7 @@ let globalFloatingCounter = 0;
             // (e.g. move one child from one container to another)
             if (child.isRenderable) {
                 // allocated a GUID value (use child.id as based index if defined)
-                child.GUID = utils.createGUID(child.id);
+                child.GUID = createGUID(child.id);
             }
         }
 
@@ -258,7 +259,7 @@ let globalFloatingCounter = 0;
     /**
      * Add a child to the container at the specified index<br>
      * (the list won't be sorted after insertion)
-     * @param {Renderable} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
      * @param {number} index
      * @returns {Renderable} the added child
      */
@@ -272,7 +273,7 @@ let globalFloatingCounter = 0;
                 // (e.g. move one child from one container to another)
                 if (child.isRenderable) {
                     // allocated a GUID value
-                    child.GUID = utils.createGUID();
+                    child.GUID = createGUID();
                 }
             }
 
@@ -369,8 +370,8 @@ let globalFloatingCounter = 0;
 
     /**
      * Swaps the position (z-index) of 2 children
-     * @param {Renderable} child
-     * @param {Renderable} child2
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child2
      */
     swapChildren(child, child2) {
         let index = this.getChildIndex(child);
@@ -408,7 +409,7 @@ let globalFloatingCounter = 0;
 
     /**
      * Returns the index of the given Child
-     * @param {Renderable} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
      * @returns {number} index
      */
     getChildIndex(child) {
@@ -417,7 +418,7 @@ let globalFloatingCounter = 0;
 
     /**
      * Returns the next child within the container or undefined if none
-     * @param {Renderable} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
      * @returns {Renderable} child
      */
     getNextChild(child) {
@@ -430,7 +431,7 @@ let globalFloatingCounter = 0;
 
     /**
      * Returns true if contains the specified Child
-     * @param {Renderable} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
      * @returns {boolean}
      */
     hasChild(child) {
@@ -638,12 +639,12 @@ let globalFloatingCounter = 0;
     /**
      * Invokes the removeChildNow in a defer, to ensure the child is removed safely after the update & draw stack has completed. <br>
      * if the given child implements a onDeactivateEvent() method, that method will be called once the child is removed from this container.
-     * @param {Renderable} child
+     * @param {RendRenderable|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapTexterable} child
      * @param {boolean} [keepalive=false] - true to prevent calling child.destroy()
      */
     removeChild(child, keepalive) {
         if (this.hasChild(child)) {
-            utils.function.defer(deferredRemove, this, child, keepalive);
+            defer(deferredRemove, this, child, keepalive);
         }
         else {
             throw new Error("Child is not mine.");
@@ -654,7 +655,7 @@ let globalFloatingCounter = 0;
      * Removes (and optionally destroys) a child from the container.<br>
      * (removal is immediate and unconditional)<br>
      * Never use keepalive=true with objects from {@link pool}. Doing so will create a memory leak.
-     * @param {Renderable} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
      * @param {boolean} [keepalive=False] - True to prevent calling child.destroy()
      */
     removeChildNow(child, keepalive) {
@@ -717,7 +718,7 @@ let globalFloatingCounter = 0;
 
     /**
      * Move the child in the group one step forward (z depth).
-     * @param {Renderable} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
      */
     moveUp(child) {
         let childIndex = this.getChildIndex(child);
@@ -731,7 +732,7 @@ let globalFloatingCounter = 0;
 
     /**
      * Move the child in the group one step backward (z depth).
-     * @param {Renderable} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
      */
     moveDown(child) {
         let childIndex = this.getChildIndex(child);
@@ -745,7 +746,7 @@ let globalFloatingCounter = 0;
 
     /**
      * Move the specified child to the top(z depth).
-     * @param {Renderable} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
      */
     moveToTop(child) {
         let childIndex = this.getChildIndex(child);
@@ -762,7 +763,7 @@ let globalFloatingCounter = 0;
 
     /**
      * Move the specified child the bottom (z depth).
-     * @param {Renderable} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
      */
     moveToBottom(child) {
         let childIndex = this.getChildIndex(child);
@@ -794,7 +795,7 @@ let globalFloatingCounter = 0;
                 });
             }
             /** @ignore */
-            this.pendingSort = utils.function.defer(function () {
+            this.pendingSort = defer(function () {
                 // sort everything in this container
                 this.getChildren().sort(this["_sort" + this.sortOn.toUpperCase()]);
                 // clear the defer id