@vpmedia/phaser 1.116.0 → 1.117.0

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

@@ -133,7 +133,7 @@ export class NormalShader {
   /**
    * Binds this shader to the WebGL context.
    */
-  public initUniforms() {
+  public initUniforms(): void {
     this.textureCount = 1;
     const { gl } = this;
     for (const uniform of Object.values(this.uniforms)) {
@@ -174,7 +174,7 @@ export class NormalShader {
    * Sets a uniform value for this shader.
    * @param {object} uniform - The uniform to set.
    */
-  public initSampler2D(uniform: any) {
+  public initSampler2D(uniform: any): void {
     if (!uniform.value || !uniform.value.baseTexture || !uniform.value.baseTexture.hasLoaded) {
       return;
     }
@@ -226,7 +226,7 @@ export class NormalShader {
   /**
    * Sets the shader to use for rendering.
    */
-  public syncUniforms() {
+  public syncUniforms(): void {
     this.textureCount = 1;
     const { gl } = this;
     //  This would probably be faster in an array and it would guarantee key order

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

@@ -41,7 +41,7 @@ export class WebGLShaderManager {
    * Initializes the shader manager with a WebGL context.
    * @param {WebGLRenderingContext & { id: number }} gl - The WebGL rendering context.
    */
-  public setContext(gl: IdentifiedWebGLRenderingContext) {
+  public setContext(gl: IdentifiedWebGLRenderingContext): void {
     this.gl = gl;
     this.primitiveShader = new PrimitiveShader(gl);
     this.complexPrimitiveShader = new ComplexPrimitiveShader(gl);
@@ -55,7 +55,7 @@ export class WebGLShaderManager {
    * Sets up the shader manager for WebGL rendering.
    * @param {number[]} attribs - The attribute locations to set up.
    */
-  public setAttribs(attribs: (number | undefined)[]) {
+  public setAttribs(attribs: (number | undefined)[]): void {
     // reset temp state
     let i;
     for (i = 0; i < this.tempAttribState.length; i += 1) {

package/src/phaser/display/webgl/sprite_batch.ts

@@ -74,7 +74,7 @@ export class WebGLSpriteBatch {
    * Renders a sprite using WebGL.
    * @param {WebGLRenderingContext & { id: number }} gl - The WebGL rendering context.
    */
-  public setContext(gl: IdentifiedWebGLRenderingContext) {
+  public setContext(gl: IdentifiedWebGLRenderingContext): void {
     this.gl = gl;
     // create a couple of buffers
     this.vertexBuffer = gl.createBuffer();
@@ -97,7 +97,7 @@ export class WebGLSpriteBatch {
    * Renders the sprite batch using WebGL.
    * @param {object} renderSession - The render session to use.
    */
-  public begin(renderSession: RenderSession) {
+  public begin(renderSession: RenderSession): void {
     this.renderSession = renderSession;
     this.shader = this.renderSession.shaderManager.defaultShader;
     this.start();
@@ -106,7 +106,7 @@ export class WebGLSpriteBatch {
   /**
    * Updates the sprite batch.
    */
-  public end() {
+  public end(): void {
     this.flush();
   }
 
@@ -115,7 +115,7 @@ export class WebGLSpriteBatch {
    * @param {Image} sprite - The sprite to render.
    * @param {Matrix} matrix - The transformation matrix.
    */
-  public render(sprite: Image, matrix: Matrix | null = null) {
+  public render(sprite: Image, matrix: Matrix | null = null): void {
     const { texture } = sprite;
     //  They provided an alternative rendering matrix, so use it
     let wt = sprite.worldTransform;
@@ -215,14 +215,14 @@ export class WebGLSpriteBatch {
   /**
    * Binds the sprite batch to the WebGL context.
    */
-  public renderTilingSprite() {
+  public renderTilingSprite(): void {
     // TODO
   }
 
   /**
    * Updates the sprite batch.
    */
-  public flush() {
+  public flush(): void {
     // If the batch is length 0 then return as there is nothing to draw
     if (this.currentBatchSize === 0) {
       return;
@@ -324,7 +324,7 @@ export class WebGLSpriteBatch {
    * @param {number} size - The size of the batch.
    * @param {number} startIndex - The start index in the batch.
    */
-  public renderBatch(texture: BaseTexture, size: number, startIndex: number) {
+  public renderBatch(texture: BaseTexture, size: number, startIndex: number): void {
     if (size === 0) {
       return;
     }
@@ -337,7 +337,7 @@ export class WebGLSpriteBatch {
       }
     } else {
       // bind the current texture
-      gl.bindTexture(gl.TEXTURE_2D, texture._glTextures[gl.id]);
+      gl.bindTexture(gl.TEXTURE_2D, texture._glTextures[gl.id] ?? null);
     }
     // now draw those suckas!
     gl.drawElements(gl.TRIANGLES, size * 6, gl.UNSIGNED_SHORT, startIndex * 6 * 2);
@@ -348,7 +348,7 @@ export class WebGLSpriteBatch {
   /**
    * Destroys this sprite batch and cleans up resources.
    */
-  public stop() {
+  public stop(): void {
     this.flush();
     this.dirty = true;
   }

package/src/phaser/display/webgl/stencil_manager.ts

@@ -21,7 +21,7 @@ export class WebGLStencilManager {
    * Binds the stencil buffer for rendering.
    * @param {WebGLRenderingContext} gl - The WebGL rendering context.
    */
-  public setContext(gl: WebGLRenderingContext) {
+  public setContext(gl: WebGLRenderingContext): void {
     this.gl = gl;
   }
 
@@ -38,7 +38,7 @@ export class WebGLStencilManager {
    * @param {GraphicsData} webGLData - The WebGL graphics data.
    * @param {object} renderSession - The rendering session.
    */
-  public pushStencil(graphics: Graphics, webGLData: GraphicsData, renderSession: RenderSession) {
+  public pushStencil(graphics: Graphics, webGLData: GraphicsData, renderSession: RenderSession): void {
     const { gl } = renderSession;
     this.bindGraphics(graphics, webGLData, renderSession);
     if (this.stencilStack.length === 0) {
@@ -96,7 +96,7 @@ export class WebGLStencilManager {
    * @param {GraphicsData} webGLData - The WebGL graphics data.
    * @param {object} renderSession - The rendering session.
    */
-  public bindGraphics(graphics: Graphics, webGLData: GraphicsData, renderSession: RenderSession) {
+  public bindGraphics(graphics: Graphics, webGLData: GraphicsData, renderSession: RenderSession): void {
     // if(this._currentGraphics === graphics)return;
     // this._currentGraphics = graphics;
     const { gl } = renderSession;
@@ -149,7 +149,7 @@ export class WebGLStencilManager {
    * @param {GraphicsData} webGLData - The WebGL graphics data.
    * @param {object} renderSession - The rendering session.
    */
-  public popStencil(graphics: Graphics, webGLData: GraphicsData, renderSession: RenderSession) {
+  public popStencil(graphics: Graphics, webGLData: GraphicsData, renderSession: RenderSession): void {
     const { gl } = renderSession;
     this.stencilStack.pop();
     this.count -= 1;

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

@@ -1,50 +1,31 @@
 import { Rectangle } from '../../geom/rectangle.js';
 import type { BaseTexture } from './base_texture.js';
 
+/** The four corners of a texture frame in normalised texture space. */
 export class TextureUvs {
-  public noFrame!: any;
-  public baseTexture!: any;
-  public frame!: any;
-  public trim!: any;
-  public valid!: boolean;
-  public isTiling!: any;
-  public requiresUpdate!: any;
-  public requiresReTint!: any;
-  public _uvs!: any;
-  public width!: number;
-  public height!: number;
-  public crop!: any;
-  public x0: any = 0;
-  public y0: any = 0;
-  public x1: any = 0;
-  public y1: any = 0;
-  public x2: any = 0;
-  public y2!: any;
-  public x3!: any;
-  public y3!: any;
-  /**
-   * Creates a new Texture instance.
-   */
-  public constructor() {
-    this.y2 = 0;
-    this.x3 = 0;
-    this.y3 = 0;
-  }
+  public x0 = 0;
+  public y0 = 0;
+  public x1 = 0;
+  public y1 = 0;
+  public x2 = 0;
+  public y2 = 0;
+  public x3 = 0;
+  public y3 = 0;
 }
 
 export class Texture {
-  public noFrame: any = false;
-  public baseTexture!: any;
-  public frame!: any;
-  public trim!: any;
+  public noFrame = false;
+  public baseTexture!: BaseTexture;
+  public frame!: Rectangle;
+  public trim!: Rectangle | null;
   public valid!: boolean;
-  public isTiling!: any;
-  public requiresUpdate!: any;
-  public requiresReTint!: any;
-  public _uvs!: any;
+  public isTiling!: boolean;
+  public requiresUpdate!: boolean;
+  public requiresReTint!: boolean;
+  public _uvs!: TextureUvs | null;
   public width!: number;
   public height!: number;
-  public crop!: any;
+  public crop!: Rectangle;
   /**
    * Creates a new Texture instance.
    * @param {BaseTexture} baseTexture - The base texture to use.
@@ -97,7 +78,7 @@ export class Texture {
   /**
    * Destroys this texture and cleans up resources.
    */
-  public onBaseTextureLoaded() {
+  public onBaseTextureLoaded(): void {
     if (this.noFrame) {
       this.frame = new Rectangle(0, 0, this.baseTexture.width, this.baseTexture.height);
     }
@@ -108,7 +89,7 @@ export class Texture {
    * Destroys this texture and cleans up resources.
    * @param {boolean} destroyBase - Whether to destroy the base texture as well.
    */
-  public destroy(destroyBase: boolean = false) {
+  public destroy(destroyBase: boolean = false): void {
     if (destroyBase) {
       this.baseTexture.destroy();
     }
@@ -120,7 +101,7 @@ export class Texture {
    * @param {Rectangle} frame - The new frame rectangle.
    * @throws {Error} If the operation fails.
    */
-  public setFrame(frame: Rectangle) {
+  public setFrame(frame: Rectangle): void {
     this.noFrame = false;
     this.frame = frame;
     this.width = frame.width;
@@ -143,7 +124,7 @@ export class Texture {
       this.valid = false;
       return;
     }
-    this.valid = frame && frame.width && frame.height && this.baseTexture.source && this.baseTexture.hasLoaded;
+    this.valid = Boolean(frame && frame.width && frame.height && this.baseTexture.source && this.baseTexture.hasLoaded);
     if (this.trim) {
       this.width = this.trim.width;
       this.height = this.trim.height;
@@ -158,7 +139,7 @@ export class Texture {
   /**
    * Updates the texture UVs based on the crop frame.
    */
-  public _updateUvs() {
+  public _updateUvs(): void {
     this._uvs ??= new TextureUvs();
     const frame = this.crop;
     const tw = this.baseTexture.width;

package/src/phaser/display/webgl/texture_util.ts

@@ -7,7 +7,7 @@ import { Texture } from './texture.js';
  * @param {number} [scaleMode] - The scale mode to use for the texture.
  * @returns {BaseTexture} The newly created BaseTexture instance.
  */
-export const baseTextureFromCanvas = (canvas: HTMLCanvasElement, scaleMode: number) => {
+export const baseTextureFromCanvas = (canvas: HTMLCanvasElement, scaleMode: number): BaseTexture => {
   if (canvas.width === 0) {
     canvas.width = 1;
   }
@@ -23,5 +23,5 @@ export const baseTextureFromCanvas = (canvas: HTMLCanvasElement, scaleMode: numb
  * @param {number} [scaleMode] - The scale mode to use for the texture.
  * @returns {Texture} The newly created Texture instance.
  */
-export const textureFromCanvas = (canvas: HTMLCanvasElement, scaleMode?: any) =>
+export const textureFromCanvas = (canvas: HTMLCanvasElement, scaleMode?: any): Texture =>
   new Texture(baseTextureFromCanvas(canvas, scaleMode));

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

@@ -22,14 +22,14 @@ export const CONTEXT_LOST_WEBGL = 0x9242;
  * @param {WebGLRenderingContext} gl - The WebGL rendering context.
  * @returns {number} The error code from the WebGL context.
  */
-export const getWebGLContextErrorCode = (gl: WebGLRenderingContext) => gl?.getError() ?? 0;
+export const getWebGLContextErrorCode = (gl: WebGLRenderingContext): number => gl?.getError() ?? 0;
 
 /**
  * Gets the WebGL context error name from an error code.
  * @param {number} errorCode - The error code to look up.
  * @returns {string} The name of the WebGL error.
  */
-export const getWebGLContextErrorName = (errorCode: number) => {
+export const getWebGLContextErrorName = (errorCode: number): string => {
   switch (errorCode) {
     case NO_ERROR: {
       return 'NO_ERROR';
@@ -61,7 +61,7 @@ export const getWebGLContextErrorName = (errorCode: number) => {
 /**
  * Initializes default shaders.
  */
-export const initDefaultShaders = () => {};
+export const initDefaultShaders = (): void => {};
 
 /**
  * Compiles a WebGL shader.
@@ -70,7 +70,11 @@ export const initDefaultShaders = () => {};
  * @param {object} shaderType - The type of shader to compile.
  * @returns {WebGLShader} The compiled WebGL shader or null if compilation failed.
  */
-export const compileShader = (gl: WebGLRenderingContext, shaderSrc: string[] | string, shaderType: any) => {
+export const compileShader = (
+  gl: WebGLRenderingContext,
+  shaderSrc: string[] | string,
+  shaderType: any
+): WebGLShader | null => {
   const src = Array.isArray(shaderSrc) ? shaderSrc.join('\n') : shaderSrc;
   const shader = gl.createShader(shaderType);
   if (!shader) {
@@ -92,7 +96,7 @@ export const compileShader = (gl: WebGLRenderingContext, shaderSrc: string[] | s
  * @param {string[]|string} shaderSrc - The vertex shader source code.
  * @returns {WebGLShader} The compiled WebGL vertex shader or null if compilation failed.
  */
-export const compileVertexShader = (gl: WebGLRenderingContext, shaderSrc: string[] | string) =>
+export const compileVertexShader = (gl: WebGLRenderingContext, shaderSrc: string[] | string): WebGLShader | null =>
   compileShader(gl, shaderSrc, gl.VERTEX_SHADER);
 
 /**
@@ -101,7 +105,7 @@ export const compileVertexShader = (gl: WebGLRenderingContext, shaderSrc: string
  * @param {string[]|string} shaderSrc - The fragment shader source code.
  * @returns {WebGLShader} The compiled WebGL fragment shader or null if compilation failed.
  */
-export const compileFragmentShader = (gl: WebGLRenderingContext, shaderSrc: string[] | string) =>
+export const compileFragmentShader = (gl: WebGLRenderingContext, shaderSrc: string[] | string): WebGLShader | null =>
   compileShader(gl, shaderSrc, gl.FRAGMENT_SHADER);
 
 /**
@@ -115,7 +119,7 @@ export const compileProgram = (
   gl: WebGLRenderingContext,
   vertexSrc: string[] | string,
   fragmentSrc: string[] | string
-) => {
+): WebGLProgram | null => {
   const fragmentShader = compileFragmentShader(gl, fragmentSrc);
   const vertexShader = compileVertexShader(gl, vertexSrc);
 

package/src/phaser/geom/circle.ts

@@ -37,7 +37,7 @@ export class Circle {
    * Calculates the circumference of this circle.
    * @returns {number} The circumference of this circle.
    */
-  public circumference() {
+  public circumference(): number {
     return 2 * (Math.PI * this._radius);
   }
 
@@ -46,7 +46,7 @@ export class Circle {
    * @param {Point} output - The point to store the result in (optional).
    * @returns {Point} A random point within this circle.
    */
-  public random(output: Point | null = null) {
+  public random(output: Point | null = null): Point {
     const result = output ?? new Point();
     const t = 2 * Math.PI * Math.random();
     const u = Math.random() + Math.random();
@@ -62,7 +62,7 @@ export class Circle {
    * Gets the bounding rectangle of this circle.
    * @returns {Rectangle} The bounding rectangle of this circle.
    */
-  public getBounds() {
+  public getBounds(): Rectangle {
     return new Rectangle(this.x - this.radius, this.y - this.radius, this.diameter, this.diameter);
   }
 
@@ -73,7 +73,7 @@ export class Circle {
    * @param {number} diameter - The new diameter of the circle.
    * @returns {Circle} This circle instance for chaining.
    */
-  public setTo(x: number, y: number, diameter: number) {
+  public setTo(x: number, y: number, diameter: number): this {
     this.x = x;
     this.y = y;
     this._diameter = diameter;
@@ -86,7 +86,7 @@ export class Circle {
    * @param {Circle} source - The circle to copy values from.
    * @returns {Circle} This circle instance for chaining.
    */
-  public copyFrom(source: Circle) {
+  public copyFrom(source: Circle): this {
     return this.setTo(source.x, source.y, source.diameter);
   }
 
@@ -95,7 +95,7 @@ export class Circle {
    * @param {Circle} dest - The circle to copy values to.
    * @returns {Circle} The destination circle.
    */
-  public copyTo(dest: Circle) {
+  public copyTo(dest: Circle): Circle {
     dest.x = this.x;
     dest.y = this.y;
     dest.diameter = this._diameter;
@@ -108,7 +108,7 @@ export class Circle {
    * @param {boolean} round - Whether to round the result (default: false).
    * @returns {number} The distance between the circles.
    */
-  public distance(dest: { x: number; y: number }, round = false) {
+  public distance(dest: { x: number; y: number }, round = false): number {
     const d = distance(this.x, this.y, dest.x, dest.y);
     return round ? Math.round(d) : d;
   }
@@ -117,7 +117,7 @@ export class Circle {
    * Creates a clone of this circle.
    * @returns {Circle} A new circle with the same values as this one.
    */
-  public clone() {
+  public clone(): Circle {
     return clone(this);
   }
 
@@ -127,7 +127,7 @@ export class Circle {
    * @param {number} y - The y coordinate of the point to check.
    * @returns {boolean} True if the point is contained within this circle, false otherwise.
    */
-  public contains(x: number, y: number) {
+  public contains(x: number, y: number): boolean {
     return contains(this, x, y);
   }
 
@@ -138,7 +138,7 @@ export class Circle {
    * @param {Point} out - The point to store the result in (optional).
    * @returns {Point} A point at the specified angle on the circumference of this circle.
    */
-  public circumferencePoint(angle: number, asDegrees?: boolean, out?: Point) {
+  public circumferencePoint(angle: number, asDegrees?: boolean, out?: Point): Point {
     return circumferencePoint(this, angle, asDegrees, out);
   }
 
@@ -148,7 +148,7 @@ export class Circle {
    * @param {number} dy - The amount to offset the y coordinate by.
    * @returns {Circle} This circle instance for chaining.
    */
-  public offset(dx: number, dy: number) {
+  public offset(dx: number, dy: number): this {
     this.x += dx;
     this.y += dy;
     return this;
@@ -159,7 +159,7 @@ export class Circle {
    * @param {Point} point - The point to offset the circle by.
    * @returns {Circle} This circle instance for chaining.
    */
-  public offsetPoint(point: Point) {
+  public offsetPoint(point: Point): this {
     return this.offset(point.x, point.y);
   }
 
@@ -167,7 +167,7 @@ export class Circle {
    * Returns a string representation of this circle.
    * @returns {string} A string representation of the circle.
    */
-  public toString() {
+  public toString(): string {
     return `[{Circle (x=${this.x} y=${this.y} diameter=${this.diameter} radius=${this.radius})}]`;
   }
 
@@ -175,7 +175,7 @@ export class Circle {
    * Gets the diameter of this circle.
    * @returns {number} The diameter of this circle.
    */
-  public get diameter() {
+  public get diameter(): number {
     return this._diameter;
   }
 
@@ -193,7 +193,7 @@ export class Circle {
    * Gets the radius of this circle.
    * @returns {number} The radius of this circle.
    */
-  public get radius() {
+  public get radius(): number {
     return this._radius;
   }
 
@@ -211,7 +211,7 @@ export class Circle {
    * Gets the left coordinate of this circle.
    * @returns {number} The left coordinate of this circle.
    */
-  public get left() {
+  public get left(): number {
     return this.x - this._radius;
   }
 
@@ -231,7 +231,7 @@ export class Circle {
    * Gets the right coordinate of this circle.
    * @returns {number} The right coordinate of this circle.
    */
-  public get right() {
+  public get right(): number {
     return this.x + this._radius;
   }
 
@@ -251,7 +251,7 @@ export class Circle {
    * Gets the top coordinate of this circle.
    * @returns {number} The top coordinate of this circle.
    */
-  public get top() {
+  public get top(): number {
     return this.y - this._radius;
   }
 
@@ -271,7 +271,7 @@ export class Circle {
    * Gets the bottom coordinate of this circle.
    * @returns {number} The bottom coordinate of this circle.
    */
-  public get bottom() {
+  public get bottom(): number {
     return this.y + this._radius;
   }
 
@@ -291,7 +291,7 @@ export class Circle {
    * Gets the area of this circle.
    * @returns {number} The area of this circle.
    */
-  public get area() {
+  public get area(): number {
     if (this._radius > 0) {
       return Math.PI * this._radius * this._radius;
     }
@@ -302,7 +302,7 @@ export class Circle {
    * Checks if this circle is empty (has zero diameter).
    * @returns {boolean} True if the circle is empty, false otherwise.
    */
-  public get empty() {
+  public get empty(): boolean {
     return this._diameter === 0;
   }
 

package/src/phaser/geom/ellipse.ts

@@ -38,7 +38,7 @@ export class Ellipse {
    * @param {number} height - The new height of the ellipse.
    * @returns {Ellipse} This ellipse instance for chaining.
    */
-  public setTo(x: number, y: number, width: number, height: number) {
+  public setTo(x: number, y: number, width: number, height: number): this {
     this.x = x;
     this.y = y;
     this.width = width;
@@ -50,7 +50,7 @@ export class Ellipse {
    * Gets the bounding rectangle of this ellipse.
    * @returns {Rectangle} The bounding rectangle of this ellipse.
    */
-  public getBounds() {
+  public getBounds(): Rectangle {
     return new Rectangle(this.x - this.width, this.y - this.height, this.width, this.height);
   }
 
@@ -59,7 +59,7 @@ export class Ellipse {
    * @param {Ellipse} source - The ellipse to copy values from.
    * @returns {Ellipse} This ellipse instance for chaining.
    */
-  public copyFrom(source: Ellipse) {
+  public copyFrom(source: Ellipse): this {
     return this.setTo(source.x, source.y, source.width, source.height);
   }
 
@@ -68,7 +68,7 @@ export class Ellipse {
    * @param {Ellipse} dest - The ellipse to copy values to.
    * @returns {Ellipse} The destination ellipse.
    */
-  public copyTo(dest: Ellipse) {
+  public copyTo(dest: Ellipse): Ellipse {
     dest.x = this.x;
     dest.y = this.y;
     dest.width = this.width;
@@ -82,7 +82,7 @@ export class Ellipse {
    * @param {number} y - The y coordinate of the point to check.
    * @returns {boolean} True if the point is contained within this ellipse, false otherwise.
    */
-  public contains(x: number, y: number) {
+  public contains(x: number, y: number): boolean {
     return contains(this, x, y);
   }
 
@@ -91,7 +91,7 @@ export class Ellipse {
    * @param {Point} output - The point to store the result in (optional).
    * @returns {Point} A random point within this ellipse.
    */
-  public random(output: Point | null = null) {
+  public random(output: Point | null = null): Point {
     const result = output ?? new Point();
     const p = Math.random() * Math.PI * 2;
     const r = Math.random();
@@ -106,7 +106,7 @@ export class Ellipse {
    * Returns a string representation of this ellipse.
    * @returns {string} A string representation of the ellipse.
    */
-  public toString() {
+  public toString(): string {
     return `[{Ellipse (x=${this.x} y=${this.y} width=${this.width} height=${this.height})}]`;
   }
 }