melonjs 12.0.0 → 13.1.1

package/src/system/event.js

@@ -399,7 +399,8 @@ export const CANVAS_ONRESIZE = "canvas.onresize";
  * Event for when the viewport is resized <br>
  * (this usually follows a WINDOW_ONRESIZE event, when using the `flex` scaling mode is used and after the viewport was updated).<br>
  * Data passed : {number} viewport width <br>
- * Data passed : {number} viewport height
+ * Data passed : {number} viewport height <br>
+ * Data passed : {Camera2d} a reference to the camera viewport being resized
  * @public
  * @constant
  * @type {string}

package/src/system/platform.js

@@ -0,0 +1,32 @@
+ /**
+  * The device platform type
+  * @namespace platform
+  * @memberof device
+  * @property {string} ua the user agent string for the current device
+  * @property {boolean} iOS `true` if the device is an iOS platform
+  * @property {boolean} android `true` if the device is an Android platform
+  * @property {boolean} android2 `true` if the device is an Android 2.x platform
+  * @property {boolean} linux `true` if the device is a Linux platform
+  * @property {boolean} chromeOS `true` if the device is running on ChromeOS.
+  * @property {boolean} wp `true` if the device is a Windows Phone platform
+  * @property {boolean} BlackBerry`true` if the device is a BlackBerry platform
+  * @property {boolean} Kindle`true` if the device is a Kindle platform
+  * @property {boolean} ejecta `true` if running under Ejecta
+  * @property {boolean} isWeixin `true` if running under Wechat
+  * @property {boolean} nodeJS `true` if running under node.js
+  * @property {boolean} isMobile `true` if a mobile device
+  */
+
+export const ua = typeof globalThis.navigator !== "undefined" ? globalThis.navigator.userAgent : "";
+export const iOS = /iPhone|iPad|iPod/i.test(ua);
+export const android = /Android/i.test(ua);
+export const android2 = /Android 2/i.test(ua);
+export const linux = /Linux/i.test(ua);
+export const chromeOS = /CrOS/.test(ua);
+export const wp = /Windows Phone/i.test(ua);
+export const BlackBerry = /BlackBerry/i.test(ua);
+export const Kindle = /Kindle|Silk.*Mobile Safari/i.test(ua);
+export const ejecta = (typeof globalThis.ejecta !== "undefined");
+export const isWeixin = /MicroMessenger/i.test(ua);
+export const nodeJS = (typeof globalThis.process !== "undefined") && (typeof globalThis.process.release !== "undefined") && (globalThis.process.release.name === "node");
+export const isMobile = /Mobi/i.test(ua) || iOS || android || wp || BlackBerry || Kindle || false;

package/src/system/save.js

@@ -1,4 +1,3 @@
-import device from "./device.js";
 import * as event from "./event.js";
 
 /**
@@ -32,22 +31,32 @@ import * as event from "./event.js";
  * @namespace save
  */
 
- // Variable to hold the object data
- var data = {};
+// Variable to hold the object data
+var data = {};
 
- /**
-  * a function to check if the given key is a reserved word
-  * @ignore
-  */
- function isReserved(key) {
-     return (key === "add" || key === "remove");
- }
+let hasLocalStorage = false;
+
+try {
+    // true if localStorage is supported
+    hasLocalStorage = typeof globalThis !== "undefined" && typeof globalThis.localStorage !== "undefined";
+} catch (e) {
+    // the above generates an exception when cookies are blocked
+    hasLocalStorage = false;
+}
+
+/**
+ * a function to check if the given key is a reserved word
+ * @ignore
+ */
+function isReserved(key) {
+    return (key === "add" || key === "remove");
+}
 
 
 // Initialize me.save on Boot event
 event.on(event.BOOT, () => {
     // Load previous data if local Storage is supported
-    if (typeof globalThis.localStorage !== "undefined") {
+    if (hasLocalStorage === true) {
         var me_save_content = globalThis.localStorage.getItem("me.save");
 
         if (typeof me_save_content === "string" && me_save_content.length > 0) {
@@ -95,7 +104,7 @@ var save = {
                      */
                     set (value) {
                         data[prop] = value;
-                        if (device.localStorage === true) {
+                        if (hasLocalStorage === true) {
                             globalThis.localStorage.setItem("me.save." + prop, JSON.stringify(value));
                         }
                     }
@@ -109,7 +118,7 @@ var save = {
         });
 
         // Save keys
-        if (device.localStorage === true) {
+        if (hasLocalStorage === true) {
             globalThis.localStorage.setItem("me.save", JSON.stringify(Object.keys(data)));
         }
     },
@@ -127,7 +136,7 @@ var save = {
         if (!isReserved(key)) {
             if (typeof data[key] !== "undefined") {
                 delete data[key];
-                if (device.localStorage === true) {
+                if (hasLocalStorage === true) {
                     globalThis.localStorage.removeItem("me.save." + key);
                     globalThis.localStorage.setItem("me.save", JSON.stringify(Object.keys(data)));
                 }

package/src/system/timer.js

@@ -6,53 +6,46 @@ import { clamp } from "./../math/math.js";
 /**
  * @classdesc
  * a Timer class to manage timing related function (FPS, Game Tick, Time...)
-  * @see {@link timer} the default global timer instance
+ * @see {@link timer} the default global timer instance
  */
 class Timer {
 
     constructor() {
         /**
-         * Last game tick value.<br/>
-         * Use this value to scale velocities during frame drops due to slow
-         * hardware or when setting an FPS limit. (See {@link timer.maxfps})
-         * This feature is disabled by default. Enable me.timer.interpolation to
-         * use it.
+         * Last game tick value. <br>
+         * Use this value to scale velocities during frame drops due to slow hardware or when setting an FPS limit.
+         * This feature is disabled by default (Enable interpolation to use it).
          * @public
-         * @see timer.interpolation
+         * @see interpolation
+         * @See maxfps
          * @type {number}
          * @name tick
-         * @memberof timer
          */
         this.tick = 1.0;
 
         /**
-         * Last measured fps rate.<br/>
-         * This feature is disabled by default, unless the debugPanel is enabled/visible
+         * Last measured fps rate.<br>
+         * This feature is disabled by default, unless the debugPanel is enabled/visible.
          * @public
          * @type {number}
          * @name fps
-         * @memberof timer
          */
         this.fps = 0;
 
         /**
          * Set the maximum target display frame per second
          * @public
-         * @see timer.tick
+         * @see tick
          * @type {number}
-         * @name maxfps
          * @default 60
-         * @memberof timer
          */
         this.maxfps = 60;
 
         /**
          * Enable/disable frame interpolation
-         * @see timer.tick
+         * @see tick
          * @type {boolean}
          * @default false
-         * @name interpolation
-         * @memberof timer
          */
         this.interpolation = false;
 
@@ -96,8 +89,6 @@ class Timer {
 
     /**
      * reset time (e.g. usefull in case of pause)
-     * @name reset
-     * @memberof timer
      * @ignore
      */
     reset() {
@@ -114,8 +105,6 @@ class Timer {
 
     /**
      * Calls a function once after a specified delay. See me.timer.setInterval to repeativly call a function.
-     * @name setTimeout
-     * @memberof timer
      * @param {Function} fn the function you want to execute after delay milliseconds.
      * @param {number} delay the number of milliseconds (thousandths of a second) that the function call should be delayed by.
      * @param {boolean} [pauseable=true] respects the pause state of the engine.
@@ -142,8 +131,6 @@ class Timer {
 
     /**
      * Calls a function continously at the specified interval.  See setTimeout to call function a single time.
-     * @name setInterval
-     * @memberof timer
      * @param {Function} fn the function to execute
      * @param {number} delay the number of milliseconds (thousandths of a second) on how often to execute the function
      * @param {boolean} [pauseable=true] respects the pause state of the engine.
@@ -170,8 +157,6 @@ class Timer {
 
     /**
      * Clears the delay set by me.timer.setTimeout().
-     * @name clearTimeout
-     * @memberof timer
      * @param {number} timeoutID ID of the timeout to be cleared
      */
     clearTimeout(timeoutID) {
@@ -180,8 +165,6 @@ class Timer {
 
     /**
      * Clears the Interval set by me.timer.setInterval().
-     * @name clearInterval
-     * @memberof timer
      * @param {number} intervalID ID of the interval to be cleared
      */
     clearInterval(intervalID) {
@@ -191,8 +174,6 @@ class Timer {
     /**
      * Return the current timestamp in milliseconds <br>
      * since the game has started or since linux epoch (based on browser support for High Resolution Timer)
-     * @name getTime
-     * @memberof timer
      * @returns {number}
      */
     getTime() {
@@ -201,8 +182,6 @@ class Timer {
 
     /**
      * Return elapsed time in milliseconds since the last update
-     * @name getDelta
-     * @memberof timer
      * @returns {number}
      */
     getDelta() {
@@ -211,9 +190,7 @@ class Timer {
 
     /**
      * compute the actual frame time and fps rate
-     * @name computeFPS
      * @ignore
-     * @memberof timer
      */
     countFPS() {
         this.framecount++;
@@ -281,6 +258,8 @@ class Timer {
     }
 };
 
+const timer = new Timer();
+
 /**
  * the default global Timer instance
  * @namespace timer
@@ -295,6 +274,4 @@ class Timer {
  * // set a timer to call "myFunction" every 1000ms (respecting the pause state) and passing param1 and param2
  * timer.setInterval(myFunction, 1000, true, param1, param2);
  */
-const timer = new Timer();
-
 export default timer;

package/src/text/text.js

@@ -204,18 +204,6 @@ class Text extends Renderable {
         this.setText(settings.text);
     }
 
-    /** @ignore */
-    onDeactivateEvent() {
-        // free the canvas and potential corresponding texture when deactivated
-        if (this.offScreenCanvas === true) {
-            globalRenderer.currentCompositor.deleteTexture2D(globalRenderer.currentCompositor.getTexture2D(this.glTextureUnit));
-            globalRenderer.cache.delete(this.canvasTexture.canvas);
-            pool.push(this.canvasTexture);
-            this.canvasTexture = undefined;
-            this.glTextureUnit = undefined;
-        }
-    }
-
     /**
      * make the font bold
      * @returns {Text} this object for chaining
@@ -436,6 +424,15 @@ class Text extends Renderable {
      * @ignore
      */
     destroy() {
+        if (this.offScreenCanvas === true) {
+            if (globalRenderer instanceof WebGLRenderer) {
+                globalRenderer.currentCompositor.deleteTexture2D(globalRenderer.currentCompositor.getTexture2D(this.glTextureUnit));
+                this.glTextureUnit = undefined;
+            }
+            globalRenderer.cache.delete(this.canvasTexture.canvas);
+            pool.push(this.canvasTexture);
+            this.canvasTexture = undefined;
+        }
         pool.push(this.fillStyle);
         pool.push(this.strokeStyle);
         this.fillStyle = this.strokeStyle = undefined;

package/src/tweens/tween.js

@@ -1,6 +1,6 @@
 import timer from "./../system/timer.js";
 import * as event from "./../system/event.js";
-import { world, lastUpdate } from "./../game.js";
+import game from "./../game.js";
 import { Easing } from "./easing.js";
 import { Interpolation } from "./interpolation.js";
 
@@ -72,7 +72,7 @@ class Tween {
         this._onUpdateCallback = null;
         this._onCompleteCallback = null;
         // tweens are synchronized with the game update loop
-        this._tweenTimeTracker = lastUpdate;
+        this._tweenTimeTracker = game.lastUpdate;
 
         // reset flags to default value
         this.isPersistent = false;
@@ -170,7 +170,7 @@ class Tween {
         this._onStartCallbackFired = false;
 
         // add the tween to the object pool on start
-        world.addChild(this);
+        game.world.addChild(this);
 
         this._startTime =  time + this._delayTime;
 
@@ -212,7 +212,7 @@ class Tween {
      */
     stop() {
         // remove the tween from the world container
-        world.removeChildNow(this);
+        game.world.removeChildNow(this);
         return this;
     }
 
@@ -349,7 +349,7 @@ class Tween {
 
         // the original Tween implementation expect
         // a timestamp and not a time delta
-        this._tweenTimeTracker = (lastUpdate > this._tweenTimeTracker) ? lastUpdate : this._tweenTimeTracker + dt;
+        this._tweenTimeTracker = (game.lastUpdate > this._tweenTimeTracker) ? game.lastUpdate : this._tweenTimeTracker + dt;
         var time = this._tweenTimeTracker;
 
         var property;
@@ -442,7 +442,7 @@ class Tween {
 
             } else {
                 // remove the tween from the world container
-                world.removeChildNow(this);
+                game.world.removeChildNow(this);
 
                 if ( this._onCompleteCallback !== null ) {
 

package/src/utils/string.js

@@ -58,3 +58,16 @@ export function toHex(str) {
     }
     return res;
 };
+
+/**
+ * returns true if the given string is a data url in the `data:[<mediatype>][;base64],<data>` format.
+ * (this will not test the validity of the Data or Base64 encoding)
+ * @public
+ * @memberof utils.string
+ * @name isDataUrl
+ * @param {string} str the string (url) to be tested
+ * @returns {boolean} true if the string is a data url
+ */
+export function isDataUrl(str) {
+    return /^data:(.+);base64,(.+)$/.test(str);
+};

package/src/video/canvas/canvas_renderer.js

@@ -5,7 +5,6 @@ import Ellipse from "./../../geometries/ellipse.js";
 import RoundRect from "./../../geometries/roundrect.js";
 import Rect from "./../../geometries/rectangle.js";
 import Bounds from "./../../physics/bounds.js";
-import { createCanvas } from "./../video.js";
 import * as event from "./../../system/event.js";
 
 /**
@@ -19,7 +18,6 @@ class CanvasRenderer extends Renderer {
      * @param {number} options.width The width of the canvas without scaling
      * @param {number} options.height The height of the canvas without scaling
      * @param {HTMLCanvasElement} [options.canvas] The html canvas to draw to on screen
-     * @param {boolean} [options.doubleBuffering=false] Whether to enable double buffering
      * @param {boolean} [options.antiAlias=false] Whether to enable anti-aliasing
      * @param {boolean} [options.transparent=false] Whether to enable transparency on the canvas (performance hit when enabled)
      * @param {boolean} [options.subPixel=false] Whether to enable subpixel renderering (performance hit when enabled)
@@ -32,17 +30,7 @@ class CanvasRenderer extends Renderer {
         super(options);
 
         // defined the 2d context
-        this.context = this.getContext2d(this.getScreenCanvas(), this.settings.transparent);
-
-        // create the back buffer if we use double buffering
-        if (this.settings.doubleBuffering) {
-            this.backBufferCanvas = createCanvas(this.settings.width, this.settings.height, true);
-            this.backBufferContext2D = this.getContext2d(this.backBufferCanvas);
-        }
-        else {
-            this.backBufferCanvas = this.getScreenCanvas();
-            this.backBufferContext2D = this.context;
-        }
+        this.context = this.getContext2d(this.getCanvas(), this.settings.transparent);
 
         this.setBlendMode(this.settings.blendMode);
 
@@ -58,13 +46,13 @@ class CanvasRenderer extends Renderer {
         }
 
         // context lost & restore event for canvas
-        this.getScreenCanvas().addEventListener("contextlost", (e) => {
+        this.getCanvas().addEventListener("contextlost", (e) => {
             e.preventDefault();
             this.isContextValid = false;
             event.emit(event.ONCONTEXT_LOST, this);
         }, false );
         // ctx.restoreContext()
-        this.getScreenCanvas().addEventListener("contextrestored", () => {
+        this.getCanvas().addEventListener("contextrestored", () => {
             this.isContextValid = true;
             event.emit(event.ONCONTEXT_RESTORED, this);
         }, false );
@@ -86,7 +74,7 @@ class CanvasRenderer extends Renderer {
      * @memberof CanvasRenderer
      */
     resetTransform() {
-        this.backBufferContext2D.setTransform(1, 0, 0, 1, 0, 0);
+        this.getContext().setTransform(1, 0, 0, 1, 0, 0);
     }
 
     /**
@@ -128,12 +116,6 @@ class CanvasRenderer extends Renderer {
                 this.currentBlendMode = "normal";
                 break;
         }
-
-        // transparent setting will override the given blendmode for this.context
-        if (this.settings.doubleBuffering && this.settings.transparent) {
-            // Clears the front buffer for each frame blit
-            this.context.globalCompositeOperation = "copy";
-        }
     }
 
     /**
@@ -147,17 +129,6 @@ class CanvasRenderer extends Renderer {
         }
     }
 
-    /**
-     * render the main framebuffer on screen
-     * @name flush
-     * @memberof CanvasRenderer
-     */
-    flush() {
-        if (this.settings.doubleBuffering) {
-            this.context.drawImage(this.backBufferCanvas, 0, 0);
-        }
-    }
-
     /**
      * Clears the main framebuffer with the given color
      * @name clearColor
@@ -166,11 +137,14 @@ class CanvasRenderer extends Renderer {
      * @param {boolean} [opaque=false] Allow transparency [default] or clear the surface completely [true]
      */
     clearColor(color = "#000000", opaque) {
+        var canvas = this.getCanvas();
+        var context = this.getContext();
+
         this.save();
         this.resetTransform();
-        this.backBufferContext2D.globalCompositeOperation = opaque ? "copy" : "source-over";
-        this.backBufferContext2D.fillStyle = (color instanceof Color) ? color.toRGBA() : color;
-        this.fillRect(0, 0, this.backBufferCanvas.width, this.backBufferCanvas.height);
+        context.globalCompositeOperation = opaque ? "copy" : "source-over";
+        context.fillStyle = (color instanceof Color) ? color.toRGBA() : color;
+        this.fillRect(0, 0, canvas.width, canvas.height);
         this.restore();
     }
 
@@ -530,17 +504,6 @@ class CanvasRenderer extends Renderer {
         this.strokeRoundRect(x, y, width, height, radius, true);
     }
 
-
-    /**
-     * return a reference to the system 2d Context
-     * @name getContext
-     * @memberof CanvasRenderer
-     * @returns {CanvasRenderingContext2D}
-     */
-    getContext() {
-        return this.backBufferContext2D;
-    }
-
     /**
      * return a reference to the font 2d Context
      * @ignore
@@ -556,7 +519,7 @@ class CanvasRenderer extends Renderer {
      * @memberof CanvasRenderer
      */
     save() {
-        this.backBufferContext2D.save();
+        this.getContext().save();
     }
 
     /**
@@ -565,12 +528,12 @@ class CanvasRenderer extends Renderer {
      * @memberof CanvasRenderer
      */
     restore() {
-        this.backBufferContext2D.restore();
+        this.getContext().restore();
         this.currentColor.glArray[3] = this.getGlobalAlpha();
         this.currentScissor[0] = 0;
         this.currentScissor[1] = 0;
-        this.currentScissor[2] = this.backBufferCanvas.width;
-        this.currentScissor[3] = this.backBufferCanvas.height;
+        this.currentScissor[2] = this.getCanvas().width;
+        this.currentScissor[3] = this.getCanvas().height;
     }
 
     /**
@@ -580,7 +543,7 @@ class CanvasRenderer extends Renderer {
      * @param {number} angle in radians
      */
     rotate(angle) {
-        this.backBufferContext2D.rotate(angle);
+        this.getContext().rotate(angle);
     }
 
     /**
@@ -591,7 +554,7 @@ class CanvasRenderer extends Renderer {
      * @param {number} y
      */
     scale(x, y) {
-        this.backBufferContext2D.scale(x, y);
+        this.getContext().scale(x, y);
     }
 
     /**
@@ -602,8 +565,9 @@ class CanvasRenderer extends Renderer {
      * @param {Color|string} color css color value
      */
     setColor(color) {
-        this.backBufferContext2D.strokeStyle =
-        this.backBufferContext2D.fillStyle = (
+        var context = this.getContext();
+        context.strokeStyle =
+        context.fillStyle = (
             color instanceof Color ?
             color.toRGBA() :
             color
@@ -617,7 +581,7 @@ class CanvasRenderer extends Renderer {
      * @param {number} alpha 0.0 to 1.0 values accepted.
      */
     setGlobalAlpha(alpha) {
-        this.backBufferContext2D.globalAlpha = this.currentColor.glArray[3] = alpha;
+        this.getContext().globalAlpha = this.currentColor.glArray[3] = alpha;
     }
 
     /**
@@ -627,7 +591,7 @@ class CanvasRenderer extends Renderer {
      * @returns {number} global alpha value
      */
     getGlobalAlpha() {
-        return this.backBufferContext2D.globalAlpha;
+        return this.getContext().globalAlpha;
     }
 
     /**
@@ -637,7 +601,7 @@ class CanvasRenderer extends Renderer {
      * @param {number} width Line width
      */
     setLineWidth(width) {
-        this.backBufferContext2D.lineWidth = width;
+        this.getContext().lineWidth = width;
     }
 
     /**
@@ -672,7 +636,7 @@ class CanvasRenderer extends Renderer {
             f |= 0;
         }
 
-        this.backBufferContext2D.transform(a, b, c, d, e, f);
+        this.getContext().transform(a, b, c, d, e, f);
     }
 
     /**
@@ -684,9 +648,9 @@ class CanvasRenderer extends Renderer {
      */
     translate(x, y) {
         if (this.settings.subPixel === false) {
-            this.backBufferContext2D.translate(~~x, ~~y);
+            this.getContext().translate(~~x, ~~y);
         } else {
-            this.backBufferContext2D.translate(x, y);
+            this.getContext().translate(x, y);
         }
     }
 
@@ -704,14 +668,14 @@ class CanvasRenderer extends Renderer {
      * @param {number} height
      */
     clipRect(x, y, width, height) {
-        var canvas = this.backBufferCanvas;
+        var canvas = this.getCanvas();
         // if requested box is different from the current canvas size;
         if (x !== 0 || y !== 0 || width !== canvas.width || height !== canvas.height) {
             var currentScissor = this.currentScissor;
             // if different from the current scissor box
             if (currentScissor[0] !== x || currentScissor[1] !== y ||
                 currentScissor[2] !== width || currentScissor[3] !== height) {
-                var context = this.backBufferContext2D;
+                var context = this.getContext();
                 context.beginPath();
                 context.rect(x, y, width, height);
                 context.clip();
@@ -743,11 +707,11 @@ class CanvasRenderer extends Renderer {
         }
 
         // https://github.com/melonjs/melonJS/issues/648
-        else if (mask instanceof RoundRect) {
+        if (mask instanceof RoundRect) {
             context.roundRect(mask.top, mask.left, mask.width, mask.height, mask.radius);
         } else if (mask instanceof Rect || mask instanceof Bounds) {
             context.rect(mask.top, mask.left, mask.width, mask.height);
-        }  else if (mask instanceof Ellipse) {
+        } else if (mask instanceof Ellipse) {
             const _x = mask.pos.x, _y = mask.pos.y,
                 hw = mask.radiusV.x,
                 hh = mask.radiusV.y,
@@ -769,6 +733,7 @@ class CanvasRenderer extends Renderer {
             context.bezierCurveTo(xmin, by, lx, ymax, lx, _y);
             context.bezierCurveTo(lx, ymin, xmin, ty, _x, ty);
         } else {
+            // polygon
             const _x = mask.pos.x, _y = mask.pos.y;
             var point;