@vpmedia/phaser 1.74.0 → 1.76.0

package/eslint.config.js

@@ -50,9 +50,50 @@ export default [
     rules: {
       ...js.configs.recommended.rules,
       ...jsdocPlugin.configs['flat/recommended'].rules,
+      ...unicornPlugin.configs['flat/recommended'].rules,
       'no-unused-vars': 'off',
       'prefer-arrow-callback': 'warn',
       'prefer-template': 'warn',
+      'unicorn/consistent-function-scoping': 'off',
+      'unicorn/explicit-length-check': 'off',
+      'unicorn/filename-case': 'off',
+      'unicorn/no-array-for-each': 'off',
+      'unicorn/no-array-push-push': 'off',
+      'unicorn/no-for-loop': 'off',
+      'unicorn/no-lonely-if': 'off',
+      'unicorn/no-negated-condition': 'off',
+      'unicorn/no-nested-ternary': 'off',
+      'unicorn/no-null': 'off',
+      'unicorn/no-this-assignment': 'off',
+      'unicorn/no-typeof-undefined': 'off',
+      'unicorn/no-undefined': 'off',
+      'unicorn/no-useless-undefined': 'off',
+      'unicorn/number-literal-case': 'off',
+      'unicorn/numeric-separators-style': 'off',
+      'unicorn/prefer-add-event-listener': 'off',
+      'unicorn/prefer-at': 'off',
+      'unicorn/prefer-code-point': 'off',
+      'unicorn/prefer-default-parameters': 'off',
+      'unicorn/prefer-dom-node-append': 'off',
+      'unicorn/prefer-dom-node-remove': 'off',
+      'unicorn/prefer-global-this': 'off',
+      'unicorn/prefer-includes': 'off',
+      'unicorn/prefer-logical-operator-over-ternary': 'off',
+      'unicorn/prefer-math-min-max': 'off',
+      'unicorn/prefer-math-trunc': 'off',
+      'unicorn/prefer-modern-dom-apis': 'off',
+      'unicorn/prefer-modern-math-apis': 'off',
+      'unicorn/prefer-optional-catch-binding': 'off',
+      'unicorn/prefer-query-selector': 'off',
+      'unicorn/prefer-regexp-test': 'off',
+      'unicorn/prefer-spread': 'off',
+      'unicorn/prefer-string-replace-all': 'off',
+      'unicorn/prefer-string-slice': 'off',
+      'unicorn/prefer-structured-clone': 'off',
+      'unicorn/prefer-switch': 'off',
+      'unicorn/prefer-ternary': 'off',
+      'unicorn/prevent-abbreviations': 'off',
+      'unicorn/switch-case-braces': 'off',
       'jsdoc/require-jsdoc': [
         'warn',
         {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vpmedia/phaser",
-  "version": "1.74.0",
+  "version": "1.76.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,22 +23,22 @@
   "types": "./types/index.d.ts",
   "type": "module",
   "dependencies": {
-    "@vpmedia/simplify": "^1.14.0",
+    "@vpmedia/simplify": "^1.16.0",
     "uuid": "^11.0.3"
   },
   "devDependencies": {
-    "@eslint/js": "^9.15.0",
+    "@eslint/js": "^9.16.0",
     "@jest/globals": "^29.7.0",
     "@types/jest": "^29.5.14",
-    "eslint": "^9.15.0",
-    "eslint-plugin-jsdoc": "^50.5.0",
+    "eslint": "^9.16.0",
+    "eslint-plugin-jsdoc": "^50.6.0",
     "eslint-plugin-unicorn": "^56.0.1",
-    "globals": "^15.12.0",
+    "globals": "^15.13.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "lefthook": "^1.8.4",
-    "prettier": "^3.3.3",
-    "typescript": "^5.6.3"
+    "lefthook": "^1.8.5",
+    "prettier": "^3.4.1",
+    "typescript": "^5.7.2"
   },
   "scripts": {
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests",

package/src/phaser/core/array_set.js

@@ -69,7 +69,7 @@ export class ArraySet {
    */
   remove(item) {
     const idx = this.list.indexOf(item);
-    if (idx > -1) {
+    if (idx !== -1) {
       this.list.splice(idx, 1);
       return item;
     }

package/src/phaser/core/device_util.js

@@ -110,6 +110,7 @@ export const checkFullScreenSupport = (device) => {
         break;
       }
     }
+    // @ts-ignore
     if (window.Element && Element.ALLOW_KEYBOARD_INPUT) {
       device.fullscreenKeyboard = true;
     }

package/src/phaser/core/dom.js

@@ -257,6 +257,7 @@ export class DOM {
    */
   getScreenOrientation(primaryFallback) {
     const screen = window.screen;
+    // @ts-ignore
     const orientation = screen.orientation || screen.mozOrientation || screen.msOrientation;
     if (orientation && typeof orientation.type === 'string') {
       // Screen Orientation API specification

package/src/phaser/core/factory.js

@@ -37,7 +37,7 @@ export class GameObjectFactory {
    * @param {boolean} addToStage - TBD.
    * @returns {Group} TBD.
    */
-  group(parent, name, addToStage) {
+  group(parent = null, name = null, addToStage = false) {
     return new Group(this.game, parent, name, addToStage);
   }
 

package/src/phaser/core/game.js

@@ -126,7 +126,10 @@ export class Game {
       this.canvas = create(this, this.width, this.height, this.config.canvasID, true);
     }
     if (this.config.canvasStyle) {
-      this.canvas.style = this.config.canvasStyle;
+      const properties = Object.keys(this.config.canvasStyle);
+      for (const property of properties) {
+        this.canvas.style[property] = this.config.canvasStyle[property];
+      }
     } else {
       this.canvas.style['-webkit-full-screen'] = 'width: 100%; height: 100%';
     }

package/src/phaser/core/input_handler.js

@@ -284,7 +284,7 @@ export class InputHandler {
     if (!this.enabled) {
       return false;
     }
-    if (pointerId === undefined) {
+    if (pointerId === undefined || pointerId === null) {
       for (let i = 0; i < 10; i += 1) {
         if (this._pointerData[i].isOver) {
           return true;
@@ -304,7 +304,7 @@ export class InputHandler {
     if (!this.enabled) {
       return false;
     }
-    if (pointerId === undefined) {
+    if (pointerId === undefined || pointerId === null) {
       for (let i = 0; i < 10; i += 1) {
         if (this._pointerData[i].isOut) {
           return true;

package/src/phaser/core/scene.js

@@ -37,8 +37,10 @@ export class Scene {
 
   /**
    * TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
    */
-  resize() {
+  resize(width, height) {
     // inherit
   }
 

package/src/phaser/core/signal.js

@@ -10,7 +10,7 @@ export class Signal {
     this.memorize = false;
     this._shouldPropagate = true;
     this.active = true;
-    this._boundDispatch = false;
+    this._boundDispatch = null;
   }
 
   /**
@@ -21,7 +21,7 @@ export class Signal {
    */
   validateListener(listener, fnName) {
     if (typeof listener !== 'function') {
-      throw new Error(
+      throw new TypeError(
         'Signal: listener is a required param of {fn}() and should be a Function.'.replace('{fn}', fnName)
       );
     }

package/src/phaser/core/time.js

@@ -12,7 +12,7 @@ export class Time {
     this.now = 0;
     this.elapsed = 0;
     this.elapsedMS = 0;
-    this.desiredFpsMult = 1.0 / 60;
+    this.desiredFpsMult = 1 / 60;
     this._desiredFps = 60;
     this.suggestedFps = this.desiredFps;
     this.advancedTiming = false;
@@ -242,6 +242,6 @@ export class Time {
    */
   set desiredFps(value) {
     this._desiredFps = value;
-    this.desiredFpsMult = 1.0 / value;
+    this.desiredFpsMult = 1 / value;
   }
 }

package/src/phaser/core/timer.js

@@ -96,7 +96,7 @@ export class Timer {
    * TBD.
    * @param {number} delay - TBD.
    */
-  start(delay) {
+  start(delay = 0) {
     if (this.running) {
       return;
     }

package/src/phaser/core/tween.js

@@ -107,7 +107,7 @@ export class Tween {
         this.properties[property] = this.target[property] || 0;
         if (!Array.isArray(this.properties[property])) {
           //  Ensures we're using numbers, not strings
-          this.properties[property] *= 1.0;
+          this.properties[property] *= 1;
         }
       }
     }
@@ -439,7 +439,7 @@ export class Tween {
         this.properties[property] = this.target[property] || 0;
         if (!Array.isArray(this.properties[property])) {
           //  Ensures we're using numbers, not strings
-          this.properties[property] *= 1.0;
+          this.properties[property] *= 1;
         }
       }
     }

package/src/phaser/display/button.js

@@ -22,6 +22,7 @@ export class Button extends Image {
    * @param {string} outFrame - TBD.
    * @param {string} downFrame - TBD.
    * @param {string} upFrame - TBD.
+   * @param {string} disabledFrame - TBD.
    */
   constructor(
     game,
@@ -33,7 +34,8 @@ export class Button extends Image {
     overFrame = null,
     outFrame = null,
     downFrame = null,
-    upFrame = null
+    upFrame = null,
+    disabledFrame = null
   ) {
     super(game, x, y, key, outFrame);
     this.type = BUTTON;
@@ -53,7 +55,7 @@ export class Button extends Image {
     this.input = new InputHandler(this);
     this.input.start(0, true);
     this.input.useHandCursor = true;
-    this.setFrames(overFrame, outFrame, downFrame, upFrame);
+    this.setFrames(overFrame, outFrame, downFrame, upFrame, disabledFrame);
     if (callback !== null) {
       this.onInputUp.add(callback, callbackContext);
     }
@@ -95,7 +97,7 @@ export class Button extends Image {
    * @param {boolean} isEnabled - TBD.
    * @param {boolean} isImmediate - TBD.
    */
-  setEnabled(isEnabled, isImmediate) {
+  setEnabled(isEnabled, isImmediate = false) {
     this.input.enabled = isEnabled;
     if (isImmediate) {
       this.changeStateFrame(isEnabled ? STATE_UP : STATE_DISABLED);
@@ -110,7 +112,7 @@ export class Button extends Image {
    * TBD.
    */
   clearFrames() {
-    this.setFrames(null, null, null, null);
+    this.setFrames(null, null, null, null, null);
   }
 
   /**

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

@@ -42,6 +42,7 @@ export const setBackgroundColor = (canvas, color) => {
  */
 export const setTouchAction = (canvas, value = 'none') => {
   value = value || 'none';
+  // @ts-ignore
   canvas.style.msTouchAction = value;
   canvas.style['ms-touch-action'] = value;
   canvas.style['touch-action'] = value;

package/src/phaser/display/display_object.js

@@ -32,6 +32,8 @@ export class DisplayObject {
     this.cachedBounds = new Rectangle(0, 0, 0, 0);
     this.currentBounds = null;
     this._mask = null;
+    this._filters = null;
+    this._filterBlock = null;
     this.children = [];
     this.ignoreChildInput = false;
   }

package/src/phaser/display/graphics.js

@@ -223,7 +223,7 @@ export class Graphics extends DisplayObject {
     const a2 = y2 - y1;
     const b2 = x2 - x1;
     const mm = Math.abs(a1 * b2 - b1 * a2);
-    if (mm < 1.0e-8 || radius === 0) {
+    if (mm < 1e-8 || radius === 0) {
       if (points[points.length - 2] !== x1 || points[points.length - 1] !== y1) {
         points.push(x1, y1);
       }

package/src/phaser/display/group.js

@@ -14,7 +14,7 @@ export class Group extends DisplayObject {
    * @param {string} name - TBD.
    * @param {boolean} addToStage - TBD.
    */
-  constructor(game, parent = null, name = 'group', addToStage = false) {
+  constructor(game, parent = null, name = null, addToStage = false) {
     super();
     this.game = game;
     this.type = GROUP;

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

@@ -1,10 +1,10 @@
-import { Rectangle } from '../../geom/rectangle.js';
+import { RENDER_WEBGL } from '../../core/const.js';
 import { Point } from '../../geom/point.js';
-import { Texture } from './texture.js';
+import { Rectangle } from '../../geom/rectangle.js';
+import { CanvasBuffer } from '../canvas/buffer.js';
 import { BaseTexture } from './base_texture.js';
 import { FilterTexture } from './filter_texture.js';
-import { CanvasBuffer } from '../canvas/buffer.js';
-import { RENDER_WEBGL } from '../../core/const.js';
+import { Texture } from './texture.js';
 
 export class RenderTexture extends Texture {
   /**
@@ -34,6 +34,7 @@ export class RenderTexture extends Texture {
     this.crop = new Rectangle(0, 0, this.width * this.resolution, this.height * this.resolution);
     this.renderer = renderer;
     if (this.renderer.type === RENDER_WEBGL) {
+      // @ts-ignore
       const gl = this.renderer.gl;
       this.baseTexture._dirty[gl.id] = false;
       this.textureBuffer = new FilterTexture(gl, this.width, this.height, this.baseTexture.scaleMode);

package/src/phaser/display/webgl/shader/complex.js

@@ -11,6 +11,7 @@ export class ComplexPrimitiveShader {
   constructor(gl) {
     this.gl = gl;
     this._UID = uuidv4();
+    /** @type {WebGLProgram} */
     this.program = null;
     this.fragmentSrc = [
       'precision mediump float;',

package/src/phaser/display/webgl/shader/fast.js

@@ -11,6 +11,7 @@ export class FastShader {
   constructor(gl) {
     this.gl = gl;
     this._UID = uuidv4();
+    /** @type {WebGLProgram} */
     this.program = null;
     this.textureCount = 0;
     this.fragmentSrc = [

package/src/phaser/display/webgl/shader/normal.js

@@ -31,6 +31,7 @@ export class NormalShader {
   constructor(gl) {
     this.gl = gl;
     this._UID = uuidv4();
+    /** @type {WebGLProgram} */
     this.program = null;
     this.fragmentSrc = [
       'precision lowp float;',
@@ -41,6 +42,8 @@ export class NormalShader {
       '   gl_FragColor = texture2D(uSampler, vTextureCoord) * vColor ;',
       '}',
     ];
+    /** @type {string[]} */
+    this.vertexSrc = null;
     this.textureCount = 0;
     this.firstRun = true;
     this.dirty = true;

package/src/phaser/display/webgl/shader/primitive.js

@@ -11,6 +11,7 @@ export class PrimitiveShader {
   constructor(gl) {
     this.gl = gl;
     this._UID = uuidv4();
+    /** @type {WebGLProgram} */
     this.program = null;
     this.fragmentSrc = [
       'precision mediump float;',

package/src/phaser/display/webgl/shader/strip.js

@@ -11,6 +11,7 @@ export class StripShader {
   constructor(gl) {
     this.gl = gl;
     this._UID = uuidv4();
+    /** @type {WebGLProgram} */
     this.program = null;
     this.fragmentSrc = [
       'precision mediump float;',

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

@@ -26,7 +26,7 @@ export class WebGLShaderManager {
 
   /**
    * TBD.
-   * @param {WebGLRenderingContext} gl - TBD.
+   * @param {WebGLRenderingContext & { id: number }} gl - TBD.
    */
   setContext(gl) {
     this.gl = gl;

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

@@ -30,7 +30,7 @@ export class Texture {
       this.noFrame = true;
       frame = new Rectangle(0, 0, 1, 1);
     }
-    if (baseTexture && baseTexture.baseTexture) {
+    if (baseTexture instanceof Texture) {
       baseTexture = baseTexture.baseTexture;
     }
     this.baseTexture = baseTexture;

package/src/phaser/geom/circle.test.js

@@ -0,0 +1,198 @@
+import { Circle } from './circle.js';
+import { Point } from './point.js';
+
+describe('Circle', () => {
+  describe('constructor', () => {
+    it('should initialize properties correctly when no arguments are provided', () => {
+      const circle = new Circle();
+      expect(circle.x).toBe(0);
+      expect(circle.y).toBe(0);
+      expect(circle.diameter).toBe(0);
+    });
+
+    it('should initialize properties correctly when x, y, and diameter are provided', () => {
+      const circle = new Circle(10, 20, 30);
+      expect(circle.x).toBe(10);
+      expect(circle.y).toBe(20);
+      expect(circle.diameter).toBe(30);
+    });
+  });
+
+  describe('circumference', () => {
+    it('should calculate the circumference correctly when diameter is provided', () => {
+      const circle = new Circle(0, 0, 1);
+      expect(circle.circumference()).toBeCloseTo(Math.PI);
+    });
+
+    it('should return Infinity when diameter is 0', () => {
+      const circle = new Circle();
+      circle.diameter = 0;
+      expect(circle.circumference()).toBe(0);
+    });
+  });
+
+  describe('random', () => {
+    it('should generate a random point within the circle correctly', () => {
+      const circle = new Circle();
+      const output = new Point();
+      circle.random(output);
+      expect(output.x).toBeGreaterThan(-1);
+      expect(output.y).toBeGreaterThan(-1);
+      expect(Math.hypot(output.x, output.y)).toBe(0);
+    });
+
+    it('should generate a random point within the circle correctly when output is not provided', () => {
+      const circle = new Circle();
+      const output = new Point();
+      circle.random(output);
+      expect(output.x).toBeGreaterThan(-1);
+      expect(output.y).toBeGreaterThan(-1);
+      expect(Math.hypot(output.x, output.y)).toBe(0);
+    });
+  });
+
+  describe('getBounds', () => {
+    it('should calculate the bounds correctly when diameter is provided', () => {
+      const circle = new Circle(0, 0, 1);
+      const bounds = circle.getBounds();
+      expect(bounds.x).toBe(-0.5);
+      expect(bounds.y).toBe(-0.5);
+      expect(bounds.width).toBe(1);
+      expect(bounds.height).toBe(1);
+    });
+
+    it('should return empty rectangle when diameter is 0', () => {
+      const circle = new Circle();
+      circle.diameter = 0;
+      const bounds = circle.getBounds();
+      expect(bounds.x).toBe(0);
+      expect(bounds.y).toBe(0);
+      expect(bounds.width).toBe(0);
+      expect(bounds.height).toBe(0);
+    });
+  });
+
+  describe('setTo', () => {
+    it('should set properties correctly when x, y, and diameter are provided', () => {
+      const circle = new Circle();
+      circle.setTo(10, 20, 30);
+      expect(circle.x).toBe(10);
+      expect(circle.y).toBe(20);
+      expect(circle.diameter).toBe(30);
+    });
+
+    it('should set radius property correctly when diameter is changed', () => {
+      const circle = new Circle();
+      circle.diameter = 1;
+      expect(circle.radius).toBe(0.5);
+    });
+  });
+
+  describe('copyFrom', () => {
+    it('should copy properties correctly from another Circle instance', () => {
+      const source = new Circle(10, 20, 30);
+      const dest = new Circle();
+      dest.copyFrom(source);
+      expect(dest.x).toBe(source.x);
+      expect(dest.y).toBe(source.y);
+      expect(dest.diameter).toBe(source.diameter);
+    });
+  });
+
+  describe('copyTo', () => {
+    it('should copy properties correctly to another Circle instance', () => {
+      const source = new Circle(10, 20, 30);
+      const dest = new Circle();
+      source.copyTo(dest);
+      expect(dest.x).toBe(source.x);
+      expect(dest.y).toBe(source.y);
+      expect(dest.diameter).toBe(source.diameter);
+    });
+  });
+
+  describe('distance', () => {
+    it('should calculate the distance correctly between two points within a circle', () => {
+      const circle = new Circle();
+      const point = new Point(1, 1);
+      expect(circle.distance(point)).toBeCloseTo(Math.hypot(point.x, point.y));
+    });
+
+    it('should return Infinity when diameter is 0', () => {
+      const circle = new Circle();
+      circle.diameter = 0;
+      expect(circle.distance(new Point(1, 1))).toBeCloseTo(1.4142);
+    });
+  });
+
+  describe('clone', () => {
+    it('should create a deep copy of the Circle instance correctly', () => {
+      const source = new Circle(10, 20, 30);
+      const clone = source.clone();
+      expect(clone.x).toBe(source.x);
+      expect(clone.y).toBe(source.y);
+      expect(clone.diameter).toBe(source.diameter);
+    });
+  });
+
+  describe('contains', () => {
+    it('should determine if a point is within the circle correctly', () => {
+      const circle = new Circle();
+      const point = new Point(1, 1);
+      expect(circle.contains(point.x, point.y)).toBe(false);
+    });
+
+    it('should return false when diameter is 0', () => {
+      const circle = new Circle();
+      circle.diameter = 0;
+      expect(circle.contains(1, 1)).toBe(false);
+    });
+  });
+
+  describe('circumferencePoint', () => {
+    it('should generate a point on the circumference correctly', () => {
+      const circle = new Circle();
+      const output = new Point();
+      expect(circle.circumferencePoint(Math.PI / 2).x).toBeCloseTo(0.5 * circle.radius);
+    });
+
+    it('should return null when diameter is 0', () => {
+      const circle = new Circle();
+      circle.diameter = 0;
+      expect(circle.circumferencePoint(Math.PI / 2).type).toBe(25);
+    });
+  });
+
+  describe('offset', () => {
+    it('should offset the circle correctly by a point', () => {
+      const circle = new Circle();
+      const point = new Point(1, 1);
+      circle.offset(point.x, point.y);
+      expect(circle.x).toBeGreaterThan(0);
+      expect(circle.y).toBeGreaterThan(0);
+    });
+
+    it('should return the Circle instance itself', () => {
+      const circle = new Circle();
+      const point = new Point(1, 1);
+      circle.offset(point.x, point.y);
+      expect(circle).toBe(circle);
+    });
+  });
+
+  describe('offsetPoint', () => {
+    it('should offset the circle correctly by a point', () => {
+      const circle = new Circle();
+      const point = new Point(1, 1);
+      circle.offsetPoint(point);
+      expect(circle.x).toBeGreaterThan(0);
+      expect(circle.y).toBeGreaterThan(0);
+    });
+  });
+
+  describe('toString', () => {
+    it('should generate the correct string representation of the Circle instance', () => {
+      const circle = new Circle();
+      expect(circle.toString()).toBe('[{Circle (x=0 y=0 diameter=0 radius=0)}]');
+    });
+  });
+});

package/src/phaser/geom/ellipse.js

@@ -1,7 +1,7 @@
+import { GEOM_ELLIPSE } from '../core/const.js';
 import { Point } from './point.js';
 import { Rectangle } from './rectangle.js';
 import { contains } from './util/ellipse.js';
-import { GEOM_ELLIPSE } from '../core/const.js';
 
 export class Ellipse {
   /**
@@ -86,8 +86,8 @@ export class Ellipse {
     const r = Math.random();
     result.x = Math.sqrt(r) * Math.cos(p);
     result.y = Math.sqrt(r) * Math.sin(p);
-    result.x = this.x + (result.x * this.width) / 2.0;
-    result.y = this.y + (result.y * this.height) / 2.0;
+    result.x = this.x + (result.x * this.width) / 2;
+    result.y = this.y + (result.y * this.height) / 2;
     return result;
   }