melonjs 15.1.5 → 15.2.0

package/src/renderable/draggable.js

@@ -0,0 +1,114 @@
+import Vector2d from "./../math/vector2.js";
+import * as input from "./../input/input.js";
+import * as event from "./../system/event.js";
+import Renderable from "./../renderable/renderable.js";
+
+/**
+ * @classdesc
+ * A Draggable base object
+ * @see DropTarget
+ * @augments Renderable
+ */
+export class Draggable extends Renderable {
+    /**
+     * @param {number} x - the x coordinates of the draggable object
+     * @param {number} y - the y coordinates of the draggable object
+     * @param {number} width - draggable object width
+     * @param {number} height - draggable object height
+     */
+    constructor(x, y, width, height) {
+        super(x, y, width, height);
+        this.isKinematic = false;
+        this.dragging = false;
+        this.dragId = null;
+        this.grabOffset = new Vector2d(0, 0);
+        this.initEvents();
+    }
+
+    /**
+     * Initializes the events the modules needs to listen to
+     * It translates the pointer events to me.events
+     * in order to make them pass through the system and to make
+     * this module testable. Then we subscribe this module to the
+     * transformed events.
+     * @name initEvents
+     * @memberof Draggable
+     * @private
+     */
+    initEvents() {
+        input.registerPointerEvent("pointerdown", this, (e) => event.emit(event.DRAGSTART, e, this));
+        input.registerPointerEvent("pointerup", this,  (e) => event.emit(event.DRAGEND, e, this));
+        input.registerPointerEvent("pointercancel", this, (e) => event.emit(event.DRAGEND, e, this));
+        event.on(event.POINTERMOVE, (e) => this.dragMove(e));
+        event.on(event.DRAGSTART, (e, draggable) => {
+            if (draggable === this) {
+                this.dragStart(e);
+            }
+        });
+        event.on(event.DRAGEND, (e, draggable) => {
+            if (draggable === this) {
+                this.dragEnd(e);
+            }
+        });
+    }
+
+    /**
+     * Gets called when the user starts dragging the entity
+     * @name dragStart
+     * @memberof Draggable
+     * @param {object} e - the pointer event
+     * @returns {boolean} false if the object is being dragged
+     */
+    dragStart(e) {
+        if (this.dragging === false) {
+            this.dragging = true;
+            this.grabOffset.set(e.gameX, e.gameY);
+            this.grabOffset.sub(this.pos);
+            return false;
+        }
+    }
+
+    /**
+     * Gets called when the user drags this entity around
+     * @name dragMove
+     * @memberof Draggable
+     * @param {object} e - the pointer event
+     */
+    dragMove(e) {
+        if (this.dragging === true) {
+            this.pos.set(e.gameX, e.gameY, this.pos.z); //TODO : z ?
+            this.pos.sub(this.grabOffset);
+        }
+    }
+
+    /**
+     * Gets called when the user stops dragging the entity
+     * @name dragEnd
+     * @memberof Draggable
+     * @returns {boolean} false if the object stopped being dragged
+     */
+    dragEnd() {
+        if (this.dragging === true) {
+            this.dragging = false;
+            return false;
+        }
+    }
+
+    /**
+     * Destructor
+     * @name destroy
+     * @memberof Draggable
+     * @ignore
+     */
+    destroy() {
+        event.off(event.POINTERMOVE, this.dragMove);
+        event.off(event.DRAGSTART, this.dragStart);
+        event.off(event.DRAGEND, this.dragEnd);
+        input.releasePointerEvent("pointerdown", this);
+        input.releasePointerEvent("pointerup", this);
+        input.releasePointerEvent("pointercancel", this);
+        super.destroy();
+    }
+}
+
+

package/src/renderable/dragndrop.js

@@ -1,115 +1,6 @@
-import Vector2d from "./../math/vector2.js";
-import * as input from "./../input/input.js";
 import * as event from "./../system/event.js";
 import Renderable from "./../renderable/renderable.js";
 
-/**
- * @classdesc
- * A Draggable base object
- * @see DropTarget
- * @augments Renderable
- */
-export class Draggable extends Renderable {
-    /**
-     * @param {number} x - the x coordinates of the draggable object
-     * @param {number} y - the y coordinates of the draggable object
-     * @param {number} width - draggable object width
-     * @param {number} height - draggable object height
-     */
-    constructor(x, y, width, height) {
-        super(x, y, width, height);
-        this.isKinematic = false;
-        this.dragging = false;
-        this.dragId = null;
-        this.grabOffset = new Vector2d(0, 0);
-        this.initEvents();
-    }
-
-    /**
-     * Initializes the events the modules needs to listen to
-     * It translates the pointer events to me.events
-     * in order to make them pass through the system and to make
-     * this module testable. Then we subscribe this module to the
-     * transformed events.
-     * @name initEvents
-     * @memberof Draggable
-     * @private
-     */
-    initEvents() {
-        input.registerPointerEvent("pointerdown", this, (e) => event.emit(event.DRAGSTART, e, this));
-        input.registerPointerEvent("pointerup", this,  (e) => event.emit(event.DRAGEND, e, this));
-        input.registerPointerEvent("pointercancel", this, (e) => event.emit(event.DRAGEND, e, this));
-        event.on(event.POINTERMOVE, (e) => this.dragMove(e));
-        event.on(event.DRAGSTART, (e, draggable) => {
-            if (draggable === this) {
-                this.dragStart(e);
-            }
-        });
-        event.on(event.DRAGEND, (e, draggable) => {
-            if (draggable === this) {
-                this.dragEnd(e);
-            }
-        });
-    }
-
-    /**
-     * Gets called when the user starts dragging the entity
-     * @name dragStart
-     * @memberof Draggable
-     * @param {object} e - the pointer event
-     * @returns {boolean} false if the object is being dragged
-     */
-    dragStart(e) {
-        if (this.dragging === false) {
-            this.dragging = true;
-            this.grabOffset.set(e.gameX, e.gameY);
-            this.grabOffset.sub(this.pos);
-            return false;
-        }
-    }
-
-    /**
-     * Gets called when the user drags this entity around
-     * @name dragMove
-     * @memberof Draggable
-     * @param {object} e - the pointer event
-     */
-    dragMove(e) {
-        if (this.dragging === true) {
-            this.pos.set(e.gameX, e.gameY, this.pos.z); //TODO : z ?
-            this.pos.sub(this.grabOffset);
-        }
-    }
-
-    /**
-     * Gets called when the user stops dragging the entity
-     * @name dragEnd
-     * @memberof Draggable
-     * @returns {boolean} false if the object stopped being dragged
-     */
-    dragEnd() {
-        if (this.dragging === true) {
-            this.dragging = false;
-            return false;
-        }
-    }
-
-    /**
-     * Destructor
-     * @name destroy
-     * @memberof Draggable
-     * @ignore
-     */
-    destroy() {
-        event.off(event.POINTERMOVE, this.dragMove);
-        event.off(event.DRAGSTART, this.dragStart);
-        event.off(event.DRAGEND, this.dragEnd);
-        input.releasePointerEvent("pointerdown", this);
-        input.releasePointerEvent("pointerup", this);
-        input.releasePointerEvent("pointercancel", this);
-        super.destroy();
-    }
-}
 
 /**
  * @classdesc

package/src/renderable/renderable.js

@@ -725,7 +725,7 @@ import Color from "./../math/color.js";
      * onCollision callback, triggered in case of collision,
      * when this renderable body is colliding with another one
      * @param {ResponseObject} response - the collision response object
-     * @param {Renderable} other - the other renderable touching this one (a reference to response.a or response.b)
+     * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} other - the other renderable touching this one (a reference to response.a or response.b)
      * @returns {boolean} true if the object should respond to the collision (its position and velocity will be corrected)
      * @example
      * // colision handler

package/src/renderable/trigger.js

@@ -136,7 +136,7 @@ import pool from "./../system/pooling.js";
      * @name onCollision
      * @memberof Trigger
      * @param {ResponseObject} response - the collision response object
-     * @param {Renderable} other - the other renderable touching this one (a reference to response.a or response.b)
+     * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} other - the other renderable touching this one (a reference to response.a or response.b)
      * @returns {boolean} true if the object should respond to the collision (its position and velocity will be corrected)
      */
     onCollision(response, other) { // eslint-disable-line no-unused-vars

package/src/system/timer.js

@@ -1,4 +1,4 @@
-import utils from "./../utils/utils.js";
+import { defer } from "./../utils/function.js";
 import * as event from "./event.js";
 import state from "./../state/state.js";
 import { clamp } from "./../math/math.js";
@@ -161,7 +161,7 @@ class Timer {
      */
     clearTimeout(timeoutID) {
         if (timeoutID > 0) {
-            utils.function.defer(this.clearTimer.bind(this), this, timeoutID);
+            defer(this.clearTimer.bind(this), this, timeoutID);
         }
     }
 
@@ -171,7 +171,7 @@ class Timer {
      */
     clearInterval(intervalID) {
         if (intervalID > 0) {
-            utils.function.defer(this.clearTimer.bind(this), this, intervalID);
+            defer(this.clearTimer.bind(this), this, intervalID);
         }
     }
 

package/src/utils/utils.js

@@ -1,8 +1,10 @@
-import * as agentUtils from "./agent.js";
-import * as arrayUtils from "./array.js";
-import * as fileUtils from "./file.js";
-import * as stringUtils from "./string.js";
-import * as fnUtils from "./function.js";
+import { toHex } from "./string.js";
+
+export * as agent from "./agent.js";
+export * as array from "./array.js";
+export * as file from "./file.js";
+export * as string from "./string.js";
+export * as function from "./function.js";
 
 /**
  * a collection of utility functions
@@ -13,124 +15,113 @@ import * as fnUtils from "./function.js";
 let GUID_base  = "";
 let GUID_index = 0;
 
-let utils = {
-
-    agent : agentUtils,
-    array : arrayUtils,
-    file : fileUtils,
-    string : stringUtils,
-    function : fnUtils,
-
-    /**
-     * Compare two version strings
-     * @public
-     * @memberof utils
-     * @name checkVersion
-     * @param {string} first - First version string to compare
-     * @param {string} second - second version string to compare
-     * @returns {number} comparison result <br>&lt; 0 : first &lt; second<br>
-     * 0 : first == second<br>
-     * &gt; 0 : first &gt; second
-     * @example
-     * if (me.utils.checkVersion("7.0.0") > 0) {
-     *     console.error(
-     *         "melonJS is too old. Expected: 7.0.0, Got: 6.3.0"
-     *     );
-     * }
-     */
-    checkVersion : function (first, second) {
-        let a = first.split(".");
-        let b = second.split(".");
-        let len = Math.min(a.length, b.length);
-        let result = 0;
+/**
+ * Compare two version strings
+ * @public
+ * @memberof utils
+ * @name checkVersion
+ * @param {string} first - First version string to compare
+ * @param {string} second - second version string to compare
+ * @returns {number} comparison result <br>&lt; 0 : first &lt; second<br>
+ * 0 : first == second<br>
+ * &gt; 0 : first &gt; second
+ * @example
+ * if (me.utils.checkVersion("7.0.0") > 0) {
+ *     console.error(
+ *         "melonJS is too old. Expected: 7.0.0, Got: 6.3.0"
+ *     );
+ * }
+ */
+export function checkVersion(first, second) {
+    let a = first.split(".");
+    let b = second.split(".");
+    let len = Math.min(a.length, b.length);
+    let result = 0;
 
-        for (let i = 0; i < len; i++) {
-            if ((result = +a[i] - +b[i])) {
-                break;
-            }
+    for (let i = 0; i < len; i++) {
+        if ((result = +a[i] - +b[i])) {
+            break;
         }
+    }
 
-        return result ? result : a.length - b.length;
-    },
+    return result ? result : a.length - b.length;
+}
 
-    /**
-     * parse the fragment (hash) from a URL and returns them into
-     * @public
-     * @memberof utils
-     * @name getUriFragment
-     * @param {string} [url=document.location] - an optional params string or URL containing fragment (hash) params to be parsed
-     * @returns {object} an object representing the deserialized params string.
-     * @property {boolean} [hitbox=false] draw the hitbox in the debug panel (if enabled)
-     * @property {boolean} [velocity=false] draw the entities velocity in the debug panel (if enabled)
-     * @property {boolean} [quadtree=false] draw the quadtree in the debug panel (if enabled)
-     * @property {boolean} [webgl=false] force the renderer to WebGL
-     * @property {boolean} [debug=false] display the debug panel (if preloaded)
-     * @property {string} [debugToggleKey="s"] show/hide the debug panel (if preloaded)
-     * @example
-     * // http://www.example.com/index.html#debug&hitbox=true&mytag=value
-     * let UriFragment = me.utils.getUriFragment();
-     * console.log(UriFragment["mytag"]); //> "value"
-     */
-    getUriFragment : function (url) {
-        let hash = {};
+/**
+ * parse the fragment (hash) from a URL and returns them into
+ * @public
+ * @memberof utils
+ * @name getUriFragment
+ * @param {string} [url=document.location] - an optional params string or URL containing fragment (hash) params to be parsed
+ * @returns {object} an object representing the deserialized params string.
+ * @property {boolean} [hitbox=false] draw the hitbox in the debug panel (if enabled)
+ * @property {boolean} [velocity=false] draw the entities velocity in the debug panel (if enabled)
+ * @property {boolean} [quadtree=false] draw the quadtree in the debug panel (if enabled)
+ * @property {boolean} [webgl=false] force the renderer to WebGL
+ * @property {boolean} [debug=false] display the debug panel (if preloaded)
+ * @property {string} [debugToggleKey="s"] show/hide the debug panel (if preloaded)
+ * @example
+ * // http://www.example.com/index.html#debug&hitbox=true&mytag=value
+ * let UriFragment = me.utils.getUriFragment();
+ * console.log(UriFragment["mytag"]); //> "value"
+ */
+export function getUriFragment(url) {
+    let hash = {};
 
-        if (typeof url === "undefined") {
-            if (typeof globalThis.document !== "undefined") {
-                let location = globalThis.document.location;
+    if (typeof url === "undefined") {
+        if (typeof globalThis.document !== "undefined") {
+            let location = globalThis.document.location;
 
-                if (location && location.hash) {
-                    url = location.hash;
-                } else {
-                    // No "document.location" exist for Wechat mini game platform.
-                    return hash;
-                }
+            if (location && location.hash) {
+                url = location.hash;
             } else {
-                // "document" undefined on node.js
+                // No "document.location" exist for Wechat mini game platform.
                 return hash;
             }
         } else {
-            // never cache if a url is passed as parameter
-            let index = url.indexOf("#");
-            if (index !== -1) {
-                url = url.slice(index, url.length);
-            } else {
-                return hash;
-            }
+            // "document" undefined on node.js
+            return hash;
         }
+    } else {
+        // never cache if a url is passed as parameter
+        let index = url.indexOf("#");
+        if (index !== -1) {
+            url = url.slice(index, url.length);
+        } else {
+            return hash;
+        }
+    }
 
-        // parse the url
-        url.slice(1).split("&").filter((value) => value !== "").forEach((value) => {
-            let kv = value.split("=");
-            let k = kv.shift();
-            let v = kv.join("=");
-            hash[k] = v || true;
-        });
-
-        return hash;
-    },
+    // parse the url
+    url.slice(1).split("&").filter((value) => value !== "").forEach((value) => {
+        let kv = value.split("=");
+        let k = kv.shift();
+        let v = kv.join("=");
+        hash[k] = v || true;
+    });
 
-    /**
-     * reset the GUID Base Name
-     * the idea here being to have a unique ID
-     * per level / object
-     * @ignore
-     */
-    resetGUID : function (base, index = 0) {
-        // also ensure it's only 8bit ASCII characters
-        GUID_base  = stringUtils.toHex(base.toString().toUpperCase());
-        GUID_index = index;
-    },
+    return hash;
+}
 
-    /**
-     * create and return a very simple GUID
-     * Game Unique ID
-     * @ignore
-     */
-    createGUID : function (index = 1) {
-        // to cover the case of undefined id for groups
-        GUID_index += index;
-        return GUID_base + "-" + (index || GUID_index);
-    }
-};
+/**
+ * reset the GUID Base Name
+ * the idea here being to have a unique ID
+ * per level / object
+ * @ignore
+ */
+export function resetGUID(base, index = 0) {
+    // also ensure it's only 8bit ASCII characters
+    GUID_base  = toHex(base.toString().toUpperCase());
+    GUID_index = index;
+}
 
-export default utils;
+/**
+ * create and return a very simple GUID
+ * Game Unique ID
+ * @ignore
+ */
+export function createGUID(index = 1) {
+    // to cover the case of undefined id for groups
+    GUID_index += index;
+    return GUID_base + "-" + (index || GUID_index);
+}

package/src/video/video.js

@@ -1,7 +1,7 @@
 import * as event from "./../system/event.js";
 import { initialized, game } from "./../index.js";
 import * as device from "./../system/device.js";
-import utils from "./../utils/utils.js";
+import { throttle } from "../utils/function.js";
 import * as vc from "../const";
 
 /**
@@ -98,7 +98,7 @@ export function init(width, height, options) {
     //add a channel for the onresize/onorientationchange event
     globalThis.addEventListener(
         "resize",
-        utils.function.throttle(
+        throttle(
             (e) => {
                 event.emit(event.WINDOW_ONRESIZE, e);
             }, 100
@@ -130,7 +130,7 @@ export function init(width, height, options) {
     }
 
     // Automatically update relative canvas position on scroll
-    globalThis.addEventListener("scroll", utils.function.throttle((e) => {
+    globalThis.addEventListener("scroll", throttle((e) => {
         event.emit(event.WINDOW_ONSCROLL, e);
     }, 100), false);