melonjs 10.10.0 → 11.0.0

package/src/system/device.js

@@ -1,14 +1,10 @@
 import { hasAudio } from "./../audio/audio.js";
 import { getParent } from "./../video/video.js";
-import save from "./../system/save.js";
+import save from "./save.js";
 import { prefixed } from "./../utils/agent.js";
 import state from "./../state/state.js";
-import * as event from "./../system/event.js";
-
-/**
- * The device capabilities and specific events
- * @namespace device
- */
+import * as event from "./event.js";
+import { DOMContentLoaded } from "./dom.js";
 
 // private properties
 let accelInitialized = false;
@@ -28,45 +24,6 @@ function _disableSwipeFn(e) {
     return false;
 };
 
-// DOM loading stuff
-let readyBound = false, isReady = false, readyList = [];
-
-/**
- * // called to check if the device is ready
- * @ignore
- */
-function _domReady() {
-    // Make sure that the DOM is not already loaded
-    if (!isReady) {
-        // be sure document.body is there
-        if (!device.nodeJS && !document.body) {
-            return setTimeout(_domReady, 13);
-        }
-
-        // clean up loading event
-        if (typeof globalThis.document !== "undefined" && typeof globalThis.document.removeEventListener === "function") {
-            globalThis.document.removeEventListener(
-                "DOMContentLoaded",
-                this._domReady,
-                false
-            );
-        }
-
-        if (typeof globalThis.removeEventListener === "function") {
-            // remove the event on globalThis.onload (always added in `onReady`)
-            globalThis.removeEventListener("load", _domReady, false);
-        }
-
-        // execute all callbacks
-        while (readyList.length) {
-            readyList.shift().call(globalThis, []);
-        }
-
-        // Remember that the DOM is ready
-        isReady = true;
-    }
-};
-
 // a cache DOMRect object
 let _domRect = {left: 0, top: 0, x: 0, y: 0, width: 0, height: 0, right: 0, bottom: 0};
 
@@ -250,6 +207,11 @@ event.on(event.BOOT, () => {
 
 
 // public export
+/**
+ * The device capabilities and specific events
+ *
+ * @namespace
+ */
 let device = {
 
     /**
@@ -257,7 +219,6 @@ let device = {
      * @type {string}
      * @readonly
      * @name ua
-     * @memberof device
      */
     ua : typeof globalThis.navigator !== "undefined" ? globalThis.navigator.userAgent : "",
 
@@ -267,7 +228,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name localStorage
-     * @memberof device
      */
     localStorage : false,
 
@@ -276,7 +236,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasAccelerometer
-     * @memberof device
      */
     hasAccelerometer : false,
 
@@ -285,7 +244,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasDeviceOrientation
-     * @memberof device
      */
     hasDeviceOrientation : false,
 
@@ -295,7 +253,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name ScreenOrientation
-     * @memberof device
      */
     ScreenOrientation : false,
 
@@ -304,7 +261,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasFullscreenSupport
-     * @memberof device
      */
     hasFullscreenSupport : false,
 
@@ -313,7 +269,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasPointerLockSupport
-     * @memberof device
      */
     hasPointerLockSupport : false,
 
@@ -322,7 +277,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasWebAudio
-     * @memberof device
      */
     hasWebAudio : false,
 
@@ -331,7 +285,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name nativeBase64
-     * @memberof device
      */
     nativeBase64 : (typeof(globalThis.atob) === "function"),
 
@@ -340,7 +293,6 @@ let device = {
      * @type {number}
      * @readonly
      * @name maxTouchPoints
-     * @memberof device
      * @example
      * if (me.device.maxTouchPoints > 1) {
      *     // device supports multi-touch
@@ -353,7 +305,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name touch
-     * @memberof device
      */
     touch : false,
 
@@ -362,7 +313,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name wheel
-     * @memberof device
      */
     wheel : false,
 
@@ -372,7 +322,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name isMobile
-     * @memberof device
      */
     isMobile : false,
 
@@ -381,7 +330,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name iOS
-     * @memberof device
      */
     iOS : false,
 
@@ -390,7 +338,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name android
-     * @memberof device
      */
     android : false,
 
@@ -399,7 +346,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name android2
-     * @memberof device
      */
     android2 : false,
 
@@ -408,7 +354,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name linux
-     * @memberof device
      */
     linux : false,
 
@@ -418,7 +363,6 @@ let device = {
      * @readonly
      * @see http://impactjs.com/ejecta
      * @name ejecta
-     * @memberof device
      */
     ejecta : false,
 
@@ -427,7 +371,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name isWeixin
-     * @memberof device
      */
     isWeixin : false,
 
@@ -436,16 +379,14 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name nodeJS
-     * @memberof device
      */
-    nodeJS : (typeof process !== "undefined") && (process.release.name === "node"),
+    nodeJS : (typeof globalThis.process !== "undefined") && (typeof globalThis.process.release !== "undefined") && (globalThis.process.release.name === "node"),
 
     /**
      * equals to true if the device is running on ChromeOS.
      * @type {boolean}
      * @readonly
      * @name chromeOS
-     * @memberof device
      */
     chromeOS : false,
 
@@ -454,7 +395,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name wp
-     * @memberof device
      */
     wp : false,
 
@@ -463,7 +403,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name BlackBerry
-     * @memberof device
      */
     BlackBerry : false,
 
@@ -472,7 +411,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name Kindle
-     * @memberof device
      */
     Kindle : false,
 
@@ -483,7 +421,6 @@ let device = {
      * @readonly
      * @name accelerationX
      * @see device.watchAccelerometer
-     * @memberof device
      */
     accelerationX : 0,
 
@@ -494,7 +431,6 @@ let device = {
      * @readonly
      * @name accelerationY
      * @see device.watchAccelerometer
-     * @memberof device
      */
     accelerationY : 0,
 
@@ -505,7 +441,6 @@ let device = {
      * @readonly
      * @name accelerationZ
      * @see device.watchAccelerometer
-     * @memberof device
      */
     accelerationZ : 0,
 
@@ -516,7 +451,6 @@ let device = {
      * @readonly
      * @name gamma
      * @see device.watchDeviceOrientation
-     * @memberof device
      */
     gamma : 0,
 
@@ -527,7 +461,6 @@ let device = {
      * @readonly
      * @name beta
      * @see device.watchDeviceOrientation
-     * @memberof device
      */
     beta: 0,
 
@@ -539,7 +472,6 @@ let device = {
      * @readonly
      * @name alpha
      * @see device.watchDeviceOrientation
-     * @memberof device
      */
     alpha : 0,
 
@@ -551,7 +483,6 @@ let device = {
      * @readonly
      * @see http://www.w3schools.com/tags/ref_language_codes.asp
      * @name language
-     * @memberof device
      */
     language : typeof globalThis.navigator !== "undefined" ? globalThis.navigator.language || globalThis.navigator.browserLanguage || globalThis.navigator.userLanguage || "en" : "en",
 
@@ -559,7 +490,6 @@ let device = {
      * Specify whether to pause the game when losing focus
      * @type {boolean}
      * @default true
-     * @memberof device
      */
     pauseOnBlur : true,
 
@@ -567,7 +497,6 @@ let device = {
      * Specify whether to unpause the game when gaining focus
      * @type {boolean}
      * @default true
-     * @memberof device
      */
     resumeOnFocus : true,
 
@@ -575,7 +504,6 @@ let device = {
      * Specify whether to automatically bring the window to the front
      * @type {boolean}
      * @default true
-     * @memberof device
      */
     autoFocus : true,
 
@@ -584,7 +512,6 @@ let device = {
      * The engine restarts on focus if this is enabled.
      * @type {boolean}
      * @default false
-     * @memberof device
      */
     stopOnBlur : false,
 
@@ -593,7 +520,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name OffScreenCanvas
-     * @memberof device
      */
     OffscreenCanvas : false,
 
@@ -642,33 +568,7 @@ let device = {
     * });
     */
     onReady(fn) {
-        // If the DOM is already ready
-        if (isReady) {
-            // Execute the function immediately
-            fn.call(globalThis, []);
-        }
-        else {
-            // Add the function to the wait list
-            readyList.push(fn);
-
-            // attach listeners if not yet done
-            if (!readyBound) {
-                // directly call domReady if document is already "ready"
-                if (device.nodeJS === true || (typeof globalThis.document !== "undefined" && globalThis.document.readyState === "complete")) {
-                    // defer the fn call to ensure our script is fully loaded
-                    globalThis.setTimeout(_domReady, 0);
-                }
-                else {
-                    if (typeof globalThis.document !== "undefined" && typeof globalThis.document.addEventListener === "function") {
-                        // Use the handy event callback
-                        globalThis.document.addEventListener("DOMContentLoaded", _domReady, false);
-                    }
-                    // A fallback to globalThis.onload, that will always work
-                    globalThis.addEventListener("load", _domReady, false);
-                }
-                readyBound = true;
-            }
-        }
+        DOMContentLoaded(fn);
     },
 
     /**
@@ -1110,10 +1010,9 @@ let device = {
 
 /**
  * Ratio of the resolution in physical pixels to the resolution in CSS pixels for the current display device.
- * @name devicePixelRatio
- * @memberof device
+ * @name device.devicePixelRatio
  * @public
- * @type {number}
+ * @member {number}
  * @readonly
  * @returns {number}
  */
@@ -1128,10 +1027,9 @@ Object.defineProperty(device, "devicePixelRatio", {
 
 /**
  * Returns true if the browser/device is in full screen mode.
- * @name isFullscreen
- * @memberof device
+ * @name device.isFullscreen
  * @public
- * @type {boolean}
+ * @member {boolean}
  * @readonly
  * @returns {boolean}
  */
@@ -1151,10 +1049,9 @@ Object.defineProperty(device, "isFullscreen", {
 
 /**
  * Returns true if the browser/device has audio capabilities.
- * @name sound
- * @memberof device
+ * @name device.sound
  * @public
- * @type {boolean}
+ * @member {boolean}
  * @readonly
  * @returns {boolean}
  */

package/src/system/dom.js

@@ -0,0 +1,69 @@
+import * as event from "./event.js";
+
+// track if DOMContentLoaded was called already
+let readyBound = false;
+
+// is the DOM ready ?
+let isDOMReady = false;
+
+// check if the dom is ready
+function _domReady() {
+
+    // Make sure that the DOM is not already loaded
+    if (!isDOMReady) {
+        // be sure document.body is there
+        if (typeof globalThis.document !== "undefined" && !globalThis.document.body) {
+            return setTimeout(_domReady, 13);
+        }
+
+        // clean up loading event
+        if (typeof globalThis.document !== "undefined" && typeof globalThis.document.removeEventListener === "function") {
+            globalThis.document.removeEventListener(
+                "DOMContentLoaded",
+                _domReady,
+                false
+            );
+        }
+
+        if (typeof globalThis.removeEventListener === "function") {
+            // remove the event on globalThis.onload (always added in `onReady`)
+            globalThis.removeEventListener("load", _domReady, false);
+        }
+
+        // execute all callbacks
+        event.emit(event.DOM_READY);
+
+        // Remember that the DOM is ready
+        isDOMReady = true;
+    }
+};
+
+// https://developer.mozilla.org/en-US/docs/Web/API/Window/DOMContentLoaded_event
+export function DOMContentLoaded(fn) {
+    // If the DOM is already ready
+    if (isDOMReady) {
+        // Execute the function immediately
+        fn.call(globalThis, []);
+    }
+    else {
+        // else add the function to the DOM_READY event
+        event.once(event.DOM_READY, fn, globalThis);
+        // bind dom load event if not done yet
+        if (!readyBound) {
+            // directly call domReady if document is already "ready"
+            if (((typeof process !== "undefined") && (process.release.name === "node")) || (typeof globalThis.document !== "undefined" && globalThis.document.readyState === "complete")) {
+                // defer the fn call to ensure our script is fully loaded
+                globalThis.setTimeout(_domReady, 0);
+            }
+            else {
+                if (typeof globalThis.document !== "undefined" && typeof globalThis.document.addEventListener === "function") {
+                    // Use the handy event callback
+                    globalThis.document.addEventListener("DOMContentLoaded", _domReady, false);
+                }
+                // A fallback to globalThis.onload, that will always work
+                globalThis.addEventListener("load", _domReady, false);
+            }
+            readyBound = true;
+        }
+    }
+}

package/src/system/event.js

@@ -8,6 +8,17 @@ import EventEmitter from "eventemitter3";
 // internal instance of the event emiter
 var eventEmitter = new EventEmitter();
 
+/**
+ * event when the DOM is Ready is booting
+ * @public
+ * @constant
+ * @type {string}
+ * @name DOM_READY
+ * @memberof event
+ * @see event.on
+ */
+export const DOM_READY = "dom_ready";
+
 /**
  * event when the system is booting
  * @public
@@ -67,6 +78,17 @@ export const STATE_STOP = "me.state.onStop";
  */
 export const STATE_RESTART = "me.state.onRestart";
 
+/**
+ * event for when the changing to a different stage
+ * @public
+ * @constant
+ * @type {string}
+ * @name STATE_CHANGE
+ * @memberof event
+ * @see event.on
+ */
+export const STATE_CHANGE = "me.state.onChange";
+
 /**
  * event for when the video is initialized<br>
  * Data passed : none <br>

package/src/system/pooling.js

@@ -1,16 +1,16 @@
 /**
  * @classdesc
- * This object is used for object pooling - a technique that might speed up your game if used properly.<br>
+ * Object pooling - a technique that might speed up your game if used properly.<br>
  * If some of your classes will be instantiated and removed a lot at a time, it is a
  * good idea to add the class to this object pool. A separate pool for that class
  * will be created, which will reuse objects of the class. That way they won't be instantiated
  * each time you need a new one (slowing your game), but stored into that pool and taking one
  * already instantiated when you need it.<br><br>
- * This object is also used by the engine to instantiate objects defined in the map,
+ * This technique is also used by the engine to instantiate objects defined in the map,
  * which means, that on level loading the engine will try to instantiate every object
  * found in the map, based on the user defined name in each Object Properties<br>
  * <img src="images/object_properties.png"/><br>
- * @see {@link pool} a default global instance of ObjectPool
+ * @see {@link pool} the default global instance of ObjectPool
  */
 class ObjectPool {
 
@@ -167,7 +167,7 @@ class ObjectPool {
         return (typeof className !== "undefined") &&
                 (typeof obj.onResetEvent === "function") &&
                 (className in this.objectClass) &&
-                (this.objectClass[className].pool !== "undefined");
+                (typeof this.objectClass[className].pool !== "undefined");
 
     }
 
@@ -180,11 +180,22 @@ class ObjectPool {
     }
 };
 
-/**
- * a default global object pool instance
- * @public
- * @type {ObjectPool}
- */
+
 var pool = new ObjectPool();
 
+/**
+ * a default global ObjectPool instance
+ * @namespace pool
+ * @see ObjectPool
+ * @example
+ * // register our bullet object into the object pool
+ * pool.register("bullet", BulletEntity, true);
+ * // ...
+ * // when we need to manually create a new bullet:
+ * var bullet = pool.pull("bullet", x, y, direction, velocity);
+ * // ...
+ * // when we want to destroy existing object, the remove
+ * // function will ensure the object can then be reallocated later
+ * game.world.removeChild(bullet);
+ */
 export default pool;

package/src/system/save.js

@@ -1,5 +1,5 @@
-import device from "./../system/device.js";
-import * as event from "./../system/event.js";
+import device from "./device.js";
+import * as event from "./event.js";
 
 /**
  * allow to access and manage the device localStorage
@@ -47,13 +47,13 @@ import * as event from "./../system/event.js";
 // Initialize me.save on Boot event
 event.on(event.BOOT, () => {
     // Load previous data if local Storage is supported
-    if (device.localStorage === true) {
-        var me_save_content = localStorage.getItem("me.save");
+    if (typeof globalThis.localStorage !== "undefined") {
+        var me_save_content = globalThis.localStorage.getItem("me.save");
 
         if (typeof me_save_content === "string" && me_save_content.length > 0) {
             var keys = JSON.parse(me_save_content) || [];
             keys.forEach(function (key) {
-                data[key] = JSON.parse(localStorage.getItem("me.save." + key));
+                data[key] = JSON.parse(globalThis.localStorage.getItem("me.save." + key));
             });
         }
     }
@@ -65,7 +65,6 @@ var save = {
      * Add new keys to localStorage and set them to the given default values if they do not exist
      * @name add
      * @memberof save
-     * @function
      * @param {object} props key and corresponding values
      * @example
      * // Initialize "score" and "lives" with default values
@@ -97,7 +96,7 @@ var save = {
                     set (value) {
                         data[prop] = value;
                         if (device.localStorage === true) {
-                            localStorage.setItem("me.save." + prop, JSON.stringify(value));
+                            globalThis.localStorage.setItem("me.save." + prop, JSON.stringify(value));
                         }
                     }
                 });
@@ -111,7 +110,7 @@ var save = {
 
         // Save keys
         if (device.localStorage === true) {
-            localStorage.setItem("me.save", JSON.stringify(Object.keys(data)));
+            globalThis.localStorage.setItem("me.save", JSON.stringify(Object.keys(data)));
         }
     },
 
@@ -119,7 +118,6 @@ var save = {
      * Remove a key from localStorage
      * @name remove
      * @memberof save
-     * @function
      * @param {string} key key to be removed
      * @example
      * // Remove the "score" key from localStorage
@@ -130,8 +128,8 @@ var save = {
             if (typeof data[key] !== "undefined") {
                 delete data[key];
                 if (device.localStorage === true) {
-                    localStorage.removeItem("me.save." + key);
-                    localStorage.setItem("me.save", JSON.stringify(Object.keys(data)));
+                    globalThis.localStorage.removeItem("me.save." + key);
+                    globalThis.localStorage.setItem("me.save", JSON.stringify(Object.keys(data)));
                 }
             }
         }