@vpmedia/phaser 1.123.0 → 1.125.0

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

@@ -2,16 +2,16 @@ import { expect, describe, it } from 'vitest';
 import { Circle } from './circle.js';
 import { Point } from './point.js';
 
-describe('Circle', () => {
-  describe('constructor', () => {
-    it('should initialize properties correctly when no arguments are provided', () => {
+describe('Circle', (): void => {
+  describe('constructor', (): void => {
+    it('should initialize properties correctly when no arguments are provided', (): void => {
       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', () => {
+    it('should initialize properties correctly when x, y, and diameter are provided', (): void => {
       const circle = new Circle(10, 20, 30);
       expect(circle.x).toBe(10);
       expect(circle.y).toBe(20);
@@ -19,21 +19,21 @@ describe('Circle', () => {
     });
   });
 
-  describe('circumference', () => {
-    it('should calculate the circumference correctly when diameter is provided', () => {
+  describe('circumference', (): void => {
+    it('should calculate the circumference correctly when diameter is provided', (): void => {
       const circle = new Circle(0, 0, 1);
       expect(circle.circumference()).toBeCloseTo(Math.PI);
     });
 
-    it('should return Infinity when diameter is 0', () => {
+    it('should return Infinity when diameter is 0', (): void => {
       const circle = new Circle();
       circle.diameter = 0;
       expect(circle.circumference()).toBe(0);
     });
   });
 
-  describe('random', () => {
-    it('should generate a random point within the circle correctly', () => {
+  describe('random', (): void => {
+    it('should generate a random point within the circle correctly', (): void => {
       const circle = new Circle();
       const output = new Point();
       circle.random(output);
@@ -42,7 +42,7 @@ describe('Circle', () => {
       expect(Math.hypot(output.x, output.y)).toBe(0);
     });
 
-    it('should generate a random point within the circle correctly when output is not provided', () => {
+    it('should generate a random point within the circle correctly when output is not provided', (): void => {
       const circle = new Circle();
       const output = new Point();
       circle.random(output);
@@ -52,8 +52,8 @@ describe('Circle', () => {
     });
   });
 
-  describe('getBounds', () => {
-    it('should calculate the bounds correctly when diameter is provided', () => {
+  describe('getBounds', (): void => {
+    it('should calculate the bounds correctly when diameter is provided', (): void => {
       const circle = new Circle(0, 0, 1);
       const bounds = circle.getBounds();
       expect(bounds.x).toBe(-0.5);
@@ -62,7 +62,7 @@ describe('Circle', () => {
       expect(bounds.height).toBe(1);
     });
 
-    it('should return empty rectangle when diameter is 0', () => {
+    it('should return empty rectangle when diameter is 0', (): void => {
       const circle = new Circle();
       circle.diameter = 0;
       const bounds = circle.getBounds();
@@ -73,8 +73,8 @@ describe('Circle', () => {
     });
   });
 
-  describe('setTo', () => {
-    it('should set properties correctly when x, y, and diameter are provided', () => {
+  describe('setTo', (): void => {
+    it('should set properties correctly when x, y, and diameter are provided', (): void => {
       const circle = new Circle();
       circle.setTo(10, 20, 30);
       expect(circle.x).toBe(10);
@@ -82,15 +82,15 @@ describe('Circle', () => {
       expect(circle.diameter).toBe(30);
     });
 
-    it('should set radius property correctly when diameter is changed', () => {
+    it('should set radius property correctly when diameter is changed', (): void => {
       const circle = new Circle();
       circle.diameter = 1;
       expect(circle.radius).toBe(0.5);
     });
   });
 
-  describe('copyFrom', () => {
-    it('should copy properties correctly from another Circle instance', () => {
+  describe('copyFrom', (): void => {
+    it('should copy properties correctly from another Circle instance', (): void => {
       const source = new Circle(10, 20, 30);
       const dest = new Circle();
       dest.copyFrom(source);
@@ -100,8 +100,8 @@ describe('Circle', () => {
     });
   });
 
-  describe('copyTo', () => {
-    it('should copy properties correctly to another Circle instance', () => {
+  describe('copyTo', (): void => {
+    it('should copy properties correctly to another Circle instance', (): void => {
       const source = new Circle(10, 20, 30);
       const dest = new Circle();
       source.copyTo(dest);
@@ -111,22 +111,22 @@ describe('Circle', () => {
     });
   });
 
-  describe('distance', () => {
-    it('should calculate the distance correctly between two points within a circle', () => {
+  describe('distance', (): void => {
+    it('should calculate the distance correctly between two points within a circle', (): void => {
       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', () => {
+    it('should return Infinity when diameter is 0', (): void => {
       const circle = new Circle();
       circle.diameter = 0;
       expect(circle.distance(new Point(1, 1))).toBeCloseTo(Math.SQRT2);
     });
   });
 
-  describe('clone', () => {
-    it('should create a deep copy of the Circle instance correctly', () => {
+  describe('clone', (): void => {
+    it('should create a deep copy of the Circle instance correctly', (): void => {
       const source = new Circle(10, 20, 30);
       const clone = source.clone();
       expect(clone.x).toBe(source.x);
@@ -135,35 +135,35 @@ describe('Circle', () => {
     });
   });
 
-  describe('contains', () => {
-    it('should determine if a point is within the circle correctly', () => {
+  describe('contains', (): void => {
+    it('should determine if a point is within the circle correctly', (): void => {
       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', () => {
+    it('should return false when diameter is 0', (): void => {
       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', () => {
+  describe('circumferencePoint', (): void => {
+    it('should generate a point on the circumference correctly', (): void => {
       const circle = new Circle();
       expect(circle.circumferencePoint(Math.PI / 2).x).toBeCloseTo(0.5 * circle.radius);
     });
 
-    it('should return null when diameter is 0', () => {
+    it('should return null when diameter is 0', (): void => {
       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', () => {
+  describe('offset', (): void => {
+    it('should offset the circle correctly by a point', (): void => {
       const circle = new Circle();
       const point = new Point(1, 1);
       circle.offset(point.x, point.y);
@@ -171,7 +171,7 @@ describe('Circle', () => {
       expect(circle.y).toBeGreaterThan(0);
     });
 
-    it('should return the Circle instance itself', () => {
+    it('should return the Circle instance itself', (): void => {
       const circle = new Circle();
       const point = new Point(1, 1);
       circle.offset(point.x, point.y);
@@ -179,8 +179,8 @@ describe('Circle', () => {
     });
   });
 
-  describe('offsetPoint', () => {
-    it('should offset the circle correctly by a point', () => {
+  describe('offsetPoint', (): void => {
+    it('should offset the circle correctly by a point', (): void => {
       const circle = new Circle();
       const point = new Point(1, 1);
       circle.offsetPoint(point);
@@ -189,8 +189,8 @@ describe('Circle', () => {
     });
   });
 
-  describe('toString', () => {
-    it('should generate the correct string representation of the Circle instance', () => {
+  describe('toString', (): void => {
+    it('should generate the correct string representation of the Circle instance', (): void => {
       const circle = new Circle();
       expect(circle.toString()).toBe('[{Circle (x=0 y=0 diameter=0 radius=0)}]');
     });

package/src/phaser/geom/circle.ts

@@ -182,7 +182,7 @@ export class Circle {
   /**
    * Sets the diameter of this circle.
    */
-  public set diameter(value) {
+  public set diameter(value: number) {
     if (value > 0) {
       this._diameter = value;
       this._radius = value * 0.5;
@@ -200,7 +200,7 @@ export class Circle {
   /**
    * Sets the radius of this circle.
    */
-  public set radius(value) {
+  public set radius(value: number) {
     if (value > 0) {
       this._radius = value;
       this._diameter = value * 2;
@@ -218,7 +218,7 @@ export class Circle {
   /**
    * Sets the left coordinate of this circle.
    */
-  public set left(value) {
+  public set left(value: number) {
     if (value > this.x) {
       this._radius = 0;
       this._diameter = 0;
@@ -238,7 +238,7 @@ export class Circle {
   /**
    * Sets the right coordinate of this circle.
    */
-  public set right(value) {
+  public set right(value: number) {
     if (value < this.x) {
       this._radius = 0;
       this._diameter = 0;
@@ -258,7 +258,7 @@ export class Circle {
   /**
    * Sets the top coordinate of this circle.
    */
-  public set top(value) {
+  public set top(value: number) {
     if (value > this.y) {
       this._radius = 0;
       this._diameter = 0;
@@ -278,7 +278,7 @@ export class Circle {
   /**
    * Sets the bottom coordinate of this circle.
    */
-  public set bottom(value) {
+  public set bottom(value: number) {
     if (value < this.y) {
       this._radius = 0;
       this._diameter = 0;
@@ -309,7 +309,7 @@ export class Circle {
   /**
    * Sets whether this circle is empty (zero diameter).
    */
-  public set empty(value) {
+  public set empty(value: boolean) {
     if (value) {
       this.setTo(0, 0, 0);
     }

package/src/phaser/geom/ellipse.test.ts

@@ -1,8 +1,8 @@
 import { describe, expect, it } from 'vitest';
 import { Ellipse } from './ellipse.js';
 
-describe('Ellipse', () => {
-  it('should create an ellipse with default values', () => {
+describe('Ellipse', (): void => {
+  it('should create an ellipse with default values', (): void => {
     const ellipse = new Ellipse();
     expect(ellipse.x).toBe(0);
     expect(ellipse.y).toBe(0);
@@ -10,7 +10,7 @@ describe('Ellipse', () => {
     expect(ellipse.height).toBe(0);
   });
 
-  it('should create an ellipse with custom x, y, width, height', () => {
+  it('should create an ellipse with custom x, y, width, height', (): void => {
     const ellipse = new Ellipse(10, 20, 30, 40);
     expect(ellipse.x).toBe(10);
     expect(ellipse.y).toBe(20);
@@ -18,7 +18,7 @@ describe('Ellipse', () => {
     expect(ellipse.height).toBe(40);
   });
 
-  it('should set the ellipse values to new x, y, width, height', () => {
+  it('should set the ellipse values to new x, y, width, height', (): void => {
     const ellipse = new Ellipse();
     ellipse.setTo(10, 20, 30, 40);
     expect(ellipse.x).toBe(10);
@@ -27,13 +27,13 @@ describe('Ellipse', () => {
     expect(ellipse.height).toBe(40);
   });
 
-  it('should return the ellipse instance', () => {
+  it('should return the ellipse instance', (): void => {
     const ellipse = new Ellipse();
     const result = ellipse.setTo(10, 20, 30, 40);
     expect(result).toBe(ellipse);
   });
 
-  it('should create a rectangle with correct bounds', () => {
+  it('should create a rectangle with correct bounds', (): void => {
     const ellipse = new Ellipse(10, 20, 30, 40);
     const bounds = ellipse.getBounds();
     expect(bounds.x).toBe(10 - 30);
@@ -42,7 +42,7 @@ describe('Ellipse', () => {
     expect(bounds.height).toBe(40);
   });
 
-  it('should copy the values from another ellipse', () => {
+  it('should copy the values from another ellipse', (): void => {
     const source = new Ellipse(10, 20, 30, 40);
     const target = new Ellipse();
     target.copyFrom(source);
@@ -52,7 +52,7 @@ describe('Ellipse', () => {
     expect(target.height).toBe(source.height);
   });
 
-  it('should copy the values to another ellipse', () => {
+  it('should copy the values to another ellipse', (): void => {
     const source = new Ellipse(10, 20, 30, 40);
     const target = new Ellipse();
     source.copyTo(target);
@@ -62,24 +62,24 @@ describe('Ellipse', () => {
     expect(target.height).toBe(source.height);
   });
 
-  it('should return true if point is inside the ellipse', () => {
+  it('should return true if point is inside the ellipse', (): void => {
     const ellipse = new Ellipse(10, 20, 30, 40);
     expect(ellipse.contains(20, 30)).toBe(true);
   });
 
-  it('should return false if point is outside the ellipse', () => {
+  it('should return false if point is outside the ellipse', (): void => {
     const ellipse = new Ellipse(10, 20, 30, 40);
     expect(ellipse.contains(-5, -10)).toBe(false);
   });
 
-  it('should generate a random point within the ellipse', () => {
+  it('should generate a random point within the ellipse', (): void => {
     const ellipse = new Ellipse(10, 20, 30, 40);
     const point = ellipse.random();
     expect(point.x).toBeTypeOf('number');
     expect(point.y).toBeTypeOf('number');
   });
 
-  it('should return a string representation of the ellipse', () => {
+  it('should return a string representation of the ellipse', (): void => {
     const ellipse = new Ellipse(10, 20, 30, 40);
     expect(ellipse.toString()).toBe('[{Ellipse (x=10 y=20 width=30 height=40)}]');
   });

package/src/phaser/geom/line.test.ts

@@ -2,8 +2,8 @@ import { expect, describe, it } from 'vitest';
 import { degToRad } from '../util/math.js';
 import { Line } from './line.js';
 
-describe('Line', () => {
-  it('should create a new line instance with correct coordinates', () => {
+describe('Line', (): void => {
+  it('should create a new line instance with correct coordinates', (): void => {
     const line = new Line(0, 0, 10, 10);
     expect(line.start.x).toBe(0);
     expect(line.start.y).toBe(0);
@@ -11,7 +11,7 @@ describe('Line', () => {
     expect(line.end.y).toBe(10);
   });
 
-  it('should set the start and end points of the line correctly', () => {
+  it('should set the start and end points of the line correctly', (): void => {
     const line = new Line(0, 0, 10, 10);
     line.setTo(5, 5, 15, 15);
     expect(line.start.x).toBe(5);
@@ -20,7 +20,7 @@ describe('Line', () => {
     expect(line.end.y).toBe(15);
   });
 
-  it('should create a new line instance from two sprites correctly', () => {
+  it('should create a new line instance from two sprites correctly', (): void => {
     const line = new Line(0, 0, 10, 10);
     const sprite1 = { x: 0, y: 0 };
     const sprite2 = { x: 10, y: 10 };
@@ -31,7 +31,7 @@ describe('Line', () => {
     expect(result.end.y).toBe(10);
   });
 
-  it('should create a new line instance from an angle and length correctly', () => {
+  it('should create a new line instance from an angle and length correctly', (): void => {
     const line = new Line(0, 10, 10, 10);
     const result = line.fromAngle(0, 0, degToRad(45), 10);
     expect(result.start.x).toBe(0);
@@ -40,7 +40,7 @@ describe('Line', () => {
     expect(result.end.y).toBeCloseTo(7.07);
   });
 
-  it('should rotate the line correctly', () => {
+  it('should rotate the line correctly', (): void => {
     const line = new Line(0, 0, 10, 0);
     const result = line.rotate(90, true);
     expect(result.start.x).toBe(5);
@@ -49,7 +49,7 @@ describe('Line', () => {
     expect(result.end.y).toBe(5);
   });
 
-  it('should rotate the line around a point correctly', () => {
+  it('should rotate the line around a point correctly', (): void => {
     const line = new Line(0, 0, 10, 10);
     const result = line.rotateAround(5, 5, 90, true);
     expect(result.start.x).toBe(10);
@@ -58,54 +58,54 @@ describe('Line', () => {
     expect(result.end.y).toBe(10);
   });
 
-  it('should intersect the line with another line correctly', () => {
+  it('should intersect the line with another line correctly', (): void => {
     const line = new Line(0, 0, 10, 10);
     const line2 = new Line(5, 5, 15, 15);
     const result = line.intersects(line2, true, null);
     expect(result).toBeNull();
   });
 
-  it('should reflect the line across another line correctly', () => {
+  it('should reflect the line across another line correctly', (): void => {
     const line = new Line(0, 0, 10, 10);
     const line2 = new Line(5, 5, 15, 15);
     const result = line.reflect(line2);
     expect(result).toBeCloseTo(-5.497);
   });
 
-  it('should get the midpoint of the line correctly', () => {
+  it('should get the midpoint of the line correctly', (): void => {
     const line = new Line(0, 0, 10, 10);
     const result = line.midPoint(null);
     expect(result.x).toBe(5);
     expect(result.y).toBe(5);
   });
 
-  it('should center the line on a point correctly', () => {
+  it('should center the line on a point correctly', (): void => {
     const line = new Line(0, 0, 10, 10);
     line.centerOn(10, 10);
     expect(line.start.x).toBe(10 - (line.end.x - line.start.x) / 2);
     expect(line.start.y).toBe(10 - (line.end.y - line.start.y) / 2);
   });
 
-  it('should check if a point is on the line correctly', () => {
+  it('should check if a point is on the line correctly', (): void => {
     const line = new Line(0, 0, 10, 10);
     expect(line.pointOnLine(5, 0)).toBe(false);
     expect(line.pointOnLine(-5, 0)).toBe(false);
   });
 
-  it('should check if a point is on the segment of the line correctly', () => {
+  it('should check if a point is on the segment of the line correctly', (): void => {
     const line = new Line(0, 0, 10, 10);
     expect(line.pointOnSegment(5, -10)).toBe(false);
     expect(line.pointOnSegment(15, 15)).toBe(false);
   });
 
-  it('should get the random point on the line correctly', () => {
+  it('should get the random point on the line correctly', (): void => {
     const line = new Line(0, 0, 10, 10);
     const result = line.random(null);
     expect(result.x).toBeGreaterThan(0);
     expect(result.y).toBeGreaterThan(0);
   });
 
-  it('should get the coordinates on the line correctly', () => {
+  it('should get the coordinates on the line correctly', (): void => {
     const line = new Line(0, 0, 10, 10);
     const result = line.coordinatesOnLine(1, []);
     expect(result.length).toBeGreaterThan(0);

package/src/phaser/geom/line.ts

@@ -3,6 +3,9 @@ import { clone, intersectsPoints, reflect } from './util/line.js';
 import { wrap } from '../util/math.js';
 import { GEOM_LINE } from '../core/const.js';
 
+/** Anything a line can read a position from: a display object, a point, or a plain x/y pair. */
+export type LineAnchor = { x: number; y: number; center?: { x: number; y: number } };
+
 export class Line {
   public start: Point;
   public end: Point;
@@ -45,9 +48,9 @@ export class Line {
    * @param {boolean} useCenter - Whether to use the center of the sprites (default: false).
    * @returns {Line} This line instance for chaining.
    */
-  public fromSprite(startSprite: any, endSprite: any, useCenter = false): this {
+  public fromSprite(startSprite: LineAnchor, endSprite: LineAnchor, useCenter = false): this {
     if (useCenter) {
-      return this.setTo(startSprite.center.x, startSprite.center.y, endSprite.center.x, endSprite.center.y);
+      return this.setTo(startSprite.center!.x, startSprite.center!.y, endSprite.center!.x, endSprite.center!.y);
     }
     return this.setTo(startSprite.x, startSprite.y, endSprite.x, endSprite.y);
   }