@vpmedia/phaser 1.115.0 → 1.117.0

package/src/phaser/core/dom.ts

@@ -6,7 +6,7 @@ class VisualBoundsDesktopRectangle {
    * Gets the horizontal scroll position of the window.
    * @returns {number} The horizontal scroll position in pixels.
    */
-  public get x() {
+  public get x(): number {
     return globalThis && 'pageXOffset' in globalThis ? window.pageXOffset : document.documentElement.scrollLeft;
   }
 
@@ -14,7 +14,7 @@ class VisualBoundsDesktopRectangle {
    * Gets the vertical scroll position of the window.
    * @returns {number} The vertical scroll position in pixels.
    */
-  public get y() {
+  public get y(): number {
     return globalThis && 'pageYOffset' in globalThis ? window.pageYOffset : document.documentElement.scrollTop;
   }
 
@@ -22,7 +22,7 @@ class VisualBoundsDesktopRectangle {
    * Gets the width of the window.
    * @returns {number} The width of the window in pixels.
    */
-  public get width() {
+  public get width(): number {
     return Math.max(window.innerWidth, document.documentElement.clientWidth);
   }
 
@@ -30,7 +30,7 @@ class VisualBoundsDesktopRectangle {
    * Gets the height of the window.
    * @returns {number} The height of the window in pixels.
    */
-  public get height() {
+  public get height(): number {
     return Math.max(window.innerHeight, document.documentElement.clientHeight);
   }
 }
@@ -52,7 +52,7 @@ class LayoutBoundsDesktopRectangle {
    * Gets the width of the window.
    * @returns {number} The width of the window in pixels.
    */
-  public get width() {
+  public get width(): number {
     return Math.max(window.innerWidth, document.documentElement.clientWidth);
   }
 
@@ -60,7 +60,7 @@ class LayoutBoundsDesktopRectangle {
    * Gets the height of the window.
    * @returns {number} The height of the window in pixels.
    */
-  public get height() {
+  public get height(): number {
     return Math.max(window.innerHeight, document.documentElement.clientHeight);
   }
 }
@@ -70,7 +70,7 @@ class VisualBoundsRectangle {
    * Gets the horizontal scroll position of the document.
    * @returns {number} The horizontal scroll position in pixels.
    */
-  public get x() {
+  public get x(): number {
     return globalThis && 'pageXOffset' in globalThis ? window.pageXOffset : document.documentElement.scrollLeft;
   }
 
@@ -78,7 +78,7 @@ class VisualBoundsRectangle {
    * Gets the vertical scroll position of the document.
    * @returns {number} The vertical scroll position in pixels.
    */
-  public get y() {
+  public get y(): number {
     return globalThis && 'pageYOffset' in globalThis ? window.pageYOffset : document.documentElement.scrollTop;
   }
 
@@ -86,7 +86,7 @@ class VisualBoundsRectangle {
    * TBD.
    * @returns {number} TBD.
    */
-  public get width() {
+  public get width(): number {
     return window.innerWidth;
   }
 
@@ -94,7 +94,7 @@ class VisualBoundsRectangle {
    * TBD.
    * @returns {number} TBD.
    */
-  public get height() {
+  public get height(): number {
     return window.innerHeight;
   }
 }
@@ -116,7 +116,7 @@ class LayoutBoundsRectangle {
    * TBD.
    * @returns {number} TBD.
    */
-  public get width() {
+  public get width(): number {
     const a = document.documentElement.clientWidth;
     const b = window.innerWidth;
     return a < b ? b : a; // max
@@ -126,7 +126,7 @@ class LayoutBoundsRectangle {
    * TBD.
    * @returns {number} TBD.
    */
-  public get height() {
+  public get height(): number {
     const a = document.documentElement.clientHeight;
     const b = window.innerHeight;
     return a < b ? b : a; // max
@@ -153,7 +153,7 @@ class DocumentBoundsRectangle {
    * TBD.
    * @returns {number} TBD.
    */
-  public get width() {
+  public get width(): number {
     const d = document.documentElement;
     return Math.max(d.clientWidth, d.offsetWidth, d.scrollWidth);
   }
@@ -162,7 +162,7 @@ class DocumentBoundsRectangle {
    * TBD.
    * @returns {number} TBD.
    */
-  public get height() {
+  public get height(): number {
     const d = document.documentElement;
     return Math.max(d.clientHeight, d.offsetHeight, d.scrollHeight);
   }
@@ -189,9 +189,13 @@ export class DOM {
     this.layoutBounds = this.treatAsDesktop ? new LayoutBoundsDesktopRectangle() : new LayoutBoundsRectangle();
     this.documentBounds = new DocumentBoundsRectangle();
     this.scrollXProvider =
-      globalThis && 'pageXOffset' in globalThis ? () => window.pageXOffset : () => document.documentElement.scrollLeft;
+      globalThis && 'pageXOffset' in globalThis
+        ? (): number => window.pageXOffset
+        : (): number => document.documentElement.scrollLeft;
     this.scrollYProvider =
-      globalThis && 'pageYOffset' in globalThis ? () => window.pageYOffset : () => document.documentElement.scrollTop;
+      globalThis && 'pageYOffset' in globalThis
+        ? (): number => window.pageYOffset
+        : (): number => document.documentElement.scrollTop;
   }
 
   /**
@@ -200,7 +204,7 @@ export class DOM {
    * @param {Point} point - Optional Point object to store the result.
    * @returns {Point} The offset position of the element.
    */
-  public getOffset(element: HTMLCanvasElement, point: Point | null = null) {
+  public getOffset(element: HTMLCanvasElement, point: Point | null = null): Point {
     point = point ?? new Point();
     const box = element.getBoundingClientRect();
     const scrollTop = this.scrollY;
@@ -251,7 +255,7 @@ export class DOM {
    * @param {string} primaryFallback - The fallback method to use if screen orientation API is not available.
    * @returns {string} The screen orientation ('portrait-primary', 'landscape-primary', etc.).
    */
-  public getScreenOrientation(primaryFallback: string | null = null) {
+  public getScreenOrientation(primaryFallback: string | null = null): OrientationType {
     const { screen } = globalThis;
     // @ts-expect-error
     const orientation = screen.orientation || screen.mozOrientation || screen.msOrientation;
@@ -285,7 +289,7 @@ export class DOM {
    * Gets the horizontal scroll position of the window.
    * @returns {number} The horizontal scroll position in pixels.
    */
-  public get scrollX() {
+  public get scrollX(): number {
     return this.scrollXProvider();
   }
 
@@ -293,7 +297,7 @@ export class DOM {
    * Gets the vertical scroll position of the window.
    * @returns {number} The vertical scroll position in pixels.
    */
-  public get scrollY() {
+  public get scrollY(): number {
     return this.scrollYProvider();
   }
 
@@ -301,7 +305,7 @@ export class DOM {
    * Gets the width of the window's client area.
    * @returns {number} The width of the client area in pixels.
    */
-  public get clientWidth() {
+  public get clientWidth(): number {
     return Math.max(window.innerWidth, document.documentElement.clientWidth);
   }
 
@@ -309,7 +313,7 @@ export class DOM {
    * Gets the height of the window's client area.
    * @returns {number} The height of the client area in pixels.
    */
-  public get clientHeight() {
+  public get clientHeight(): number {
     return Math.max(window.innerHeight, document.documentElement.clientHeight);
   }
 }

package/src/phaser/core/factory.ts

@@ -25,7 +25,7 @@ export class GameObjectFactory {
    * @param {Group} group - The parent group for the image.
    * @returns {Image} The created Image object.
    */
-  public image(x: number, y: number, key: string, frame: any, group: Group | null = null) {
+  public image(x: number, y: number, key: string, frame: any, group: Group | null = null): Image {
     const target = group ?? this.game.world;
     return target.add(new Image(this.game, x, y, key, frame));
   }
@@ -37,7 +37,7 @@ export class GameObjectFactory {
    * @param {boolean} addToStage - Whether to add the group to the stage.
    * @returns {Group} The created Group object.
    */
-  public group(parent: Group | null = null, name: string | null = null, addToStage = false) {
+  public group(parent: Group | null = null, name: string | null = null, addToStage = false): Group {
     return new Group(this.game, parent, name, addToStage);
   }
 
@@ -50,7 +50,7 @@ export class GameObjectFactory {
    * @param {Group | null} group - The parent group for the text.
    * @returns {Text} The created Text object.
    */
-  public text(x: number, y: number, text: any, style: any, group: Group | null = null) {
+  public text(x: number, y: number, text: any, style: any, group: Group | null = null): Text {
     const parent = group ?? this.game.world;
     return parent.add(new Text(this.game, x, y, text, style));
   }
@@ -80,7 +80,7 @@ export class GameObjectFactory {
     downFrame: string | null = null,
     upFrame: string | null = null,
     group: Group | null = null
-  ) {
+  ): Button {
     const parent = group ?? this.game.world;
     return parent.add(
       new Button(this.game, x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame)
@@ -94,7 +94,7 @@ export class GameObjectFactory {
    * @param {Group | null} group - The parent group for the graphics object.
    * @returns {Graphics} The created Graphics object.
    */
-  public graphics(x = 0, y = 0, group: Group | null = null) {
+  public graphics(x = 0, y = 0, group: Group | null = null): Graphics {
     const parent = group ?? this.game.world;
     return parent.add(new Graphics(this.game, x, y));
   }
@@ -118,7 +118,7 @@ export class GameObjectFactory {
     size: number,
     group: Group | null = null,
     align = 'left'
-  ) {
+  ): BitmapText {
     const parent = group ?? this.game.world;
     return parent.add(new BitmapText(this.game, x, y, font, text, size, align));
   }

package/src/phaser/core/game.ts

@@ -101,7 +101,7 @@ export class Game {
     } else {
       window.addEventListener(
         'load',
-        () => {
+        (): void => {
           initialize(this.device);
           this.boot();
         },
@@ -113,7 +113,7 @@ export class Game {
   /**
    * Boots the game and initializes all systems.
    */
-  public boot() {
+  public boot(): void {
     if (this.isBooted) {
       return;
     }
@@ -149,7 +149,7 @@ export class Game {
   /**
    * Creates the renderer canvas element.
    */
-  public createRendererCanvas() {
+  public createRendererCanvas(): void {
     this.logger.info('createRendererCanvas');
     if (this.canvas) {
       removeFromDOM(this.canvas);
@@ -172,7 +172,7 @@ export class Game {
   /**
    * Initializes the renderer and sets up the rendering context.
    */
-  public initRenderer() {
+  public initRenderer(): void {
     let isWebGlReady = false;
     if (this.config.renderType === RENDER_AUTO || this.config.renderType === RENDER_WEBGL) {
       try {
@@ -223,7 +223,7 @@ export class Game {
    * @param {string} key - The configuration key to parse.
    * @param {*} defaultValue - The default value if the key is not found in config.
    */
-  public parseConfigElement(config: any, key: string, defaultValue?: any) {
+  public parseConfigElement(config: any, key: string, defaultValue?: any): void {
     if (config[key] !== undefined) {
       this.config[key] = config[key];
     } else {
@@ -235,7 +235,7 @@ export class Game {
    * Parses the configuration object and sets up game properties.
    * @param {object} config - The configuration object to parse.
    */
-  public parseConfig(config: any) {
+  public parseConfig(config: any): void {
     this.logger = config.logger ?? getLogger(['phaser']);
     this.logger.info('parseConfig');
     this.parseConfigElement(config, 'width', 800);
@@ -266,7 +266,7 @@ export class Game {
    * Called when the WebGL context is lost.
    * @param {WebGLContextEvent | Event} event - The WebGL context loss event.
    */
-  public contextLost(event: any) {
+  public contextLost(event: any): void {
     this.logger.info('contextLost', event);
     event.preventDefault();
     if (this.renderer) {
@@ -278,7 +278,7 @@ export class Game {
    * Called when the WebGL context is restored.
    * @param {WebGLContextEvent | Event} event - The WebGL context restore event.
    */
-  public contextRestored(event: any) {
+  public contextRestored(event: any): void {
     this.logger.info('contextRestored', event);
     if (this.renderer) {
       this.renderer.initContext(this);
@@ -291,7 +291,7 @@ export class Game {
    * Updates the game state.
    * @param {number} time - The current timestamp.
    */
-  public update(time: number) {
+  public update(time: number): void {
     this.time.update(time);
     if (!this.isPaused) {
       this.scale.preUpdate();
@@ -314,7 +314,7 @@ export class Game {
   /**
    * Destroys the game and cleans up all resources.
    */
-  public destroy() {
+  public destroy(): void {
     this.logger.info('destroy');
     this.isPaused = true;
 

package/src/phaser/core/input.ts

@@ -19,11 +19,11 @@ const MAX_POINTERS = 10;
 export class Input {
   public game!: Game;
   public hitCanvas!: HTMLCanvasElement;
-  public hitContext!: any;
-  public moveCallbacks!: { callback: Function; context: CanvasRenderingContext2D }[];
-  public lockCallbacks!: any;
-  public customCandidateHandler!: any;
-  public customCandidateHandlerContext!: any;
+  public hitContext!: CanvasRenderingContext2D | null;
+  public moveCallbacks!: { callback: Function; context: unknown }[];
+  public lockCallbacks!: unknown[];
+  public customCandidateHandler!: Function | null;
+  public customCandidateHandlerContext!: unknown;
   public pollRate!: number;
   public enabled!: boolean;
   public multiInputOverride!: number;
@@ -40,15 +40,15 @@ export class Input {
   public recordPointerHistory!: boolean;
   public recordRate!: number;
   public recordLimit!: number;
-  public pointer1!: any;
-  public pointer2!: any;
-  public pointer3!: any;
-  public pointer4!: any;
-  public pointer5!: any;
-  public pointer6!: any;
-  public pointer7!: any;
-  public pointer8!: any;
-  public pointer9!: any;
+  public pointer1!: Pointer;
+  public pointer2!: Pointer;
+  public pointer3!: Pointer | null;
+  public pointer4!: Pointer | null;
+  public pointer5!: Pointer | null;
+  public pointer6!: Pointer | null;
+  public pointer7!: Pointer | null;
+  public pointer8!: Pointer | null;
+  public pointer9!: Pointer | null;
   public pointer10!: any;
   public pointers!: Pointer[];
   public activePointer!: Pointer;
@@ -97,8 +97,6 @@ export class Input {
     this.recordPointerHistory = false;
     this.recordRate = 100;
     this.recordLimit = 100;
-    this.pointer1 = null;
-    this.pointer2 = null;
     this.pointer3 = null;
     this.pointer4 = null;
     this.pointer5 = null;
@@ -130,7 +128,7 @@ export class Input {
   /**
    * TBD.
    */
-  public boot() {
+  public boot(): void {
     this.mousePointer = new Pointer(this.game, 0, POINTER_CURSOR);
     this.addPointer();
     this.addPointer();
@@ -164,7 +162,7 @@ export class Input {
   /**
    * TBD.
    */
-  public destroy() {
+  public destroy(): void {
     this.mouse.stop();
     if (this.game.device.mspointer) {
       this.mspointer.stop();
@@ -181,7 +179,7 @@ export class Input {
    * @param {Function} callback - TBD.
    * @param {object} context - TBD.
    */
-  public setInteractiveCandidateHandler(callback: Function, context: CanvasRenderingContext2D) {
+  public setInteractiveCandidateHandler(callback: Function, context: unknown): void {
     this.customCandidateHandler = callback;
     this.customCandidateHandlerContext = context;
   }
@@ -191,7 +189,7 @@ export class Input {
    * @param {Function} callback - TBD.
    * @param {object} context - TBD.
    */
-  public addMoveCallback(callback: Function, context: CanvasRenderingContext2D) {
+  public addMoveCallback(callback: Function, context: unknown): void {
     this.moveCallbacks.push({ callback, context });
   }
 
@@ -200,7 +198,7 @@ export class Input {
    * @param {Function} callback - TBD.
    * @param {object} context - TBD.
    */
-  public deleteMoveCallback(callback: Function, context: CanvasRenderingContext2D) {
+  public deleteMoveCallback(callback: Function, context: unknown): void {
     let i = this.moveCallbacks.length;
     while (i) {
       i -= 1;
@@ -215,7 +213,7 @@ export class Input {
    * TBD.
    * @returns {Pointer} TBD.
    */
-  public addPointer() {
+  public addPointer(): Pointer | null {
     if (this.pointers.length >= MAX_POINTERS) {
       this.game.logger.warn(`Input.addPointer: Maximum limit of ${MAX_POINTERS} pointers reached.`);
       return null;
@@ -230,7 +228,7 @@ export class Input {
   /**
    * TBD.
    */
-  public update() {
+  public update(): void {
     if (this.pollRate > 0 && this._pollCounter < this.pollRate) {
       this._pollCounter += 1;
       return;
@@ -249,7 +247,7 @@ export class Input {
    * TBD.
    * @param {boolean} hard - TBD.
    */
-  public reset(hard = false) {
+  public reset(hard = false): void {
     if (!this.game.isBooted || this.resetLocked) {
       return;
     }
@@ -279,7 +277,7 @@ export class Input {
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    */
-  public resetSpeed(x: number, y: number) {
+  public resetSpeed(x: number, y: number): void {
     this._oldPosition.setTo(x, y);
     this.speed.setTo(0, 0);
   }
@@ -355,7 +353,7 @@ export class Input {
    * @param {number} limit - TBD.
    * @returns {number} TBD.
    */
-  public countActivePointers(limit: number = this.pointers.length) {
+  public countActivePointers(limit: number = this.pointers.length): number {
     let count = limit;
     for (let i = 0; i < this.pointers.length && count > 0; i += 1) {
       const pointer = this.pointers[i]!;
@@ -371,7 +369,7 @@ export class Input {
    * @param {boolean} isActive - TBD.
    * @returns {Pointer} TBD.
    */
-  public getPointer(isActive = false) {
+  public getPointer(isActive = false): Pointer | null {
     for (const pointer of this.pointers) {
       if (pointer.active === isActive) {
         return pointer;
@@ -385,7 +383,7 @@ export class Input {
    * @param {number} identifier - TBD.
    * @returns {Pointer} TBD.
    */
-  public getPointerFromIdentifier(identifier: number) {
+  public getPointerFromIdentifier(identifier: number): Pointer | null {
     for (const pointer of this.pointers) {
       if (pointer.identifier === identifier) {
         return pointer;
@@ -400,7 +398,7 @@ export class Input {
    * @param {number} pointerId - TBD.
    * @returns {Pointer} TBD.
    */
-  public getPointerFromId(pointerId: number) {
+  public getPointerFromId(pointerId: number): Pointer | null {
     for (const pointer of this.pointers) {
       if (pointer.pointerId === pointerId) {
         return pointer;
@@ -417,7 +415,7 @@ export class Input {
    * @param {Point} output - TBD.
    * @returns {Point} TBD.
    */
-  public getLocalPosition(displayObject: DisplayObject, pointer: Pointer, output: Point | null = null) {
+  public getLocalPosition(displayObject: DisplayObject, pointer: Pointer, output: Point | null = null): Point {
     const result = output ?? new Point();
     const wt = displayObject.worldTransform;
     const id = 1 / (wt.a * wt.d + wt.c * -wt.b);
@@ -434,7 +432,7 @@ export class Input {
    * @param {Point} localPoint - TBD.
    * @returns {boolean} TBD.
    */
-  public hitTest(displayObject: DisplayObject, pointer: Pointer, localPoint: Point) {
+  public hitTest(displayObject: DisplayObject, pointer: Pointer, localPoint: Point): boolean {
     if (!displayObject.worldVisible) {
       return false;
     }
@@ -472,7 +470,7 @@ export class Input {
   /**
    * TBD.
    */
-  public onClickTrampoline() {
+  public onClickTrampoline(): void {
     this.activePointer.processClickTrampolines();
   }
 
@@ -480,7 +478,7 @@ export class Input {
    * TBD.
    * @returns {number} TBD.
    */
-  public get x() {
+  public get x(): number {
     return this._x;
   }
 
@@ -495,7 +493,7 @@ export class Input {
    * TBD.
    * @returns {number} TBD.
    */
-  public get y() {
+  public get y(): number {
     return this._y;
   }
 
@@ -510,7 +508,7 @@ export class Input {
    * TBD.
    * @returns {boolean} TBD.
    */
-  public get pollLocked() {
+  public get pollLocked(): boolean {
     return this.pollRate > 0 && this._pollCounter < this.pollRate;
   }
 
@@ -518,7 +516,7 @@ export class Input {
    * TBD.
    * @returns {number} TBD.
    */
-  public get totalInactivePointers() {
+  public get totalInactivePointers(): number {
     return this.pointers.length - this.countActivePointers();
   }
 
@@ -526,7 +524,7 @@ export class Input {
    * TBD.
    * @returns {number} TBD.
    */
-  public get totalActivePointers() {
+  public get totalActivePointers(): number {
     return this.countActivePointers();
   }
 
@@ -534,7 +532,7 @@ export class Input {
    * TBD.
    * @returns {number} TBD.
    */
-  public get worldX() {
+  public get worldX(): number {
     return this.x;
   }
 
@@ -542,7 +540,7 @@ export class Input {
    * TBD.
    * @returns {number} TBD.
    */
-  public get worldY() {
+  public get worldY(): number {
     return this.y;
   }
 }