@vpmedia/phaser 1.104.0 → 1.106.0

package/src/phaser/display/button.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import { BUTTON, POINTER_CONTACT } from '../core/const.js';
 import { InputHandler } from '../core/input_handler.js';
 import { Signal } from '../core/signal.js';
@@ -11,34 +10,20 @@ const STATE_UP = 'Up';
 const STATE_DISABLED = 'Disabled';
 
 export class Button extends Image {
-  /** @type {string | null} */
-  _onOverFrame;
-  /** @type {string | null} */
-  _onOutFrame;
-  /** @type {string | null} */
-  _onDownFrame;
-  /** @type {string | null} */
-  _onUpFrame;
-  /** @type {string | null} */
-  _onDisabledFrame;
-  /** @type {Signal} */
-  onInputOver;
-  /** @type {Signal} */
-  onInputOut;
-  /** @type {Signal} */
-  onInputDown;
-  /** @type {Signal} */
-  onInputUp;
-  /** @type {boolean} */
-  onOverMouseOnly;
-  /** @type {number} */
-  justReleasedPreventsOver;
-  /** @type {boolean} */
-  freezeFrames;
-  /** @type {boolean} */
-  forceOut;
-  /** @type {InputHandler} */
-  input;
+  _onOverFrame!: string | null;
+  _onOutFrame!: string | null;
+  _onDownFrame!: string | null;
+  _onUpFrame!: string | null;
+  _onDisabledFrame!: string | null;
+  onInputOver!: Signal;
+  onInputOut!: Signal;
+  onInputDown!: Signal;
+  onInputUp!: Signal;
+  onOverMouseOnly!: boolean;
+  justReleasedPreventsOver!: number;
+  freezeFrames!: boolean;
+  forceOut!: any;
+  input!: InputHandler;
   /**
    * Creates a new Button instance.
    * @param {import('../core/game.js').Game} game - The game instance this button belongs to.
@@ -54,17 +39,17 @@ export class Button extends Image {
    * @param {string} disabledFrame - The frame identifier to use when the button is disabled.
    */
   constructor(
-    game,
-    x = 0,
-    y = 0,
-    key = null,
-    callback = null,
-    callbackContext = null,
-    overFrame = null,
-    outFrame = null,
-    downFrame = null,
-    upFrame = null,
-    disabledFrame = null
+    game: import('../core/game.js').Game,
+    x: number = 0,
+    y: number = 0,
+    key: string = null,
+    callback: Function = null,
+    callbackContext: any = null,
+    overFrame: string = null,
+    outFrame: string = null,
+    downFrame: string = null,
+    upFrame: string = null,
+    disabledFrame: string = null
   ) {
     super(game, x, y, key, outFrame);
     this.type = BUTTON;
@@ -126,7 +111,7 @@ export class Button extends Image {
    * @param {boolean} isEnabled - Whether the button should be enabled (true) or disabled (false).
    * @param {boolean} isImmediate - Whether to change the state immediately or with a delay (default: false).
    */
-  setEnabled(isEnabled, isImmediate = false) {
+  setEnabled(isEnabled: boolean, isImmediate: boolean = false) {
     this.input.enabled = isEnabled;
     if (isImmediate) {
       this.changeStateFrame(isEnabled ? STATE_UP : STATE_DISABLED);
@@ -157,7 +142,7 @@ export class Button extends Image {
    * @param {string} frame - The frame identifier to set for this state.
    * @param {boolean} switchImmediately - Whether to switch to the new frame immediately (default: false).
    */
-  setStateFrame(state, frame, switchImmediately = false) {
+  setStateFrame(state: string, frame: string, switchImmediately: boolean = false) {
     const frameKey = `_on${state}Frame`;
     if (frame) {
       this[frameKey] = frame;
@@ -174,7 +159,7 @@ export class Button extends Image {
    * @param {string} newState - The new state to change to (Over, Out, Down, Up, Disabled).
    * @returns {boolean} True if the frame was changed, false otherwise.
    */
-  changeStateFrame(newState) {
+  changeStateFrame(newState: string) {
     if (this.freezeFrames) {
       return false;
     }
@@ -199,7 +184,7 @@ export class Button extends Image {
    * @param {string} upFrame - The frame identifier to use when the button is released.
    * @param {string} disabledFrame - The frame identifier to use when the button is disabled.
    */
-  setFrames(overFrame, outFrame, downFrame, upFrame, disabledFrame = null) {
+  setFrames(overFrame: string, outFrame: string, downFrame: string, upFrame: string, disabledFrame: string = null) {
     this.setStateFrame(STATE_OVER, overFrame, this.input.pointerOver());
     this.setStateFrame(STATE_OUT, outFrame, !this.input.pointerOver());
     this.setStateFrame(STATE_DOWN, downFrame, this.input.pointerDown());
@@ -214,7 +199,7 @@ export class Button extends Image {
    * @param {object} sprite - The sprite that triggered the event.
    * @param {object} pointer - The pointer that triggered the event.
    */
-  onInputOverHandler(sprite, pointer) {
+  onInputOverHandler(sprite: any, pointer: any) {
     if (pointer.justReleased() && (this.justReleasedPreventsOver & pointer.pointerMode) === pointer.pointerMode) {
       //  If the Pointer was only just released then we don't fire an over event
       return;
@@ -233,7 +218,7 @@ export class Button extends Image {
    * @param {object} sprite - The sprite that triggered the event.
    * @param {object} pointer - The pointer that triggered the event.
    */
-  onInputOutHandler(sprite, pointer) {
+  onInputOutHandler(sprite: any, pointer: any) {
     this.changeStateFrame(STATE_OUT);
     if (this.onInputOut) {
       this.onInputOut.dispatch(this, pointer);
@@ -245,7 +230,7 @@ export class Button extends Image {
    * @param {object} sprite - The sprite that triggered the event.
    * @param {object} pointer - The pointer that triggered the event.
    */
-  onInputDownHandler(sprite, pointer) {
+  onInputDownHandler(sprite: any, pointer: any) {
     this.changeStateFrame(STATE_DOWN);
     if (this.onInputDown) {
       this.onInputDown.dispatch(this, pointer);
@@ -258,7 +243,7 @@ export class Button extends Image {
    * @param {object} pointer - The pointer that triggered the event.
    * @param {boolean} isOver - Whether the pointer is currently over the button (default: true).
    */
-  onInputUpHandler(sprite, pointer, isOver) {
+  onInputUpHandler(sprite: any, pointer: any, isOver: boolean) {
     if (this.onInputUp) {
       this.onInputUp.dispatch(this, pointer, isOver);
     }
@@ -292,7 +277,7 @@ export class Button extends Image {
    * Sets whether input is currently enabled for this button.
    * @param {boolean} value - Whether to enable (true) or disable (false) input.
    */
-  set inputEnabled(value) {
+  set inputEnabled(value: boolean) {
     if (value) {
       if (this.input === null) {
         this.input = new InputHandler(this);

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

@@ -1,17 +1,16 @@
-// @ts-nocheck
 import { create, removeByCanvas } from './pool.js';
 
 export class CanvasBuffer {
-width;
-height;
-canvas;
-context;
+  width!: any;
+  height!: any;
+  canvas!: any;
+  context!: any;
   /**
    * Creates a new CanvasBuffer instance.
    * @param {number} width - The width of the canvas buffer.
    * @param {number} height - The height of the canvas buffer.
    */
-  constructor(width, height) {
+  constructor(width: number, height: number) {
     this.width = width;
     this.height = height;
     this.canvas = create(this, this.width, this.height);
@@ -33,7 +32,7 @@ context;
    * @param {number} width - The new width of the canvas buffer.
    * @param {number} height - The new height of the canvas buffer.
    */
-  resize(width, height) {
+  resize(width: number, height: number) {
     this.width = width;
     this.height = height;
     this.canvas.width = width;

package/src/phaser/display/canvas/graphics.ts

@@ -1,11 +1,10 @@
-// @ts-nocheck
 import { GEOM_CIRCLE, GEOM_ELLIPSE, GEOM_POLYGON, GEOM_RECTANGLE, GEOM_ROUNDED_RECTANGLE } from '../../core/const.js';
 
 /**
  * Renders a graphics object to canvas.
  * @param {import('../graphics.js').Graphics} graphics - The graphics object to render.
  */
-export const updateGraphicsTint = (graphics) => {
+export const updateGraphicsTint = (graphics: import('../graphics.js').Graphics) => {
   if (graphics.tint === 0xffffff) {
     return;
   }
@@ -32,7 +31,7 @@ export const updateGraphicsTint = (graphics) => {
  * @param {import('../graphics.js').Graphics} graphics - The graphics object to render.
  * @param {object} context - The canvas rendering context.
  */
-export const renderGraphics = (graphics, context) => {
+export const renderGraphics = (graphics: import('../graphics.js').Graphics, context: any) => {
   const worldAlpha = graphics.worldAlpha;
   if (graphics.dirty) {
     updateGraphicsTint(graphics);
@@ -161,7 +160,7 @@ export const renderGraphics = (graphics, context) => {
  * @param {import('../graphics.js').Graphics} graphics - The graphics object to render.
  * @param {object} context - The canvas rendering context.
  */
-export const renderGraphicsMask = (graphics, context) => {
+export const renderGraphicsMask = (graphics: import('../graphics.js').Graphics, context: any) => {
   const len = graphics.graphicsData.length;
   if (len === 0) {
     return;

package/src/phaser/display/canvas/masker.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import { renderGraphicsMask } from './graphics.js';
 
 /**
@@ -6,7 +5,7 @@ import { renderGraphicsMask } from './graphics.js';
  * @param {object} maskData - The mask data to apply.
  * @param {object} renderSession - The rendering session object.
  */
-export const pushMask = (maskData, renderSession) => {
+export const pushMask = (maskData: any, renderSession: any) => {
   const context = renderSession.context;
   context.save();
   const cacheAlpha = maskData.alpha;
@@ -29,6 +28,6 @@ export const pushMask = (maskData, renderSession) => {
  * Pops a mask from the rendering stack.
  * @param {object} renderSession - The rendering session object.
  */
-export const popMask = (renderSession) => {
+export const popMask = (renderSession: any) => {
   renderSession.context.restore();
 };

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

@@ -1,4 +1,3 @@
-// @ts-nocheck
 /**
  * Gets the canvas pool array.
  * @returns {{canvas: HTMLCanvasElement, parent: object}[]} The canvas pool array.
@@ -31,7 +30,7 @@ export const getFirst = () => {
  * Adds a canvas to the pool with the specified parent.
  * @param {object} parent - The parent object for the canvas.
  */
-export const remove = (parent) => {
+export const remove = (parent: any) => {
   const pool = getPool();
   for (let i = 0; i < pool.length; i += 1) {
     if (pool[i].parent === parent) {
@@ -46,7 +45,7 @@ export const remove = (parent) => {
  * Removes a canvas from the pool.
  * @param {HTMLCanvasElement} canvas - The canvas to remove from the pool.
  */
-export const removeByCanvas = (canvas) => {
+export const removeByCanvas = (canvas: HTMLCanvasElement) => {
   const pool = getPool();
   for (let i = 0; i < pool.length; i += 1) {
     if (pool[i].canvas === canvas) {
@@ -95,7 +94,7 @@ export const getFree = () => {
  * @param {boolean} skipPool - True to skip using the pool and create a new canvas.
  * @returns {HTMLCanvasElement} The canvas from the pool or a newly created one.
  */
-export const create = (parent, width, height, skipPool = false) => {
+export const create = (parent: any, width?: any, height?: any, skipPool: boolean = false) => {
   if (parent === undefined) {
     console.warn('Created CanvasPool element with undefined parent.');
   }

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

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import {
   BLEND_ADD,
   BLEND_COLOR,
@@ -27,24 +26,24 @@ import { detectCapabilities } from './tinter.js';
 import { getSmoothingPrefix } from './util.js';
 
 export class CanvasRenderer {
-type;
-resolution;
-clearBeforeRender;
-transparent;
-autoResize;
-contextLost;
-width;
-height;
-view;
-context;
-refresh;
-count;
-renderSession;
+  type!: any;
+  resolution!: any;
+  clearBeforeRender!: any;
+  transparent!: any;
+  autoResize!: any;
+  contextLost!: any;
+  width!: any;
+  height!: any;
+  view!: any;
+  context!: any;
+  refresh!: any;
+  count!: any;
+  renderSession!: any;
   /**
    * Creates a new CanvasRenderer instance.
    * @param {import('../../core/game.js').Game} game - The game instance.
    */
-  constructor(game) {
+  constructor(game: import('../../core/game.js').Game) {
     detectCapabilities(game);
     /** @type {number} */
     this.type = RENDER_CANVAS;
@@ -79,7 +78,7 @@ renderSession;
    * Renders the stage to canvas.
    * @param {import('../../core/stage.js').Stage} root - The root stage to render.
    */
-  render(root) {
+  render(root: import('../../core/stage.js').Stage) {
     if (!this.context) {
       return;
     }
@@ -104,7 +103,7 @@ renderSession;
    * Destroys this renderer and cleans up resources.
    * @param {boolean} removeView - Whether to remove the view from the DOM.
    */
-  destroy(removeView = true) {
+  destroy(removeView: boolean = true) {
     if (removeView && this.view.parent) {
       this.view.parent.removeChild(this.view);
     }
@@ -118,7 +117,7 @@ renderSession;
    * @param {number} width - The new width of the canvas.
    * @param {number} height - The new height of the canvas.
    */
-  resize(width, height) {
+  resize(width: number, height: number) {
     this.width = width * this.resolution;
     this.height = height * this.resolution;
     this.view.width = this.width;
@@ -138,7 +137,7 @@ renderSession;
    * @param {CanvasRenderingContext2D} context - The canvas rendering context.
    * @param {import('../../geom/matrix.js').Matrix} matrix - The transformation matrix.
    */
-  renderDisplayObject(displayObject, context, matrix) {
+  renderDisplayObject(displayObject: any, context?: any, matrix?: any) {
     this.renderSession.context = context || this.context;
     this.renderSession.resolution = this.resolution;
     displayObject.renderCanvas(this.renderSession, matrix);
@@ -177,7 +176,7 @@ renderSession;
    * Initializes the WebGL context for rendering.
    * @param {import('../../core/game.js').Game} game - The game instance.
    */
-  initContext(game) {
+  initContext(game: import('../../core/game.js').Game) {
     // stub
   }
 }

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

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import { ENGINE_ERROR_CREATING_CANVAS_2D_CONTEXT, ENGINE_ERROR_GETTING_DOCUMENT } from '../../core/error_code.js';
 import { hex2rgb } from '../../util/math.js';
 import { create, removeByCanvas } from './pool.js';
@@ -9,7 +8,7 @@ import { create, removeByCanvas } from './pool.js';
  * @param {object} color - The color to tint with.
  * @returns {object} The tinted sprite.
  */
-export const getTintedTexture = (sprite, color) => {
+export const getTintedTexture = (sprite: any, color: any) => {
   const canvas = sprite.tintedTexture || create('CanvasTinter', 1, 1);
   window.PhaserRegistry.CANVAS_TINT_METHOD(sprite.texture, color, canvas);
   return canvas;
@@ -22,7 +21,7 @@ export const getTintedTexture = (sprite, color) => {
  * @param {HTMLCanvasElement} canvas - The canvas to render to.
  * @throws {Error} If the operation fails.
  */
-export const tintWithMultiply = (texture, color, canvas) => {
+export const tintWithMultiply = (texture: any, color: any, canvas: HTMLCanvasElement) => {
   const context = canvas.getContext('2d', { willReadFrequently: false });
   if (!context) {
     throw new Error(ENGINE_ERROR_CREATING_CANVAS_2D_CONTEXT);
@@ -48,7 +47,7 @@ export const tintWithMultiply = (texture, color, canvas) => {
  * @param {HTMLCanvasElement} canvas - The canvas to render to.
  * @throws {Error} If the operation fails.
  */
-export const tintWithPerPixel = (texture, color, canvas) => {
+export const tintWithPerPixel = (texture: any, color: any, canvas: HTMLCanvasElement) => {
   const context = canvas.getContext('2d', { willReadFrequently: false });
   if (!context) {
     throw new Error(ENGINE_ERROR_CREATING_CANVAS_2D_CONTEXT);
@@ -167,7 +166,7 @@ export const canUseNewCanvasBlendModes = () => {
  * Creates a new Tinter instance.
  * @param {import('../../core/game.js').Game} game - The game instance.
  */
-export const detectCapabilities = (game) => {
+export const detectCapabilities = (game: import('../../core/game.js').Game) => {
   if (!window.PhaserRegistry) {
     window.PhaserRegistry = {};
   }

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

@@ -9,7 +9,7 @@ import { create as createCanvas } from './pool.js';
  * @param {boolean} skipPool - Whether to skip using the canvas pool.
  * @returns {HTMLCanvasElement} The created HTML canvas element.
  */
-export const create = (parent, width, height, id, skipPool) => {
+export const create = (parent: any, width: number, height: number, id: string, skipPool: boolean) => {
   width = width || 256;
   height = height || 256;
   const canvas = skipPool ? document.createElement('canvas') : createCanvas(parent, width, height);
@@ -28,7 +28,7 @@ export const create = (parent, width, height, id, skipPool) => {
  * @param {string} color - The background color to set.
  * @returns {HTMLCanvasElement} The modified canvas element.
  */
-export const setBackgroundColor = (canvas, color) => {
+export const setBackgroundColor = (canvas: HTMLCanvasElement, color: string) => {
   color = color || 'rgb(0,0,0)';
   canvas.style.backgroundColor = color;
   return canvas;
@@ -40,7 +40,7 @@ export const setBackgroundColor = (canvas, color) => {
  * @param {string} value - The touch action value to set.
  * @returns {HTMLCanvasElement} The modified canvas element.
  */
-export const setTouchAction = (canvas, value = 'none') => {
+export const setTouchAction = (canvas: HTMLCanvasElement, value: string = 'none') => {
   value = value || 'none';
   // @ts-ignore
   canvas.style.msTouchAction = value;
@@ -55,7 +55,7 @@ export const setTouchAction = (canvas, value = 'none') => {
  * @param {string} value - The user select value to set.
  * @returns {HTMLCanvasElement} The modified canvas element.
  */
-export const setUserSelect = (canvas, value = 'none') => {
+export const setUserSelect = (canvas: HTMLCanvasElement, value: string = 'none') => {
   value = value || 'none';
   canvas.style['-webkit-touch-callout'] = value;
   canvas.style['-webkit-user-select'] = value;
@@ -74,7 +74,7 @@ export const setUserSelect = (canvas, value = 'none') => {
  * @param {boolean} overflowHidden - Whether to set overflow hidden on the parent.
  * @returns {HTMLCanvasElement} The added canvas element.
  */
-export const addToDOM = (canvas, parent, overflowHidden = true) => {
+export const addToDOM = (canvas: HTMLCanvasElement, parent: any, overflowHidden: boolean = true) => {
   let target;
   if (parent) {
     if (typeof parent === 'string') {
@@ -100,7 +100,7 @@ export const addToDOM = (canvas, parent, overflowHidden = true) => {
  * Removes a canvas element from the DOM.
  * @param {HTMLCanvasElement} canvas - The canvas element to remove.
  */
-export const removeFromDOM = (canvas) => {
+export const removeFromDOM = (canvas: HTMLCanvasElement) => {
   if (canvas && canvas.parentNode) {
     canvas.parentNode.removeChild(canvas);
   }
@@ -117,7 +117,15 @@ export const removeFromDOM = (canvas) => {
  * @param {number} skewY - The Y skew value.
  * @returns {CanvasRenderingContext2D} The modified rendering context.
  */
-export const setTransform = (context, translateX, translateY, scaleX, scaleY, skewX, skewY) => {
+export const setTransform = (
+  context: CanvasRenderingContext2D,
+  translateX: number,
+  translateY: number,
+  scaleX: number,
+  scaleY: number,
+  skewX: number,
+  skewY: number
+) => {
   context.setTransform(scaleX, skewX, skewY, scaleY, translateX, translateY);
   return context;
 };
@@ -127,7 +135,7 @@ export const setTransform = (context, translateX, translateY, scaleX, scaleY, sk
  * @param {CanvasRenderingContext2D} context - The canvas rendering context.
  * @returns {string | null} The smoothing property name or null if not found.
  */
-export const getSmoothingPrefix = (context) => {
+export const getSmoothingPrefix = (context: CanvasRenderingContext2D) => {
   const VENDORS = ['i', 'webkitI', 'msI', 'mozI', 'oI'];
   for (let i = 0; i < VENDORS.length; i += 1) {
     const s = `${VENDORS[i]}mageSmoothingEnabled`;
@@ -144,7 +152,7 @@ export const getSmoothingPrefix = (context) => {
  * @param {number} value - The smoothing enabled value to set.
  * @returns {object} The modified rendering context.
  */
-export const setSmoothingEnabled = (context, value) => {
+export const setSmoothingEnabled = (context: any, value: number) => {
   const s = getSmoothingPrefix(context);
   if (s) {
     context[s] = value;