@vpmedia/phaser 1.68.0 → 1.70.0

package/README.md

@@ -1,6 +1,6 @@
 # @vpmedia/phaser
 
-[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.68.0)](https://badge.fury.io/js/@vpmedia%2Fphaser)
+[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.70.0)](https://badge.fury.io/js/@vpmedia%2Fphaser)
 [![Node.js CI](https://github.com/vpmedia/phaser/actions/workflows/ci.yml/badge.svg)](https://github.com/vpmedia/phaser/actions/workflows/ci.yml)
 
 @vpmedia/phaser is the modern ECMAScript port of the popular Phaser game engine v2.6.2.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vpmedia/phaser",
-  "version": "1.68.0",
+  "version": "1.70.0",
   "description": "@vpmedia/phaser is the modern ECMAScript port of the popular Phaser game engine v2.6.2",
   "author": "Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)",
   "license": "MIT",
@@ -22,6 +22,10 @@
   "main": "./src/index.js",
   "types": "./types/index.d.ts",
   "type": "module",
+  "dependencies": {
+    "@vpmedia/simplify": "^1.14.0",
+    "uuid": "^11.0.3"
+  },
   "devDependencies": {
     "@eslint/js": "^9.15.0",
     "@jest/globals": "^29.7.0",
@@ -48,8 +52,5 @@
     "> 0.5%",
     "not dead",
     "not op_mini all"
-  ],
-  "dependencies": {
-    "@vpmedia/simplify": "^1.14.0"
-  }
+  ]
 }

package/src/phaser/core/animation_parser.js

@@ -12,7 +12,7 @@ import { FrameData } from './frame_data.js';
  * @param {number} spacing - TBD.
  * @returns {object} TBD.
  */
-export function spriteSheet(game, key, frameWidth, frameHeight, frameMax, margin, spacing) {
+export const spriteSheet = (game, key, frameWidth, frameHeight, frameMax, margin, spacing) => {
   let img = key;
   if (typeof key === 'string') {
     img = game.cache.getImage(key);
@@ -54,7 +54,7 @@ export function spriteSheet(game, key, frameWidth, frameHeight, frameMax, margin
     }
   }
   return data;
-}
+};
 
 /**
  * TBD.
@@ -62,7 +62,7 @@ export function spriteSheet(game, key, frameWidth, frameHeight, frameMax, margin
  * @param {object} json - TBD.
  * @returns {object} TBD.
  */
-export function JSONDataHash(game, json) {
+export const JSONDataHash = (game, json) => {
   if (!json.frames) {
     game.logger.warn('JSONDataHash: Invalid Texture Atlas JSON given, missing frames object', json);
     return null;
@@ -93,4 +93,4 @@ export function JSONDataHash(game, json) {
     i += 1;
   }
   return data;
-}
+};

package/src/phaser/core/const.js

@@ -146,6 +146,19 @@ export const RENDER_CANVAS = 1;
  * @type {number}
  */
 export const RENDER_WEBGL = 2;
+// audio modes
+/**
+ * @type {number}
+ */
+export const AUDIO_DISABLED = 0;
+/**
+ * @type {number}
+ */
+export const AUDIO_STANDARD = 1;
+/**
+ * @type {number}
+ */
+export const AUDIO_WEBKIT = 2;
 // pointer modes
 /**
  * @type {number}

package/src/phaser/core/device_util.js

@@ -9,15 +9,15 @@ const logger = new Logger('device');
  * @param {string} type - TBD.
  * @returns {boolean} TBD.
  */
-export function canPlayAudio(device, type) {
+export const canPlayAudio = (device, type) => {
   return device.supportedAudioFormats[type] === true;
-}
+};
 
 /**
  * TBD.
  * @param {Device} device - TBD.
  */
-export function checkOS(device) {
+export const checkOS = (device) => {
   const ua = navigator.userAgent;
   if (/Android/.test(ua)) {
     device.android = true;
@@ -48,13 +48,13 @@ export function checkOS(device) {
   if (device.android || device.iOS || device.windowsPhone || (/Windows NT/i.test(ua) && /Touch/i.test(ua))) {
     device.desktop = false;
   }
-}
+};
 
 /**
  * TBD.
  * @param {Device} device - TBD.
  */
-export function checkInput(device) {
+export const checkInput = (device) => {
   if (
     'ontouchstart' in document.documentElement ||
     (window.navigator.maxTouchPoints && window.navigator.maxTouchPoints >= 1)
@@ -68,13 +68,13 @@ export function checkInput(device) {
   if ('onwheel' in window || 'WheelEvent' in window) {
     device.wheelEvent = 'wheel';
   }
-}
+};
 
 /**
  * TBD.
  * @param {Device} device - TBD.
  */
-export function checkFullScreenSupport(device) {
+export const checkFullScreenSupport = (device) => {
   const fs = [
     'requestFullscreen',
     'requestFullScreen',
@@ -114,13 +114,13 @@ export function checkFullScreenSupport(device) {
       device.fullscreenKeyboard = true;
     }
   }
-}
+};
 
 /**
  * TBD.
  * @param {Device} device - TBD.
  */
-export function checkBrowser(device) {
+export const checkBrowser = (device) => {
   const ua = navigator.userAgent;
   if (/Edge\/\d+/.test(ua)) {
     device.edge = true;
@@ -131,7 +131,7 @@ export function checkBrowser(device) {
   } else if (/Safari\/(\d+)/.test(ua) && !device.windowsPhone) {
     device.safari = true;
   }
-}
+};
 
 /**
  * Check for codec support.
@@ -175,7 +175,7 @@ export const isMediaSourceTypeSupported = (type) => {
  * @see https://developer.mozilla.org/En/Media_formats_supported_by_the_audio_and_video_elements
  * @see https://bit.ly/iphoneoscodecs
  */
-export function checkAudio(device) {
+export const checkAudio = (device) => {
   const audioElement = document.createElement('audio');
   const formats = [
     { type: 'ogg', codecs: ['audio/ogg; codecs="vorbis"'] },
@@ -194,13 +194,13 @@ export function checkAudio(device) {
       }
     }
   }
-}
+};
 
 /**
  * TBD.
  * @param {Device} device - TBD.
  */
-export function checkImage(device) {
+export const checkImage = (device) => {
   try {
     const avif = new Image();
     avif.src =
@@ -222,25 +222,25 @@ export function checkImage(device) {
     const typedError = error instanceof Error ? error : new Error(String(error));
     logger.exception('checkImage error with webp', typedError);
   }
-}
+};
 
 /**
  * TBD.
  * @param {Device} device - TBD.
  */
-export function initialize(device) {
+export const initialize = (device) => {
   checkOS(device);
   checkBrowser(device);
   checkAudio(device);
   // checkImage(device);
   checkFullScreenSupport(device);
   checkInput(device);
-}
+};
 
 /**
  * TBD.
  * @returns {Device} TBD.
  */
-export function createDevice() {
+export const createDevice = () => {
   return new Device();
-}
+};

package/src/phaser/core/frame_util.js

@@ -7,11 +7,11 @@ import { FrameData } from './frame_data.js';
  * @param {Frame} output - TBD.
  * @returns {Frame} TBD.
  */
-export function cloneFrame(frame, output = null) {
+export const cloneFrame = (frame, output = null) => {
   const result = output || new Frame(frame.index, frame.x, frame.y, frame.width, frame.height);
   result.initialize(frame.index, frame.x, frame.y, frame.width, frame.height);
   return result;
-}
+};
 
 /**
  * TBD.
@@ -19,10 +19,10 @@ export function cloneFrame(frame, output = null) {
  * @param {FrameData} output - TBD.
  * @returns {FrameData} TBD.
  */
-export function cloneFrameData(frameData, output = null) {
+export const cloneFrameData = (frameData, output = null) => {
   const result = output || new FrameData();
   for (let i = 0; i < frameData.total; i += 1) {
     result.addFrame(frameData.getFrame(i).clone());
   }
   return result;
-}
+};

package/src/phaser/core/loader_parser.js

@@ -7,13 +7,13 @@ import { Rectangle } from '../geom/rectangle.js';
  * @param {object} bitmapFontData - TBD.
  * @returns {object} TBD.
  */
-export function finalizeBitmapFont(baseTexture, bitmapFontData) {
+export const finalizeBitmapFont = (baseTexture, bitmapFontData) => {
   Object.keys(bitmapFontData.chars).forEach((charCode) => {
     const letter = bitmapFontData.chars[charCode];
     letter.texture = new Texture(baseTexture, new Rectangle(letter.x, letter.y, letter.width, letter.height));
   });
   return bitmapFontData;
-}
+};
 
 /**
  * TBD.
@@ -23,37 +23,37 @@ export function finalizeBitmapFont(baseTexture, bitmapFontData) {
  * @param {number} ySpacing - TBD.
  * @returns {object} TBD.
  */
-export function xmlBitmapFont(xml, baseTexture, xSpacing, ySpacing) {
+export const xmlBitmapFont = (xml, baseTexture, xSpacing, ySpacing) => {
   const data = {};
   const info = xml.getElementsByTagName('info')[0];
   const common = xml.getElementsByTagName('common')[0];
   data.font = info.getAttribute('face');
-  data.size = parseInt(info.getAttribute('size'), 10);
-  data.lineHeight = parseInt(common.getAttribute('lineHeight'), 10) + ySpacing;
+  data.size = Number.parseInt(info.getAttribute('size'), 10);
+  data.lineHeight = Number.parseInt(common.getAttribute('lineHeight'), 10) + ySpacing;
   data.chars = {};
   const letters = xml.getElementsByTagName('char');
   for (let i = 0; i < letters.length; i += 1) {
-    const charCode = parseInt(letters[i].getAttribute('id'), 10);
+    const charCode = Number.parseInt(letters[i].getAttribute('id'), 10);
     data.chars[charCode] = {
-      x: parseInt(letters[i].getAttribute('x'), 10),
-      y: parseInt(letters[i].getAttribute('y'), 10),
-      width: parseInt(letters[i].getAttribute('width'), 10),
-      height: parseInt(letters[i].getAttribute('height'), 10),
-      xOffset: parseInt(letters[i].getAttribute('xoffset'), 10),
-      yOffset: parseInt(letters[i].getAttribute('yoffset'), 10),
-      xAdvance: parseInt(letters[i].getAttribute('xadvance'), 10) + xSpacing,
+      x: Number.parseInt(letters[i].getAttribute('x'), 10),
+      y: Number.parseInt(letters[i].getAttribute('y'), 10),
+      width: Number.parseInt(letters[i].getAttribute('width'), 10),
+      height: Number.parseInt(letters[i].getAttribute('height'), 10),
+      xOffset: Number.parseInt(letters[i].getAttribute('xoffset'), 10),
+      yOffset: Number.parseInt(letters[i].getAttribute('yoffset'), 10),
+      xAdvance: Number.parseInt(letters[i].getAttribute('xadvance'), 10) + xSpacing,
       kerning: {},
     };
   }
   const kernings = xml.getElementsByTagName('kerning');
   for (let i = 0; i < kernings.length; i += 1) {
-    const first = parseInt(kernings[i].getAttribute('first'), 10);
-    const second = parseInt(kernings[i].getAttribute('second'), 10);
-    const amount = parseInt(kernings[i].getAttribute('amount'), 10);
+    const first = Number.parseInt(kernings[i].getAttribute('first'), 10);
+    const second = Number.parseInt(kernings[i].getAttribute('second'), 10);
+    const amount = Number.parseInt(kernings[i].getAttribute('amount'), 10);
     data.chars[second].kerning[first] = amount;
   }
   return finalizeBitmapFont(baseTexture, data);
-}
+};
 
 /**
  * TBD.
@@ -63,9 +63,9 @@ export function xmlBitmapFont(xml, baseTexture, xSpacing, ySpacing) {
  * @param {number} ySpacing - TBD.
  * @returns {object} TBD.
  */
-export function bitmapFont(xml, baseTexture, xSpacing, ySpacing) {
+export const bitmapFont = (xml, baseTexture, xSpacing, ySpacing) => {
   return xmlBitmapFont(xml, baseTexture, xSpacing, ySpacing);
-}
+};
 
 /**
  * TBD.
@@ -75,30 +75,30 @@ export function bitmapFont(xml, baseTexture, xSpacing, ySpacing) {
  * @param {number} ySpacing - TBD.
  * @returns {object} TBD.
  */
-export function jsonBitmapFont(json, baseTexture, xSpacing, ySpacing) {
+export const jsonBitmapFont = (json, baseTexture, xSpacing, ySpacing) => {
   const data = {
     font: json.font.info._face,
-    size: parseInt(json.font.info._size, 10),
-    lineHeight: parseInt(json.font.common._lineHeight, 10) + ySpacing,
+    size: Number.parseInt(json.font.info._size, 10),
+    lineHeight: Number.parseInt(json.font.common._lineHeight, 10) + ySpacing,
     chars: {},
   };
   json.font.chars.char.forEach((letter) => {
-    const charCode = parseInt(letter._id, 10);
+    const charCode = Number.parseInt(letter._id, 10);
     data.chars[charCode] = {
-      x: parseInt(letter._x, 10),
-      y: parseInt(letter._y, 10),
-      width: parseInt(letter._width, 10),
-      height: parseInt(letter._height, 10),
-      xOffset: parseInt(letter._xoffset, 10),
-      yOffset: parseInt(letter._yoffset, 10),
-      xAdvance: parseInt(letter._xadvance, 10) + xSpacing,
+      x: Number.parseInt(letter._x, 10),
+      y: Number.parseInt(letter._y, 10),
+      width: Number.parseInt(letter._width, 10),
+      height: Number.parseInt(letter._height, 10),
+      xOffset: Number.parseInt(letter._xoffset, 10),
+      yOffset: Number.parseInt(letter._yoffset, 10),
+      xAdvance: Number.parseInt(letter._xadvance, 10) + xSpacing,
       kerning: {},
     };
   });
   if (json.font.kernings && json.font.kernings.kerning) {
     json.font.kernings.kerning.forEach((kerning) => {
-      data.chars[kerning._second].kerning[kerning._first] = parseInt(kerning._amount, 10);
+      data.chars[kerning._second].kerning[kerning._first] = Number.parseInt(kerning._amount, 10);
     });
   }
   return finalizeBitmapFont(baseTexture, data);
-}
+};

package/src/phaser/core/scale_manager.js

@@ -197,14 +197,14 @@ export class ScaleManager {
       newWidth = width;
     } else {
       //  Percentage based
-      this.parentScaleFactor.x = parseInt(width, 10) / 100;
+      this.parentScaleFactor.x = Number.parseInt(width, 10) / 100;
       newWidth = rect.width * this.parentScaleFactor.x;
     }
     if (typeof height === 'number') {
       newHeight = height;
     } else {
       //  Percentage based
-      this.parentScaleFactor.y = parseInt(height, 10) / 100;
+      this.parentScaleFactor.y = Number.parseInt(height, 10) / 100;
       newHeight = rect.height * this.parentScaleFactor.y;
     }
     newWidth = Math.floor(newWidth);

package/src/phaser/core/sound_manager.js

@@ -5,6 +5,7 @@ import {
   PAGE_LIFECYCLE_STATE_CHANGE_EVENT,
 } from '@vpmedia/simplify';
 import { ArraySet } from './array_set.js';
+import { AUDIO_DISABLED, AUDIO_STANDARD, AUDIO_WEBKIT } from './const.js';
 import { Signal } from './signal.js';
 import { Sound } from './sound.js';
 import { SoundSprite } from './sound_sprite.js';
@@ -21,9 +22,10 @@ export class SoundManager {
     this.context = null;
     this.baseLatency = 0; // https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/baseLatency
     this.noAudio = false;
+    this.type = AUDIO_DISABLED;
     this.connectToMaster = true;
     this.isLocked = false;
-    this.muteOnPause = true;
+    // this.muteOnPause = true;
     this._codeMuted = false;
     this._muted = false;
     this._unlockSource = null;
@@ -47,6 +49,7 @@ export class SoundManager {
     if (window.AudioContext) {
       try {
         this.context = new window.AudioContext();
+        this.type = AUDIO_STANDARD;
       } catch (error) {
         this.context = null;
         this.noAudio = true;
@@ -56,6 +59,7 @@ export class SoundManager {
     } else if (window.webkitAudioContext) {
       try {
         this.context = new window.webkitAudioContext();
+        this.type = AUDIO_WEBKIT;
       } catch (error) {
         this.context = null;
         this.noAudio = true;

package/src/phaser/core/tween.js

@@ -40,7 +40,7 @@ export class Tween {
    * TBD.
    * @param {object} properties - TBD.
    * @param {number} duration - TBD.
-   * @param {string} ease - TBD.
+   * @param {string | Function} ease - TBD.
    * @param {boolean} autoStart - TBD.
    * @param {number} delay - TBD.
    * @param {number} repeat - TBD.
@@ -54,6 +54,7 @@ export class Tween {
     if (this.isRunning) {
       return this;
     }
+    // @ts-ignore
     this.timeline.push(new TweenData(this).to(properties, duration, ease, delay, repeat, yoyo));
     if (autoStart) {
       this.start();
@@ -65,7 +66,7 @@ export class Tween {
    * TBD.
    * @param {object} properties - TBD.
    * @param {number} duration - TBD.
-   * @param {string} ease - TBD.
+   * @param {string | Function} ease - TBD.
    * @param {boolean} autoStart - TBD.
    * @param {number} delay - TBD.
    * @param {number} repeat - TBD.
@@ -80,6 +81,7 @@ export class Tween {
       this.game.logger.warn('Tween.from cannot be called after Tween.start');
       return this;
     }
+    // @ts-ignore
     this.timeline.push(new TweenData(this).from(properties, duration, ease, delay, repeat, yoyo));
     if (autoStart) {
       this.start();

package/src/phaser/core/tween_data.js

@@ -26,7 +26,7 @@ export class TweenData {
     this.delay = 0;
     this.dt = 0;
     this.startTime = null;
-    this.easingFunction = 'Linear';
+    this.easingFunction = (k) => k;
     this.interpolationFunction = MathUtils.linearInterpolation;
     this.interpolationContext = MathUtils;
     this.isRunning = false;
@@ -37,7 +37,7 @@ export class TweenData {
    * TBD.
    * @param {object} properties - TBD.
    * @param {number} duration - TBD.
-   * @param {string} ease - TBD.
+   * @param {(number) => number} ease - TBD.
    * @param {number} delay - TBD.
    * @param {number} repeat - TBD.
    * @param {boolean} yoyo - TBD.
@@ -58,7 +58,7 @@ export class TweenData {
    * TBD.
    * @param {object} properties - TBD.
    * @param {number} duration - TBD.
-   * @param {string} ease - TBD.
+   * @param {(number) => number} ease - TBD.
    * @param {number} delay - TBD.
    * @param {number} repeat - TBD.
    * @param {boolean} yoyo - TBD.
@@ -131,7 +131,7 @@ export class TweenData {
       if (typeof this.vEnd[property] !== 'undefined') {
         if (typeof this.vEnd[property] === 'string') {
           //  Parses relative end values with start as base (e.g.: +10, -3)
-          this.vEnd[property] = this.vStart[property] + parseFloat(this.vEnd[property], 10);
+          this.vEnd[property] = this.vStart[property] + Number.parseFloat(this.vEnd[property]);
         }
         this.parent.properties[property] = this.vEnd[property];
       } else {