@vpmedia/phaser 1.45.0 → 1.48.0

package/README.md

@@ -1,6 +1,6 @@
 # @vpmedia/phaser
 
-[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.45.0)](https://badge.fury.io/js/@vpmedia%2Fphaser)
+[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.48.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.45.0",
+  "version": "1.48.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",
@@ -23,16 +23,16 @@
   "types": "./types/index.d.ts",
   "type": "module",
   "devDependencies": {
-    "@eslint/js": "^9.12.0",
+    "@eslint/js": "^9.14.0",
     "@jest/globals": "^29.7.0",
-    "@types/jest": "^29.5.13",
-    "eslint": "^9.12.0",
-    "eslint-plugin-jsdoc": "^50.3.1",
+    "@types/jest": "^29.5.14",
+    "eslint": "^9.14.0",
+    "eslint-plugin-jsdoc": "^50.4.3",
     "eslint-plugin-unicorn": "^56.0.0",
-    "globals": "^15.11.0",
+    "globals": "^15.12.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "lefthook": "^1.7.18",
+    "lefthook": "^1.8.2",
     "prettier": "^3.3.3",
     "typescript": "^5.6.3"
   },

package/src/phaser/core/animation_manager.js

@@ -306,7 +306,7 @@ export class AnimationManager {
         this.sprite.setFrame(this.currentFrame);
       }
     } else {
-      this.game.exceptionHandler(new Error('Cannot set frame'), { key: value });
+      this.game.exceptionHandler(new Error('Cannot set frame'), { 'asset.key': value });
     }
   }
 
@@ -332,7 +332,7 @@ export class AnimationManager {
         this.sprite.setFrame(this.currentFrame);
       }
     } else {
-      this.game.exceptionHandler(new Error('Cannot set frameName'), { key: value });
+      this.game.exceptionHandler(new Error('Cannot set frameName'), { 'asset.key': value });
     }
   }
 }

package/src/phaser/core/game.js

@@ -145,13 +145,7 @@ export class Game {
         isWebGlReady = true;
       } catch (e) {
         isWebGlReady = false;
-        const tags = {
-          'document.readyState': document.readyState,
-          'document.hidden': document.hidden,
-          'document.visibilityState': document.visibilityState,
-          'canvas.width': this.canvas.width,
-          'canvas.height': this.canvas.height,
-        };
+        const tags = {};
         if (window.PhaserRegistry?.GL_PROGRAM_INFO_LOG) {
           tags.gl_program_log = window.PhaserRegistry.GL_PROGRAM_INFO_LOG;
         }

package/src/phaser/core/sound_manager.js

@@ -61,6 +61,7 @@ export class SoundManager {
       this.context === null ||
       (this.context && this.context.createGain === undefined && this.context.createGainNode === undefined)
     ) {
+      this.game.exceptionHandler(new Error('Error creating AudioContext'));
       this.noAudio = true;
       return;
     }
@@ -159,7 +160,7 @@ export class SoundManager {
           error: e,
         });
         this.removeUnlockHandlers();
-        this.game.exceptionHandler(e, { initialState, state: this.context.state });
+        this.game.exceptionHandler(e, { 'audio.initialState': initialState, 'audio.state': this.context.state });
       });
   }
 
@@ -220,7 +221,7 @@ export class SoundManager {
             this.game.cache.decodedSound(key, buffer);
           })
           .catch((e) => {
-            this.game.exceptionHandler(e, { key });
+            this.game.exceptionHandler(e, { 'asset.key': key });
           });
       }
     }

package/src/phaser/display/canvas/buffer.js

@@ -39,6 +39,11 @@ export class CanvasBuffer {
    * TBD.
    */
   destroy() {
+    try {
+      this.context?.reset();
+    } catch {
+      // pass
+    }
     removeByCanvas(this.canvas);
   }
 }

package/src/phaser/display/canvas/pool.js

@@ -91,16 +91,17 @@ export function getFree() {
  * @param {object} parent - TBD.
  * @param {number} width - TBD.
  * @param {number} height - TBD.
+ * @param {boolean} skipPool - TBD.
  * @returns {HTMLCanvasElement} TBD.
  */
-export function create(parent, width, height) {
+export function create(parent, width, height, skipPool = false) {
   if (parent === undefined) {
     console.warn('Created CanvasPool element with undefined parent.');
   }
   const idx = getFirst();
   const pool = getPool();
   let canvas;
-  if (idx === -1) {
+  if (idx === -1 || skipPool === true) {
     const container = {
       parent,
       canvas: document.createElement('canvas'),

package/src/phaser/display/canvas/renderer.js

@@ -40,9 +40,10 @@ export class CanvasRenderer {
     this.width = game.width * this.resolution;
     this.height = game.height * this.resolution;
     this.view = game.canvas;
+    /** @type {CanvasRenderingContext2D} */
     this.context = this.view.getContext('2d', { alpha: this.transparent });
     if (!this.context) {
-      throw new Error('Error creating Canvas 2D context.');
+      throw new Error('Error creating Canvas2D context');
     }
     this.refresh = true;
     this.count = 0;

package/src/phaser/display/canvas/tinter.js

@@ -1,6 +1,5 @@
-import { CanvasBuffer } from './buffer.js';
-import { create, removeByCanvas } from './pool.js';
 import { hex2rgb } from '../../util/math.js';
+import { create, removeByCanvas } from './pool.js';
 
 /**
  * TBD.
@@ -9,7 +8,7 @@ import { hex2rgb } from '../../util/math.js';
  * @returns {object} TBD.
  */
 export function getTintedTexture(sprite, color) {
-  const canvas = sprite.tintedTexture || create('CanvasTinter');
+  const canvas = sprite.tintedTexture || create('CanvasTinter', 1, 1);
   window.PhaserRegistry.CANVAS_TINT_METHOD(sprite.texture, color, canvas);
   return canvas;
 }
@@ -75,20 +74,37 @@ export function tintWithPerPixel(texture, color, canvas) {
  * @returns {boolean} TBD.
  */
 export function checkInverseAlpha() {
-  const canvas = new CanvasBuffer(2, 1);
-  canvas.context.fillStyle = 'rgba(10, 20, 30, 0.5)';
-  //  Draw a single pixel
-  canvas.context.fillRect(0, 0, 1, 1);
-  //  Get the color values
-  const s1 = canvas.context.getImageData(0, 0, 1, 1);
+  // Check for DOM
+  if (document === undefined) {
+    return false;
+  }
+  // Create canvas and context
+  const canvas = create('CanvasAlpha', 2, 1, true);
+  const context = canvas.getContext('2d');
+  if (!context) {
+    return false;
+  }
+  // Set canvas fill style
+  context.fillStyle = 'rgba(10, 20, 30, 0.5)';
+  // Draw a single pixel
+  context.fillRect(0, 0, 1, 1);
+  // Get the color values
+  const s1 = context.getImageData(0, 0, 1, 1);
   if (s1 === null) {
     return false;
   }
-  //  Plot them to x2
-  canvas.context.putImageData(s1, 1, 0);
-  //  Get those values
-  const s2 = canvas.context.getImageData(1, 0, 1, 1);
-  //  Compare and return
+  // Plot them to x2
+  context.putImageData(s1, 1, 0);
+  // Get those values
+  const s2 = context.getImageData(1, 0, 1, 1);
+  // Dispose canvas
+  try {
+    context.reset();
+  } catch {
+    // pass
+  }
+  removeByCanvas(canvas);
+  // Compare and return
   return (
     s2.data[0] === s1.data[0] && s2.data[1] === s1.data[1] && s2.data[2] === s1.data[2] && s2.data[3] === s1.data[3]
   );
@@ -99,17 +115,24 @@ export function checkInverseAlpha() {
  * @returns {boolean} TBD.
  */
 export function canUseNewCanvasBlendModes() {
+  // Check for DOM
   if (document === undefined) {
     return false;
   }
+  // Create test images
   const pngHead = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAABAQMAAADD8p2OAAAAA1BMVEX/';
   const pngEnd = 'AAAACklEQVQI12NgAAAAAgAB4iG8MwAAAABJRU5ErkJggg==';
   const magenta = new Image();
   magenta.src = `${pngHead  }AP804Oa6${  pngEnd}`;
   const yellow = new Image();
   yellow.src = `${pngHead  }/wCKxvRF${  pngEnd}`;
-  const canvas = create('CanvasTinter', 6, 1);
+  // Create canvas and context
+  const canvas = create('CanvasTinter', 6, 1, true);
   const context = canvas.getContext('2d');
+  if (!context) {
+    return false;
+  }
+  // Draw test images to canvas
   context.globalCompositeOperation = 'multiply';
   context.drawImage(magenta, 0, 0);
   context.drawImage(yellow, 2, 0);
@@ -117,7 +140,14 @@ export function canUseNewCanvasBlendModes() {
     return false;
   }
   const data = context.getImageData(2, 0, 1, 1).data;
+  // Dispose canvas
+  try {
+    context.reset();
+  } catch {
+    // pass
+  }
   removeByCanvas(canvas);
+  // Compare and return
   return data[0] === 255 && data[1] === 0 && data[2] === 0;
 }
 

package/src/phaser/display/display_object.js

@@ -111,7 +111,7 @@ export class DisplayObject {
     const index1 = this.getChildIndex(child);
     const index2 = this.getChildIndex(child2);
     if (index1 < 0 || index2 < 0) {
-      throw new Error('swapChildren: Both the supplied DisplayObjects must be a child of the caller.');
+      throw new Error('swapChildren: Both the supplied DisplayObjects must be a child of the caller');
     }
     this.children[index1] = child2;
     this.children[index2] = child;

package/src/phaser/display/webgl/renderer.js

@@ -128,7 +128,7 @@ export class WebGLRenderer {
     this.gl = gl;
     if (!gl) {
       // fail, not able to get a context
-      throw new Error('This browser does not support WebGL. Try using the Canvas 2D.');
+      throw new Error('Error creating WebGL context');
     }
     this.initRegistry();
     this.glContextId = window.PhaserRegistry.GL_CONTEXT_ID;

package/src/phaser/display/webgl/util.js

@@ -19,9 +19,10 @@ export function compileShader(gl, shaderSrc, shaderType) {
   gl.shaderSource(shader, src);
   gl.compileShader(shader);
   if (!gl.getShaderParameter(shader, gl.COMPILE_STATUS)) {
-    if (window.PhaserRegistry) {
-      window.PhaserRegistry.GL_SHADER_INFO_LOG = gl.getShaderInfoLog(shader);
+    if (!window.PhaserRegistry) {
+      window.PhaserRegistry = {};
     }
+    window.PhaserRegistry.GL_SHADER_INFO_LOG = gl.getShaderInfoLog(shader);
     return null;
   }
   return shader;
@@ -65,9 +66,10 @@ export function compileProgram(gl, vertexSrc, fragmentSrc) {
   gl.linkProgram(shaderProgram);
 
   if (!gl.getProgramParameter(shaderProgram, gl.LINK_STATUS)) {
-    if (window.PhaserRegistry) {
-      window.PhaserRegistry.GL_PROGRAM_INFO_LOG = gl.getProgramInfoLog(shaderProgram);
+    if (!window.PhaserRegistry) {
+      window.PhaserRegistry = {};
     }
+    window.PhaserRegistry.GL_PROGRAM_INFO_LOG = gl.getProgramInfoLog(shaderProgram);
   }
   return shaderProgram;
 }

package/src/phaser/geom/util/point.js

@@ -248,7 +248,7 @@ export function centroid(points, output = null) {
   const result = output || new Point();
   const pointsLen = points.length;
   if (pointsLen < 1) {
-    throw new Error('Point(points) array must not be empty.');
+    throw new Error('Point(points) array must not be empty');
   }
   if (pointsLen === 1) {
     result.copyFrom(points[0]);

package/CHANGES.md

@@ -1,21 +0,0 @@
-# Release notes
-
-All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
-
-## 1.44.0
-
-- Improved Canvas2D fallback handling
-
-## 1.43.0
-
-- Updated dependencies
-
-## 1.42.0
-
-- Added error notification for invalid texture frames
-
-## 1.41.0
-
-- Updated dependencies
-- Changed package to ES6 module