@vpmedia/phaser 1.115.0 → 1.117.0

package/src/phaser/core/scale_manager.ts

@@ -5,6 +5,21 @@ import type { Game } from './game.js';
 import { DOM } from './dom.js';
 import { Signal } from './signal.js';
 
+/** The gap the canvas leaves around itself inside its parent. */
+export type ScaleMargin = { left: number; top: number; right: number; bottom: number; x: number; y: number };
+
+/** Which edges the layout is allowed to expand against. */
+export type WindowConstraints = { right: string; bottom: string };
+
+/** What the host browser supports, probed once at boot. */
+export type ScaleCompatibility = {
+  supportsFullScreen: boolean;
+  orientationFallback: string | null;
+  noMargins: boolean;
+  canExpandParent: boolean;
+  clickTrampoline: string;
+};
+
 export class ScaleManager {
   public game!: Game;
   public dom!: DOM;
@@ -24,32 +39,32 @@ export class ScaleManager {
   public enterIncorrectOrientation!: Signal;
   public leaveIncorrectOrientation!: Signal;
   public hasPhaserSetFullScreen!: boolean;
-  public fullScreenTarget!: any;
-  public _createdFullScreenTarget!: any;
+  public fullScreenTarget!: HTMLElement | null;
+  public _createdFullScreenTarget!: HTMLElement | null;
   public onFullScreenInit!: Signal;
   public onFullScreenChange!: Signal;
   public onFullScreenError!: Signal;
-  public screenOrientation!: any;
+  public screenOrientation!: string;
   public scaleFactor!: Point;
   public scaleFactorInversed!: Point;
-  public margin!: any;
+  public margin!: ScaleMargin;
   public bounds!: Rectangle;
   public aspectRatio!: number;
   public sourceAspectRatio!: number;
   public event!: Event | null | undefined;
-  public windowConstraints!: any;
-  public compatibility!: any;
+  public windowConstraints!: WindowConstraints;
+  public compatibility!: ScaleCompatibility;
   public _scaleMode!: number;
   public _fullScreenScaleMode!: number;
   public parentIsWindow!: boolean;
-  public parentNode!: any;
+  public parentNode!: HTMLElement | null;
   public parentScaleFactor!: Point;
   public trackParentInterval!: number;
   public onSizeChange!: Signal;
-  public onResize!: any;
-  public onResizeContext!: any;
-  public _pendingScaleMode!: any;
-  public _fullScreenRestore!: any;
+  public onResize!: Function | null;
+  public onResizeContext!: unknown;
+  public _pendingScaleMode!: number | null;
+  public _fullScreenRestore!: { targetWidth: string; targetHeight: string } | null;
   public _gameSize!: Rectangle;
   public _userScaleFactor!: Point;
   public _userScaleTrim!: Point;
@@ -152,7 +167,7 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public boot() {
+  public boot(): void {
     // Configure device-dependent compatibility
     const compat = this.compatibility;
     compat.supportsFullScreen = this.game.device.fullscreen;
@@ -165,20 +180,20 @@ export class ScaleManager {
     }
     // Configure event listeners
     const scope = this;
-    this._orientationChange = (event) => {
+    this._orientationChange = (event): void => {
       scope.orientationChange(event);
     };
-    this._windowResize = (event) => {
+    this._windowResize = (event): void => {
       scope.windowResize(event);
     };
     // This does not appear to be on the standards track
     globalThis.addEventListener('orientationchange', this._orientationChange, false);
     window.addEventListener('resize', this._windowResize, false);
     if (this.compatibility.supportsFullScreen) {
-      this._fullScreenChange = (event) => {
+      this._fullScreenChange = (event): void => {
         scope.fullScreenChange(event);
       };
-      this._fullScreenError = (event) => {
+      this._fullScreenError = (event): void => {
         scope.fullScreenError(event);
       };
       document.addEventListener('webkitfullscreenchange', this._fullScreenChange, false);
@@ -208,7 +223,7 @@ export class ScaleManager {
    * TBD.
    * @param {object} config - TBD.
    */
-  public parseConfig(config: any) {
+  public parseConfig(config: any): void {
     if (config.scaleMode !== undefined) {
       if (this._booted) {
         this.scaleMode = config.scaleMode;
@@ -231,7 +246,7 @@ export class ScaleManager {
    * @param {number} width - TBD.
    * @param {number} height - TBD.
    */
-  public setupScale(width: number, height: number) {
+  public setupScale(width: number, height: number): void {
     let target;
     const rect = new Rectangle();
     if (this.game.parent !== '') {
@@ -284,7 +299,7 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public _gameResumed() {
+  public _gameResumed(): void {
     this.queueUpdate(true);
   }
 
@@ -293,7 +308,7 @@ export class ScaleManager {
    * @param {number} width - TBD.
    * @param {number} height - TBD.
    */
-  public setGameSize(width: number, height: number) {
+  public setGameSize(width: number, height: number): void {
     this._gameSize.setTo(0, 0, width, height);
     if (this.currentScaleMode !== SCALE_RESIZE) {
       this.updateDimensions(width, height, true);
@@ -308,7 +323,7 @@ export class ScaleManager {
    * @param {number} hTrim - TBD.
    * @param {number} vTrim - TBD.
    */
-  public setUserScale(hScale: number, vScale: number, hTrim: number, vTrim: number) {
+  public setUserScale(hScale: number, vScale: number, hTrim: number, vTrim: number): void {
     this._userScaleFactor.setTo(hScale, vScale);
     this._userScaleTrim.setTo(Math.trunc(hTrim), Math.trunc(vTrim));
     this.queueUpdate(true);
@@ -319,7 +334,7 @@ export class ScaleManager {
    * @param {Function} callback - TBD.
    * @param {object} context - TBD.
    */
-  public setResizeCallback(callback: Function, context: CanvasRenderingContext2D) {
+  public setResizeCallback(callback: Function, context: unknown): void {
     this.onResize = callback;
     this.onResizeContext = context;
   }
@@ -327,7 +342,7 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public signalSizeChange() {
+  public signalSizeChange(): void {
     if (
       this.width !== this._lastReportedCanvasSize.width ||
       this.height !== this._lastReportedCanvasSize.height ||
@@ -354,7 +369,7 @@ export class ScaleManager {
    * @param {number} maxWidth - TBD.
    * @param {number} maxHeight - TBD.
    */
-  public setMinMax(minWidth: number, minHeight: number, maxWidth: number, maxHeight: number) {
+  public setMinMax(minWidth: number, minHeight: number, maxWidth: number, maxHeight: number): void {
     this.minWidth = minWidth;
     this.minHeight = minHeight;
     if (maxWidth !== undefined) {
@@ -368,7 +383,7 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public preUpdate() {
+  public preUpdate(): void {
     if (this.game.time.time < this._lastUpdate + this._updateThrottle) {
       return;
     }
@@ -401,7 +416,7 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public pauseUpdate() {
+  public pauseUpdate(): void {
     this.preUpdate();
     // Updates at slowest.
     this._updateThrottle = this.trackParentInterval;
@@ -413,7 +428,7 @@ export class ScaleManager {
    * @param {number} height - TBD.
    * @param {boolean} resize - TBD.
    */
-  public updateDimensions(width: number, height: number, resize: boolean) {
+  public updateDimensions(width: number, height: number, resize: boolean): void {
     this.width = width * this.parentScaleFactor.x;
     this.height = height * this.parentScaleFactor.y;
     this.game.width = this.width;
@@ -429,7 +444,7 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public updateScalingAndBounds() {
+  public updateScalingAndBounds(): void {
     this.scaleFactor.x = this.game.width / this.width;
     this.scaleFactor.y = this.game.height / this.height;
     this.scaleFactorInversed.x = this.width / this.game.width;
@@ -451,7 +466,7 @@ export class ScaleManager {
    * @param {boolean} forceLandscape - TBD.
    * @param {boolean} forcePortrait - TBD.
    */
-  public forceOrientation(forceLandscape = false, forcePortrait = false) {
+  public forceOrientation(forceLandscape = false, forcePortrait = false): void {
     this.forceLandscape = forceLandscape;
     this.forcePortrait = forcePortrait;
     this.queueUpdate(true);
@@ -462,7 +477,7 @@ export class ScaleManager {
    * @param {string} orientation - TBD.
    * @returns {string} TBD.
    */
-  public classifyOrientation(orientation: string) {
+  public classifyOrientation(orientation: string): 'portrait' | 'landscape' | null {
     if (orientation === 'portrait-primary' || orientation === 'portrait-secondary') {
       return 'portrait';
     } else if (orientation === 'landscape-primary' || orientation === 'landscape-secondary') {
@@ -475,7 +490,7 @@ export class ScaleManager {
    * TBD.
    * @returns {boolean} TBD.
    */
-  public updateOrientationState() {
+  public updateOrientationState(): boolean {
     const previousOrientation = this.screenOrientation;
     const previouslyIncorrect = this.incorrectOrientation;
     this.screenOrientation = this.dom.getScreenOrientation(this.compatibility.orientationFallback);
@@ -499,7 +514,7 @@ export class ScaleManager {
    * TBD.
    * @param {Event} event - TBD.
    */
-  public orientationChange(event: Event) {
+  public orientationChange(event: Event): void {
     this.event = event;
     this.queueUpdate(true);
   }
@@ -508,7 +523,7 @@ export class ScaleManager {
    * TBD.
    * @param {Event} event - TBD.
    */
-  public windowResize(event: Event) {
+  public windowResize(event: Event): void {
     this.event = event;
     this.queueUpdate(true);
   }
@@ -516,14 +531,14 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public refresh() {
+  public refresh(): void {
     this.queueUpdate(true);
   }
 
   /**
    * TBD.
    */
-  public updateLayout() {
+  public updateLayout(): void {
     const scaleMode = this.currentScaleMode;
     if (scaleMode === SCALE_RESIZE) {
       this.reflowGame();
@@ -567,7 +582,7 @@ export class ScaleManager {
    * @param {Rectangle} target - TBD.
    * @returns {Rectangle} TBD.
    */
-  public getParentBounds(target: Rectangle) {
+  public getParentBounds(target: Rectangle): Rectangle {
     const bounds = target || new Rectangle();
     const parentNode = this.boundingParent;
     const { visualBounds } = this.dom;
@@ -605,7 +620,7 @@ export class ScaleManager {
    * @param {boolean} horizontal - TBD.
    * @param {boolean} vertical - TBD.
    */
-  public alignCanvas(horizontal: boolean, vertical: boolean) {
+  public alignCanvas(horizontal: boolean, vertical: boolean): void {
     const parentBounds = this.getParentBounds(this._tempBounds);
     const { canvas } = this.game;
     const { margin } = this;
@@ -651,7 +666,7 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public reflowGame() {
+  public reflowGame(): void {
     this.resetCanvas('', '');
     const bounds = this.getParentBounds(this._tempBounds);
     this.updateDimensions(bounds.width, bounds.height, true);
@@ -660,7 +675,7 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public reflowCanvas() {
+  public reflowCanvas(): void {
     if (!this.incorrectOrientation) {
       this.width = Math.max(this.minWidth ?? 0, Math.min(this.maxWidth ?? this.width, this.width));
       this.height = Math.max(this.minHeight ?? 0, Math.min(this.maxHeight ?? this.height, this.height));
@@ -681,7 +696,7 @@ export class ScaleManager {
    * @param {string} cssWidth - TBD.
    * @param {string} cssHeight - TBD.
    */
-  public resetCanvas(cssWidth = `${this.width}px`, cssHeight = `${this.height}px`) {
+  public resetCanvas(cssWidth = `${this.width}px`, cssHeight = `${this.height}px`): void {
     const { canvas } = this.game;
     if (!this.compatibility.noMargins) {
       canvas.style.marginLeft = '';
@@ -697,7 +712,7 @@ export class ScaleManager {
    * TBD.
    * @param {boolean} force - TBD.
    */
-  public queueUpdate(force: boolean) {
+  public queueUpdate(force: boolean): void {
     if (force) {
       this._parentBounds.width = 0;
       this._parentBounds.height = 0;
@@ -708,14 +723,14 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public reset() {
+  public reset(): void {
     // pass
   }
 
   /**
    * TBD.
    */
-  public setMaximum() {
+  public setMaximum(): void {
     this.width = this.dom.visualBounds.width;
     this.height = this.dom.visualBounds.height;
   }
@@ -724,7 +739,7 @@ export class ScaleManager {
    * TBD.
    * @param {boolean} expanding - TBD.
    */
-  public setShowAll(expanding = false) {
+  public setShowAll(expanding = false): void {
     const bounds = this.getParentBounds(this._tempBounds);
     const { width } = bounds;
     const { height } = bounds;
@@ -741,7 +756,7 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public setExactFit() {
+  public setExactFit(): void {
     const bounds = this.getParentBounds(this._tempBounds);
     this.width = bounds.width;
     this.height = bounds.height;
@@ -761,7 +776,7 @@ export class ScaleManager {
    * TBD.
    * @returns {HTMLDivElement} TBD.
    */
-  public createFullScreenTarget() {
+  public createFullScreenTarget(): HTMLDivElement {
     const fsTarget = document.createElement('div');
     fsTarget.style.margin = '0';
     fsTarget.style.padding = '0';
@@ -775,14 +790,14 @@ export class ScaleManager {
    * @param {boolean} allowTrampoline - TBD.
    * @returns {boolean} TBD.
    */
-  public startFullScreen(antialias: boolean, allowTrampoline: boolean) {
+  public startFullScreen(antialias: boolean, allowTrampoline: boolean): boolean {
     if (this.isFullScreen) {
       return false;
     }
     if (!this.compatibility.supportsFullScreen) {
       // Error is called in timeout to emulate the real fullscreenerror event better
       const scope = this;
-      setTimeout(() => {
+      setTimeout((): void => {
         scope.fullScreenError({} as any);
       }, 10);
       return false;
@@ -815,10 +830,14 @@ export class ScaleManager {
       }
       fsTarget.append(canvas);
     }
+    // The request method is vendor-prefixed, so it is looked up by the name the device reported.
+    const requestFullscreen = (fsTarget as unknown as Record<string, ((flag?: unknown) => void) | undefined>)[
+      this.game.device.requestFullscreen
+    ];
     if (this.game.device.fullscreenKeyboard) {
-      fsTarget[this.game.device.requestFullscreen]((Element as any).ALLOW_KEYBOARD_INPUT);
+      requestFullscreen?.call(fsTarget, (Element as unknown as { ALLOW_KEYBOARD_INPUT: unknown }).ALLOW_KEYBOARD_INPUT);
     } else {
-      fsTarget[this.game.device.requestFullscreen]();
+      requestFullscreen?.call(fsTarget);
     }
     return true;
   }
@@ -827,7 +846,7 @@ export class ScaleManager {
    * TBD.
    * @returns {boolean} TBD.
    */
-  public stopFullScreen() {
+  public stopFullScreen(): boolean {
     if (!this.isFullScreen || !this.compatibility.supportsFullScreen) {
       return false;
     }
@@ -839,7 +858,7 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public cleanupCreatedTarget() {
+  public cleanupCreatedTarget(): void {
     const fsTarget = this._createdFullScreenTarget;
     if (fsTarget && fsTarget.parentNode) {
       // Make sure to cleanup synthetic target for sure;
@@ -855,7 +874,7 @@ export class ScaleManager {
    * TBD.
    * @param {boolean} enteringFullscreen - TBD.
    */
-  public prepScreenMode(enteringFullscreen: boolean) {
+  public prepScreenMode(enteringFullscreen: boolean): void {
     const fsTarget = this._createdFullScreenTarget ?? this.fullScreenTarget;
     if (!fsTarget) {
       return;
@@ -889,7 +908,7 @@ export class ScaleManager {
    * TBD.
    * @param {Event} event - TBD.
    */
-  public fullScreenChange(event: Event) {
+  public fullScreenChange(event: Event): void {
     this.event = event;
     if (this.isFullScreen) {
       this.prepScreenMode(true);
@@ -908,7 +927,7 @@ export class ScaleManager {
    * TBD.
    * @param {Event} [event] - TBD.
    */
-  public fullScreenError(event: Event) {
+  public fullScreenError(event: Event): void {
     this.event = event;
     this.cleanupCreatedTarget();
     this.onFullScreenError.dispatch(this);
@@ -917,7 +936,7 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public destroy() {
+  public destroy(): void {
     this.game.onResume.remove(this._gameResumed, this);
     globalThis.removeEventListener('orientationchange', this._orientationChange, false);
     window.removeEventListener('resize', this._windowResize, false);
@@ -938,7 +957,7 @@ export class ScaleManager {
    * TBD.
    * @returns {ParentNode | null} TBD.
    */
-  public get boundingParent() {
+  public get boundingParent(): HTMLElement | null {
     if (this.parentIsWindow || (this.isFullScreen && this.hasPhaserSetFullScreen && !this._createdFullScreenTarget)) {
       return null;
     }
@@ -950,7 +969,7 @@ export class ScaleManager {
    * TBD.
    * @returns {number} TBD.
    */
-  public get scaleMode() {
+  public get scaleMode(): number {
     return this._scaleMode;
   }
 
@@ -972,7 +991,7 @@ export class ScaleManager {
    * TBD.
    * @returns {number} TBD.
    */
-  public get fullScreenScaleMode() {
+  public get fullScreenScaleMode(): number {
     return this._fullScreenScaleMode;
   }
 
@@ -998,7 +1017,7 @@ export class ScaleManager {
    * TBD.
    * @returns {number} TBD.
    */
-  public get currentScaleMode() {
+  public get currentScaleMode(): number {
     return this.isFullScreen ? this._fullScreenScaleMode : this._scaleMode;
   }
 
@@ -1006,7 +1025,7 @@ export class ScaleManager {
    * TBD.
    * @returns {boolean} TBD.
    */
-  public get pageAlignHorizontally() {
+  public get pageAlignHorizontally(): boolean {
     return this._pageAlignHorizontally;
   }
 
@@ -1014,7 +1033,7 @@ export class ScaleManager {
    * TBD.
    * @returns {boolean} TBD.
    */
-  public get pageAlignVertically() {
+  public get pageAlignVertically(): boolean {
     return this._pageAlignVertically;
   }
 
@@ -1022,7 +1041,7 @@ export class ScaleManager {
    * TBD.
    * @returns {boolean} TBD.
    */
-  public get isFullScreen() {
+  public get isFullScreen(): boolean {
     return Boolean(
       document.fullscreenElement ??
       (document as any).webkitFullscreenElement ??
@@ -1035,7 +1054,7 @@ export class ScaleManager {
    * TBD.
    * @returns {boolean} TBD.
    */
-  public get isPortrait() {
+  public get isPortrait(): boolean {
     return this.classifyOrientation(this.screenOrientation) === 'portrait';
   }
 
@@ -1043,7 +1062,7 @@ export class ScaleManager {
    * TBD.
    * @returns {boolean} TBD.
    */
-  public get isLandscape() {
+  public get isLandscape(): boolean {
     return this.classifyOrientation(this.screenOrientation) === 'landscape';
   }
 
@@ -1051,7 +1070,7 @@ export class ScaleManager {
    * TBD.
    * @returns {boolean} TBD.
    */
-  public get isGamePortrait() {
+  public get isGamePortrait(): boolean {
     return this.height > this.width;
   }
 
@@ -1059,7 +1078,7 @@ export class ScaleManager {
    * TBD.
    * @returns {boolean} TBD.
    */
-  public get isGameLandscape() {
+  public get isGameLandscape(): boolean {
     return this.width > this.height;
   }
 }

package/src/phaser/core/scene.ts

@@ -9,7 +9,7 @@ export class Scene {
    * Initialize the scene.
    * This method is called before preload() and create().
    */
-  public init() {
+  public init(): void {
     // inherit
   }
 
@@ -17,7 +17,7 @@ export class Scene {
    * Load assets for the scene.
    * This method is called after init() and before create().
    */
-  public preload() {
+  public preload(): void {
     // inherit
   }
 
@@ -25,7 +25,7 @@ export class Scene {
    * Create the scene.
    * This method is called after preload() and is where you create your game objects.
    */
-  public create() {
+  public create(): void {
     // inherit
   }
 
@@ -33,7 +33,7 @@ export class Scene {
    * Update the scene.
    * This method is called every frame while the scene is active.
    */
-  public update() {
+  public update(): void {
     // inherit
   }
 
@@ -42,7 +42,7 @@ export class Scene {
    * @param {number} _width - The new width of the scene.
    * @param {number} _height - The new height of the scene.
    */
-  public resize(_width: number, _height: number) {
+  public resize(_width: number, _height: number): void {
     // inherit
   }
 
@@ -50,7 +50,7 @@ export class Scene {
    * Update the scene while paused.
    * This method is called every frame while the scene is paused.
    */
-  public pauseUpdate() {
+  public pauseUpdate(): void {
     // inherit
   }
 
@@ -58,7 +58,7 @@ export class Scene {
    * Shutdown the scene.
    * This method is called when the scene is about to be destroyed.
    */
-  public shutdown() {
+  public shutdown(): void {
     // inherit
   }
 }