@vpmedia/phaser 1.0.2 → 1.0.4

package/package.json

@@ -1,46 +1,53 @@
 {
   "name": "@vpmedia/phaser",
-  "version": "1.0.2",
+  "version": "1.0.4",
+  "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",
-  "homepage": "https://github.com/vpmedia/phaser",
-  "private": false,
+  "homepage": "https://github.com/vpmedia/phaser#readme",
+  "bugs": {
+    "url": "https://github.com/vpmedia/phaser/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vpmedia/phaser.git"
+  },
+  "keywords": [
+    "phaser"
+  ],
   "main": "./src/index.js",
   "devDependencies": {
     "@babel/cli": "^7.19.3",
-    "@babel/core": "^7.19.6",
+    "@babel/core": "^7.20.2",
     "@babel/eslint-parser": "^7.19.1",
-    "@babel/preset-env": "^7.19.4",
+    "@babel/preset-env": "^7.20.2",
     "@babel/register": "^7.18.9",
-    "babel-loader": "^8.2.5",
-    "chai": "^4.3.6",
-    "eslint": "^8.26.0",
+    "babel-loader": "^8.3.0",
+    "eslint": "^8.28.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.5.0",
+    "eslint-plugin-jest": "^27.1.5",
+    "eslint-plugin-jsdoc": "^39.6.2",
     "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^8.0.1",
+    "husky": "^8.0.2",
+    "jest": "^29.3.1",
     "lint-staged": "^13.0.3",
-    "mocha": "^10.1.0",
-    "mocha-junit-reporter": "^2.1.1",
     "prettier": "^2.7.1",
-    "sinon": "^14.0.1",
-    "sinon-chai": "^3.7.0",
-    "webpack": "^5.74.0",
+    "webpack": "^5.75.0",
     "webpack-cli": "^4.10.0"
   },
   "scripts": {
     "prebuild": "rm -rf ./dist && mkdir -p ./dist",
     "build": "webpack --config webpack.config.babel.js --mode production",
-    "test": "mocha \"test/**/*test.js\" --require test/setup.js --require @babel/register --colors",
-    "lint": "eslint src/**/*.js && eslint test/**/*.js",
-    "lint-fix": "eslint src/**/*.js --fix && eslint test/**/*.js --fix",
+    "test": "jest --passWithNoTests",
+    "lint": "eslint \"**/*.js\"",
+    "lint-fix": "eslint \"**/*.js\" --fix",
     "format": "prettier --write \"**/*.{js,json}\"",
     "lint-staged": "lint-staged",
     "prepack": "npm run build"
   },
   "engines": {
-    "npm": ">=8.0.0",
-    "node": ">=18.0.0"
+    "npm": ">=7.0.0",
+    "node": ">=16.0.0"
   }
 }

package/src/index.js

@@ -73,27 +73,70 @@ import Text from './phaser/display/text';
 
 export {
   Const,
-  AnimationManager, AnimationParser,
+  AnimationManager,
+  AnimationParser,
   ArraySet,
   DOM,
-  Device, DeviceUtils,
+  Device,
+  DeviceUtils,
   EventManager,
-  Frame, FrameData,
-  InputManager, InputMouse, InputMSPointer, InputPointer, InputTouch,
+  Frame,
+  FrameData,
+  InputManager,
+  InputMouse,
+  InputMSPointer,
+  InputPointer,
+  InputTouch,
   Loader,
-  GameLoopRAF, GameLoopTO, GameLoopFB,
-  MathUtils, StringUtils,
+  GameLoopRAF,
+  GameLoopTO,
+  GameLoopFB,
+  MathUtils,
+  StringUtils,
   ScaleManager,
-  Scene, SceneManager,
-  Signal, SignalBinding,
-  Sound, SoundManager,
-  Time, Timer, TimerEvent,
-  Tween, TweenData, TweenEasing, TweenManager,
-  Circle, CircleUtils, Ellipse, EllipseUtils, Line, LineUtils, Matrix, MatrixUtils, Point, PointUtils,
-  Polygon, PolygonUtils, Rectangle, RectangleUtils, RoundedRectangle, RoundedRectangleUtils,
+  Scene,
+  SceneManager,
+  Signal,
+  SignalBinding,
+  Sound,
+  SoundManager,
+  Time,
+  Timer,
+  TimerEvent,
+  Tween,
+  TweenData,
+  TweenEasing,
+  TweenManager,
+  Circle,
+  CircleUtils,
+  Ellipse,
+  EllipseUtils,
+  Line,
+  LineUtils,
+  Matrix,
+  MatrixUtils,
+  Point,
+  PointUtils,
+  Polygon,
+  PolygonUtils,
+  Rectangle,
+  RectangleUtils,
+  RoundedRectangle,
+  RoundedRectangleUtils,
   Game,
   GraphicsData,
-  CanvasPool, CanvasUtils, CanvasBuffer, CanvasTinter, CanvasMasker, CanvasGraphics, CanvasRenderer,
+  CanvasPool,
+  CanvasUtils,
+  CanvasBuffer,
+  CanvasTinter,
+  CanvasMasker,
+  CanvasGraphics,
+  CanvasRenderer,
   EarCut,
-  BitmapText, Button, DisplayObject, Image, Group, Text,
+  BitmapText,
+  Button,
+  DisplayObject,
+  Image,
+  Group,
+  Text,
 };

package/src/phaser/core/animation_parser.js

@@ -8,13 +8,14 @@ import FrameData from './frame_data';
 
 /**
  *
- * @param game
- * @param key
- * @param frameWidth
- * @param frameHeight
- * @param frameMax
- * @param margin
- * @param spacing
+ * @param {object} game TBD
+ * @param {object} key TBD
+ * @param {number} frameWidth TBD
+ * @param {number} frameHeight TBD
+ * @param {number} frameMax TBD
+ * @param {number} margin TBD
+ * @param {number} spacing TBD
+ * @returns {object} TBD
  */
 export function spriteSheet(game, key, frameWidth, frameHeight, frameMax, margin, spacing) {
   let img = key;
@@ -60,8 +61,9 @@ export function spriteSheet(game, key, frameWidth, frameHeight, frameMax, margin
 
 /**
  *
- * @param game
- * @param json
+ * @param {object} game TBD
+ * @param {object} json TBD
+ * @returns {object} TBD
  */
 export function JSONData(game, json) {
   //  Malformed?
@@ -95,8 +97,9 @@ export function JSONDataPyxel() {
 
 /**
  *
- * @param game
- * @param json
+ * @param {object} game TBD
+ * @param {object} json TBD
+ * @returns {object} TBD
  */
 export function JSONDataHash(game, json) {
   if (!json.frames) {

package/src/phaser/core/array_set.js

@@ -3,7 +3,6 @@
  * @author       Richard Davey <rich@photonstorm.com>
  * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-/* eslint-disable prefer-spread */
 export default class {
 
   constructor(list = []) {

package/src/phaser/core/const.js

@@ -101,6 +101,6 @@ export const PENDING_ATLAS = -1;
 export const TEXTURE_ATLAS_JSON_ARRAY = 0;
 export const TEXTURE_ATLAS_JSON_HASH = 1;
 export const TEXTURE_ATLAS_XML_STARLING = 2;
-export const PHYSICS_LIME_CORONA_JSON = 3;
-export const PHYSICS_PHASER_JSON = 4;
+export const PHYSICS_LIME_CORONA_JSON = 3; // deprecated
+export const PHYSICS_PHASER_JSON = 4; // deprecated
 export const TEXTURE_ATLAS_JSON_PYXEL = 5;

package/src/phaser/core/device_util.js

@@ -6,8 +6,9 @@
 
 /**
  *
- * @param device
- * @param type
+ * @param {object} device TBD
+ * @param {string} type TBD
+ * @returns {boolean} TBD
  */
 export function canPlayAudio(device, type) {
   if (type === 'mp3' && device.mp3) {
@@ -30,8 +31,9 @@ export function canPlayAudio(device, type) {
 
 /**
  *
- * @param device
- * @param type
+ * @param {object} device TBD
+ * @param {string} type TBD
+ * @returns {boolean} TBD
  */
 export function canPlayVideo(device, type) {
   if (type === 'webm' && (device.webmVideo || device.vp9Video)) {
@@ -48,7 +50,7 @@ export function canPlayVideo(device, type) {
 
 /**
  *
- * @param device
+ * @param {object} device TBD
  */
 export function checkOS(device) {
   const ua = navigator.userAgent;
@@ -90,7 +92,7 @@ export function checkOS(device) {
 
 /**
  *
- * @param device
+ * @param {object} device TBD
  */
 export function checkFeatures(device) {
   device.pointerLock = 'pointerLockElement' in document || 'mozPointerLockElement' in document || 'webkitPointerLockElement' in document;
@@ -98,7 +100,7 @@ export function checkFeatures(device) {
 
 /**
  *
- * @param device
+ * @param {object} device TBD
  */
 export function checkInput(device) {
   if ('ontouchstart' in document.documentElement || (window.navigator.maxTouchPoints && window.navigator.maxTouchPoints >= 1)) {
@@ -124,7 +126,7 @@ export function checkInput(device) {
 
 /**
  *
- * @param device
+ * @param {object} device TBD
  */
 export function checkFullScreenSupport(device) {
   const fs = [
@@ -170,7 +172,7 @@ export function checkFullScreenSupport(device) {
 
 /**
  *
- * @param device
+ * @param {object} device TBD
  */
 export function checkBrowser(device) {
   const ua = navigator.userAgent;
@@ -218,7 +220,7 @@ export function checkBrowser(device) {
   if (device.cocoonJS) {
     try {
       device.cocoonJSApp = (typeof CocoonJS !== 'undefined');
-    } catch (error) {
+    } catch (e) {
       device.cocoonJSApp = false;
     }
   }
@@ -226,7 +228,7 @@ export function checkBrowser(device) {
 
 /**
  *
- * @param device
+ * @param {object} device TBD
  */
 export function checkVideo(device) {
   const videoElement = document.createElement('video');
@@ -257,7 +259,7 @@ export function checkVideo(device) {
 
 /**
  *
- * @param device
+ * @param {object} device TBD
  */
 export function checkAudio(device) {
   device.audioData = !!(window.Audio);
@@ -307,7 +309,7 @@ export function checkAudio(device) {
 
 /**
  *
- * @param device
+ * @param {object} device TBD
  */
 export function checkDevice(device) {
   device.pixelRatio = window.devicePixelRatio || 1;
@@ -317,7 +319,7 @@ export function checkDevice(device) {
 
 /**
  *
- * @param device
+ * @param {object} device TBD
  */
 export function initialize(device) {
   checkOS(device);
@@ -331,7 +333,7 @@ export function initialize(device) {
 }
 
 /**
- *
+ * TBD
  */
 export function readyCheck() {
   if (!document.body) {
@@ -354,10 +356,10 @@ export function readyCheck() {
 
 /**
  *
- * @param device
- * @param callback
- * @param context
- * @param nonPrimer
+ * @param {object} device TBD
+ * @param {Function} callback TBD
+ * @param {object} context TBD
+ * @param {boolean} nonPrimer TBD
  */
 export function whenReady(device, callback, context, nonPrimer) {
   if (device.deviceReadyAt) {

package/src/phaser/core/frame_util.js

@@ -8,8 +8,9 @@ import FrameData from './frame_data';
 
 /**
  *
- * @param frame
- * @param output
+ * @param {object} frame TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function cloneFrame(frame, output = null) {
   const result = output || new Frame();
@@ -19,8 +20,9 @@ export function cloneFrame(frame, output = null) {
 
 /**
  *
- * @param frameData
- * @param output
+ * @param {object} frameData TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function cloneFrameData(frameData, output = null) {
   const result = output || new FrameData();

package/src/phaser/core/game.js

@@ -143,6 +143,7 @@ export default class {
         isWebGlReady = true;
       } catch (e) {
         isWebGlReady = false;
+        this.exceptionHandler(e);
       }
       /*
       this.renderer = new WebGLRenderer(this);
@@ -216,6 +217,13 @@ export default class {
     if (config.renderer) {
       this.config.renderType = config.renderer;
     }
+    if (config.exceptionHandler) {
+      this.exceptionHandler = config.exceptionHandler;
+    } else {
+      this.exceptionHandler = (e) => {
+        console.error(e);
+      };
+    }
     if (config.parent) {
       this.parent = config.parent;
     }

package/src/phaser/core/loader.js

@@ -179,18 +179,52 @@ export default class {
     return this.addToFileList(type, key, url, properties, true);
   }
 
-  pack() {
-    // TODO
-    console.warn('loader.pack() is not implemented');
+  pack(key, url, data, callbackContext) {
+    const pack = {
+      type: 'packfile',
+      key: key,
+      url: url,
+      path: this.path,
+      syncPoint: true,
+      data: null,
+      loading: false,
+      loaded: false,
+      error: false,
+      callbackContext: callbackContext
+    };
+    if (data) {
+      if (typeof data === 'string') {
+        data = JSON.parse(data);
+      }
+      pack.data = data || {};
+      pack.loaded = true;
+    }
+    for (let i = 0; i < this._fileList.length + 1; i += 1) {
+      const file = this._fileList[i];
+      if (!file || (!file.loaded && !file.loading && file.type !== 'packfile')) {
+        this._fileList.splice(i, 0, pack);
+        this._totalPackCount += 1;
+        break;
+      }
+    }
+    return this;
   }
 
   image(key, url, overwrite) {
     return this.addToFileList('image', key, url, undefined, overwrite, '.png');
   }
 
-  images() {
-    // TODO
-    console.warn('loader.images() is not implemented');
+  images(keys, urls) {
+    if (Array.isArray(urls)) {
+      for (let i = 0; i < keys.length; i += 1) {
+        this.image(keys[i], urls[i]);
+      }
+    } else {
+      for (let i = 0; i < keys.length; i += 1) {
+        this.image(keys[i]);
+      }
+    }
+    return this;
   }
 
   text(key, url, overwrite) {
@@ -231,19 +265,32 @@ export default class {
     return this.addToFileList('audio', key, urls, { buffer: null, autoDecode });
   }
 
-  audioSprite() {
-    // TODO
-    console.warn('loader.audioSprite() is not implemented');
+  audioSprite(key, urls, jsonURL, jsonData, autoDecode = true) {
+    if (this.game.sound.noAudio) {
+      return this;
+    }
+    this.audio(key, urls, autoDecode);
+    if (jsonURL) {
+      this.json(key + '-audioatlas', jsonURL);
+    } else if (jsonData) {
+      if (typeof jsonData === 'string') {
+        jsonData = JSON.parse(jsonData);
+      }
+      this.cache.addJSON(key + '-audioatlas', '', jsonData);
+    }
+    return this;
   }
 
   video() {
     // TODO
     console.warn('loader.video() is not implemented');
+    return this;
   }
 
   tilemap() {
     // TODO
     console.warn('loader.tilemap() is not implemented');
+    return this;
   }
 
   bitmapFont(key, textureURL = null, atlasURL = null, atlasData = null, xSpacing = 0, ySpacing = 0) {
@@ -487,9 +534,73 @@ export default class {
     this.processLoadQueue();
   }
 
-  processPack() {
-    // TODO
-    console.warn('loader.processPack() is not implemented');
+  processPack(pack) {
+    const packData = pack.data[pack.key];
+    if (!packData) {
+      console.warn('Missing loader pack key', pack.key);
+      return;
+    }
+    for (let i = 0; i < packData.length; i += 1) {
+      const file = packData[i];
+      switch (file.type) {
+        case "image":
+          this.image(file.key, file.url, file.overwrite);
+          break;
+        case "text":
+          this.text(file.key, file.url, file.overwrite);
+          break;
+        case "json":
+          this.json(file.key, file.url, file.overwrite);
+          break;
+        case "xml":
+          this.xml(file.key, file.url, file.overwrite);
+          break;
+        case "script":
+          this.script(file.key, file.url, file.callback, pack.callbackContext || this);
+          break;
+        case "binary":
+          this.binary(file.key, file.url, file.callback, pack.callbackContext || this);
+          break;
+        case "spritesheet":
+          this.spritesheet(file.key, file.url, file.frameWidth, file.frameHeight, file.frameMax, file.margin, file.spacing);
+          break;
+        case "video":
+          this.video(file.key, file.urls);
+          break;
+        case "audio":
+          this.audio(file.key, file.urls, file.autoDecode);
+          break;
+        case "audiosprite":
+          this.audioSprite(file.key, file.urls, file.jsonURL, file.jsonData, file.autoDecode);
+          break;
+        case "tilemap":
+          // TODO
+          // this.tilemap(file.key, file.url, file.data, Phaser.Tilemap[file.format]);
+          break;
+        case "physics":
+          // TODO
+          // this.physics(file.key, file.url, file.data, Phaser.Loader[file.format]);
+          break;
+        case "bitmapFont":
+          this.bitmapFont(file.key, file.textureURL, file.atlasURL, file.atlasData, file.xSpacing, file.ySpacing);
+          break;
+        case "atlasJSONArray":
+          this.atlasJSONArray(file.key, file.textureURL, file.atlasURL, file.atlasData);
+          break;
+        case "atlasJSONHash":
+          this.atlasJSONHash(file.key, file.textureURL, file.atlasURL, file.atlasData);
+          break;
+        case "atlasXML":
+          this.atlasXML(file.key, file.textureURL, file.atlasURL, file.atlasData);
+          break;
+        case "atlas":
+          this.atlas(file.key, file.textureURL, file.atlasURL, file.atlasData, file.format === 'TEXTURE_ATLAS_JSON_HASH' ? TEXTURE_ATLAS_JSON_HASH : TEXTURE_ATLAS_JSON_ARRAY);
+          break;
+        case "shader":
+          this.shader(file.key, file.url, file.overwrite);
+          break;
+      }
+    }
   }
 
   transformUrl(url, file) {
@@ -658,7 +769,7 @@ export default class {
         if (!scope.hasLoaded) {
           scope.asyncComplete(file, e.message || 'Exception');
         } else {
-          console.error(e);
+          scope.game.exceptionHandler(e);
         }
       }
       return null;
@@ -670,7 +781,7 @@ export default class {
         if (!scope.hasLoaded) {
           scope.asyncComplete(file, e.message || 'Exception');
         } else {
-          console.error(e);
+          scope.game.exceptionHandler(e);
         }
       }
       return null;

package/src/phaser/core/loader_parser.js

@@ -8,8 +8,9 @@ import Rectangle from '../geom/rectangle';
 
 /**
  *
- * @param baseTexture
- * @param bitmapFontData
+ * @param {object} baseTexture TBD
+ * @param {object} bitmapFontData TBD
+ * @returns {object} TBD
  */
 export function finalizeBitmapFont(baseTexture, bitmapFontData) {
   Object.keys(bitmapFontData.chars).forEach((charCode) => {
@@ -21,10 +22,11 @@ export function finalizeBitmapFont(baseTexture, bitmapFontData) {
 
 /**
  *
- * @param xml
- * @param baseTexture
- * @param xSpacing
- * @param ySpacing
+ * @param {object} xml TBD
+ * @param {object} baseTexture TBD
+ * @param {number} xSpacing TBD
+ * @param {number} ySpacing TBD
+ * @returns {object} TBD
  */
 export function xmlBitmapFont(xml, baseTexture, xSpacing, ySpacing) {
   const data = {};
@@ -60,10 +62,11 @@ export function xmlBitmapFont(xml, baseTexture, xSpacing, ySpacing) {
 
 /**
  *
- * @param xml
- * @param baseTexture
- * @param xSpacing
- * @param ySpacing
+ * @param {object} xml TBD
+ * @param {object} baseTexture TBD
+ * @param {number} xSpacing TBD
+ * @param {number} ySpacing TBD
+ * @returns {object} TBD
  */
 export function bitmapFont(xml, baseTexture, xSpacing, ySpacing) {
   return xmlBitmapFont(xml, baseTexture, xSpacing, ySpacing);
@@ -71,10 +74,11 @@ export function bitmapFont(xml, baseTexture, xSpacing, ySpacing) {
 
 /**
  *
- * @param json
- * @param baseTexture
- * @param xSpacing
- * @param ySpacing
+ * @param {object} json TBD
+ * @param {object} baseTexture TBD
+ * @param {number} xSpacing TBD
+ * @param {number} ySpacing TBD
+ * @returns {object} TBD
  */
 export function jsonBitmapFont(json, baseTexture, xSpacing, ySpacing) {
   const data = {

package/src/phaser/core/scene.js

@@ -3,7 +3,6 @@
  * @author       Richard Davey <rich@photonstorm.com>
  * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-/* eslint-disable class-methods-use-this */
 export default class {
 
   constructor() {

package/src/phaser/core/scene_manager.js

@@ -3,7 +3,6 @@
  * @author       Richard Davey <rich@photonstorm.com>
  * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-/* eslint-disable new-cap */
 import Scene from './scene';
 import { RENDER_CANVAS } from './const';