melonjs 10.10.0 → 10.11.0

package/src/state/state.js

@@ -1,7 +1,6 @@
 import { pauseTrack, resumeTrack } from "./../audio/audio.js";
 import * as fctUtil from "./../utils/function.js";
 import * as event from "./../system/event.js";
-import timer from "./../system/timer.js";
 import * as game from "./../game.js";
 import Stage from "./../state/stage.js";
 import DefaultLoadingScreen from "./../loader/loadingscreen.js";
@@ -41,9 +40,6 @@ var _pauseTime = 0;
 function _startRunLoop() {
     // ensure nothing is running first and in valid state
     if ((_animFrameId === -1) && (_state !== -1)) {
-        // reset the timer
-        timer.reset();
-
         // start the main loop
         _animFrameId = globalThis.requestAnimationFrame(_renderFrame);
     }
@@ -56,9 +52,6 @@ function _startRunLoop() {
 function _resumeRunLoop() {
     // ensure game is actually paused and in valid state
     if (_isPaused && (_state !== -1)) {
-        // reset the timer
-        timer.reset();
-
         _isPaused = false;
     }
 }
@@ -124,6 +117,9 @@ function _switchState(state) {
         // new requested state
         _startRunLoop();
 
+        // publish the pause event
+        event.emit(event.STATE_CHANGE);
+
         // execute callback if defined
         if (_onSwitchComplete) {
             _onSwitchComplete();
@@ -253,7 +249,6 @@ var state = {
      * @name stop
      * @memberof state
      * @public
-     * @function
      * @param {boolean} [pauseTrack=false] pause current track on screen stop.
      */
     stop(pauseTrack=false) {
@@ -280,7 +275,6 @@ var state = {
      * @name pause
      * @memberof state
      * @public
-     * @function
      * @param {boolean} [music=false] pause current music track on screen pause
      */
     pause(music=false) {
@@ -306,7 +300,6 @@ var state = {
      * @name restart
      * @memberof state
      * @public
-     * @function
      * @param {boolean} [music=false] resume current music track on screen resume
      */
     restart(music=false) {
@@ -334,7 +327,6 @@ var state = {
      * @name resume
      * @memberof state
      * @public
-     * @function
      * @param {boolean} [music=false] resume current music track on screen resume
      */
     resume(music=false) {
@@ -359,7 +351,6 @@ var state = {
      * @name isRunning
      * @memberof state
      * @public
-     * @function
      * @returns {boolean} true if a "process is running"
      */
     isRunning() {
@@ -371,7 +362,6 @@ var state = {
      * @name isPaused
      * @memberof state
      * @public
-     * @function
      * @returns {boolean} true if the game is paused
      */
     isPaused() {
@@ -383,7 +373,6 @@ var state = {
      * @name set
      * @memberof state
      * @public
-     * @function
      * @param {number} state State ID (see constants)
      * @param {Stage} stage Instantiated Stage to associate with state ID
      * @param {boolean} [start = false] if true the state will be changed immediately after adding it.
@@ -443,7 +432,6 @@ var state = {
      * @name current
      * @memberof state
      * @public
-     * @function
      * @returns {Stage}
      */
     current() {
@@ -457,7 +445,6 @@ var state = {
      * @name transition
      * @memberof state
      * @public
-     * @function
      * @param {string} effect (only "fade" is supported for now)
      * @param {Color|string} color a CSS color value
      * @param {number} [duration=1000] expressed in milliseconds
@@ -474,7 +461,6 @@ var state = {
      * @name setTransition
      * @memberof state
      * @public
-     * @function
      * @param {number} state State ID (see constants)
      * @param {boolean} enable
      */
@@ -487,7 +473,6 @@ var state = {
      * @name change
      * @memberof state
      * @public
-     * @function
      * @param {number} state State ID (see constants)
      * @param {boolean} forceChange if true the state will be changed immediately
      * @param {object} [...arguments] extra arguments to be passed to the reset functions
@@ -511,7 +496,6 @@ var state = {
             }
             // if fading effect
             if (_fade.duration && _stages[state].transition) {
-                /** @ignore */
                 _onSwitchComplete = () => {
                     game.viewport.fadeOut(_fade.color, _fade.duration);
                 };
@@ -542,7 +526,6 @@ var state = {
      * @name isCurrent
      * @memberof state
      * @public
-     * @function
      * @param {number} state State ID (see constants)
      * @returns {boolean} true if the specified state is the current one
      */

package/src/system/device.js

@@ -1,14 +1,9 @@
 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";
 
 // private properties
 let accelInitialized = false;
@@ -39,7 +34,7 @@ function _domReady() {
     // Make sure that the DOM is not already loaded
     if (!isReady) {
         // be sure document.body is there
-        if (!device.nodeJS && !document.body) {
+        if (typeof globalThis.document !== "undefined" && !globalThis.document.body) {
             return setTimeout(_domReady, 13);
         }
 
@@ -250,6 +245,11 @@ event.on(event.BOOT, () => {
 
 
 // public export
+/**
+ * The device capabilities and specific events
+ *
+ * @namespace
+ */
 let device = {
 
     /**
@@ -257,7 +257,6 @@ let device = {
      * @type {string}
      * @readonly
      * @name ua
-     * @memberof device
      */
     ua : typeof globalThis.navigator !== "undefined" ? globalThis.navigator.userAgent : "",
 
@@ -267,7 +266,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name localStorage
-     * @memberof device
      */
     localStorage : false,
 
@@ -276,7 +274,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasAccelerometer
-     * @memberof device
      */
     hasAccelerometer : false,
 
@@ -285,7 +282,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasDeviceOrientation
-     * @memberof device
      */
     hasDeviceOrientation : false,
 
@@ -295,7 +291,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name ScreenOrientation
-     * @memberof device
      */
     ScreenOrientation : false,
 
@@ -304,7 +299,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasFullscreenSupport
-     * @memberof device
      */
     hasFullscreenSupport : false,
 
@@ -313,7 +307,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasPointerLockSupport
-     * @memberof device
      */
     hasPointerLockSupport : false,
 
@@ -322,7 +315,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasWebAudio
-     * @memberof device
      */
     hasWebAudio : false,
 
@@ -331,7 +323,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name nativeBase64
-     * @memberof device
      */
     nativeBase64 : (typeof(globalThis.atob) === "function"),
 
@@ -340,7 +331,6 @@ let device = {
      * @type {number}
      * @readonly
      * @name maxTouchPoints
-     * @memberof device
      * @example
      * if (me.device.maxTouchPoints > 1) {
      *     // device supports multi-touch
@@ -353,7 +343,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name touch
-     * @memberof device
      */
     touch : false,
 
@@ -362,7 +351,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name wheel
-     * @memberof device
      */
     wheel : false,
 
@@ -372,7 +360,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name isMobile
-     * @memberof device
      */
     isMobile : false,
 
@@ -381,7 +368,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name iOS
-     * @memberof device
      */
     iOS : false,
 
@@ -390,7 +376,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name android
-     * @memberof device
      */
     android : false,
 
@@ -399,7 +384,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name android2
-     * @memberof device
      */
     android2 : false,
 
@@ -408,7 +392,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name linux
-     * @memberof device
      */
     linux : false,
 
@@ -418,7 +401,6 @@ let device = {
      * @readonly
      * @see http://impactjs.com/ejecta
      * @name ejecta
-     * @memberof device
      */
     ejecta : false,
 
@@ -427,7 +409,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name isWeixin
-     * @memberof device
      */
     isWeixin : false,
 
@@ -436,7 +417,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name nodeJS
-     * @memberof device
      */
     nodeJS : (typeof process !== "undefined") && (process.release.name === "node"),
 
@@ -445,7 +425,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name chromeOS
-     * @memberof device
      */
     chromeOS : false,
 
@@ -454,7 +433,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name wp
-     * @memberof device
      */
     wp : false,
 
@@ -463,7 +441,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name BlackBerry
-     * @memberof device
      */
     BlackBerry : false,
 
@@ -472,7 +449,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name Kindle
-     * @memberof device
      */
     Kindle : false,
 
@@ -483,7 +459,6 @@ let device = {
      * @readonly
      * @name accelerationX
      * @see device.watchAccelerometer
-     * @memberof device
      */
     accelerationX : 0,
 
@@ -494,7 +469,6 @@ let device = {
      * @readonly
      * @name accelerationY
      * @see device.watchAccelerometer
-     * @memberof device
      */
     accelerationY : 0,
 
@@ -505,7 +479,6 @@ let device = {
      * @readonly
      * @name accelerationZ
      * @see device.watchAccelerometer
-     * @memberof device
      */
     accelerationZ : 0,
 
@@ -516,7 +489,6 @@ let device = {
      * @readonly
      * @name gamma
      * @see device.watchDeviceOrientation
-     * @memberof device
      */
     gamma : 0,
 
@@ -527,7 +499,6 @@ let device = {
      * @readonly
      * @name beta
      * @see device.watchDeviceOrientation
-     * @memberof device
      */
     beta: 0,
 
@@ -539,7 +510,6 @@ let device = {
      * @readonly
      * @name alpha
      * @see device.watchDeviceOrientation
-     * @memberof device
      */
     alpha : 0,
 
@@ -551,7 +521,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 +528,6 @@ let device = {
      * Specify whether to pause the game when losing focus
      * @type {boolean}
      * @default true
-     * @memberof device
      */
     pauseOnBlur : true,
 
@@ -567,7 +535,6 @@ let device = {
      * Specify whether to unpause the game when gaining focus
      * @type {boolean}
      * @default true
-     * @memberof device
      */
     resumeOnFocus : true,
 
@@ -575,7 +542,6 @@ let device = {
      * Specify whether to automatically bring the window to the front
      * @type {boolean}
      * @default true
-     * @memberof device
      */
     autoFocus : true,
 
@@ -584,7 +550,6 @@ let device = {
      * The engine restarts on focus if this is enabled.
      * @type {boolean}
      * @default false
-     * @memberof device
      */
     stopOnBlur : false,
 
@@ -593,7 +558,6 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name OffScreenCanvas
-     * @memberof device
      */
     OffscreenCanvas : false,
 
@@ -1110,10 +1074,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 +1091,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 +1113,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/event.js

@@ -67,6 +67,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 {
 
@@ -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)));
                 }
             }
         }