@vpmedia/phaser 1.115.0 → 1.117.0

package/src/phaser/core/input_handler.ts

@@ -1,8 +1,8 @@
+import type { Group } from '../display/group.js';
 import { Point } from '../geom/point.js';
 import { distance } from '../util/math.js';
 import { GROUP } from './const.js';
 import type { Image } from '../display/image.js';
-import type { DisplayObject } from '../display/display_object.js';
 import type { Pointer } from './input_pointer.js';
 import type { Rectangle } from '../geom/rectangle.js';
 import type { Game } from './game.js';
@@ -44,7 +44,7 @@ const createPointerData = (id: number): PointerData => ({
 });
 
 export class InputHandler {
-  public sprite!: any;
+  public sprite!: Image;
   public game!: Game;
   public enabled!: boolean;
   public checked!: boolean;
@@ -54,8 +54,7 @@ export class InputHandler {
   public isDragged!: boolean;
   public allowHorizontalDrag!: boolean;
   public allowVerticalDrag!: boolean;
-  public bringToTop!: boolean;
-  public snapOffset!: any;
+  public snapOffset!: Point | null;
   public snapOnDrag!: boolean;
   public snapOnRelease!: boolean;
   public snapX!: number;
@@ -66,8 +65,8 @@ export class InputHandler {
   public pixelPerfectClick!: boolean;
   public pixelPerfectAlpha!: number;
   public draggable!: boolean;
-  public boundsRect!: any;
-  public boundsSprite!: any;
+  public boundsRect!: Rectangle | null;
+  public boundsSprite!: Image | null;
   public dragOffset!: Point;
   public dragFromCenter!: boolean;
   public dragStopBlocksInputUp!: boolean;
@@ -84,9 +83,9 @@ export class InputHandler {
   public _wasEnabled!: boolean;
   public _tempPoint!: Point;
   public _pointerData!: PointerData[];
-  public _dx!: any;
-  public _dy!: any;
-  public _draggedPointerID!: any;
+  public _dx!: number;
+  public _dy!: number;
+  public _draggedPointerID!: number;
   /**
    * TBD.
    * @param {Image} sprite - TBD.
@@ -102,7 +101,6 @@ export class InputHandler {
     this.isDragged = false;
     this.allowHorizontalDrag = true;
     this.allowVerticalDrag = true;
-    this.bringToTop = false;
     this.snapOffset = null;
     this.snapOnDrag = false;
     this.snapOnRelease = false;
@@ -162,7 +160,7 @@ export class InputHandler {
   /**
    * TBD.
    */
-  public addedToGroup() {
+  public addedToGroup(): void {
     if (this._dragPhase) {
       return;
     }
@@ -174,7 +172,7 @@ export class InputHandler {
   /**
    * TBD.
    */
-  public removedFromGroup() {
+  public removedFromGroup(): void {
     if (this._dragPhase) {
       return;
     }
@@ -189,7 +187,7 @@ export class InputHandler {
   /**
    * TBD.
    */
-  public reset() {
+  public reset(): void {
     this.enabled = false;
     for (let i = 0; i < 10; i += 1) {
       this._pointerData[i] = createPointerData(i);
@@ -214,7 +212,7 @@ export class InputHandler {
   /**
    * TBD.
    */
-  public stop() {
+  public stop(): void {
     if (this.enabled) {
       this.enabled = false;
       this.game.input.interactiveItems.remove(this);
@@ -224,7 +222,7 @@ export class InputHandler {
   /**
    * TBD.
    */
-  public destroy() {
+  public destroy(): void {
     if (this.sprite) {
       if (this._setHandCursor) {
         this.game.canvas.style.cursor = 'default';
@@ -235,7 +233,6 @@ export class InputHandler {
       this._pointerData.length = 0;
       this.boundsRect = null;
       this.boundsSprite = null;
-      this.sprite = null;
     }
   }
 
@@ -246,7 +243,7 @@ export class InputHandler {
    * @param {boolean} includePixelPerfect - TBD.
    * @returns {boolean} TBD.
    */
-  public validForInput(highestID: number, highestRenderID: number, includePixelPerfect = true) {
+  public validForInput(highestID: number, highestRenderID: number, includePixelPerfect = true): boolean {
     if (
       !this.enabled ||
       this.sprite.scale.x === 0 ||
@@ -270,7 +267,7 @@ export class InputHandler {
    * TBD.
    * @returns {boolean} TBD.
    */
-  public isPixelPerfect() {
+  public isPixelPerfect(): boolean {
     return this.pixelPerfectClick || this.pixelPerfectOver;
   }
 
@@ -279,7 +276,7 @@ export class InputHandler {
    * @param {number} pointerId - TBD.
    * @returns {number} TBD.
    */
-  public pointerX(pointerId = 0) {
+  public pointerX(pointerId = 0): number {
     return this.pointerData(pointerId).x;
   }
 
@@ -288,7 +285,7 @@ export class InputHandler {
    * @param {number} pointerId - TBD.
    * @returns {number} TBD.
    */
-  public pointerY(pointerId = 0) {
+  public pointerY(pointerId = 0): number {
     return this.pointerData(pointerId).y;
   }
 
@@ -297,7 +294,7 @@ export class InputHandler {
    * @param {number} pointerId - TBD.
    * @returns {boolean} TBD.
    */
-  public pointerDown(pointerId = 0) {
+  public pointerDown(pointerId = 0): boolean {
     return this.pointerData(pointerId).isDown;
   }
 
@@ -306,7 +303,7 @@ export class InputHandler {
    * @param {number} pointerId - TBD.
    * @returns {boolean} TBD.
    */
-  public pointerUp(pointerId = 0) {
+  public pointerUp(pointerId = 0): boolean {
     return this.pointerData(pointerId).isUp;
   }
 
@@ -315,7 +312,7 @@ export class InputHandler {
    * @param {number} pointerId - TBD.
    * @returns {number} TBD.
    */
-  public pointerTimeDown(pointerId = 0) {
+  public pointerTimeDown(pointerId = 0): number {
     return this.pointerData(pointerId).timeDown;
   }
 
@@ -324,7 +321,7 @@ export class InputHandler {
    * @param {number} pointerId - TBD.
    * @returns {number} TBD.
    */
-  public pointerTimeUp(pointerId = 0) {
+  public pointerTimeUp(pointerId = 0): number {
     return this.pointerData(pointerId).timeUp;
   }
 
@@ -333,7 +330,7 @@ export class InputHandler {
    * @param {number} pointerId - TBD.
    * @returns {boolean} TBD.
    */
-  public pointerOver(pointerId: number | null = null) {
+  public pointerOver(pointerId: number | null = null): boolean {
     if (!this.enabled) {
       return false;
     }
@@ -353,7 +350,7 @@ export class InputHandler {
    * @param {number} pointerId - TBD.
    * @returns {boolean} TBD.
    */
-  public pointerOut(pointerId: number | null = null) {
+  public pointerOut(pointerId: number | null = null): boolean {
     if (!this.enabled) {
       return false;
     }
@@ -373,7 +370,7 @@ export class InputHandler {
    * @param {number} pointerId - TBD.
    * @returns {number} TBD.
    */
-  public pointerTimeOver(pointerId = 0) {
+  public pointerTimeOver(pointerId = 0): number {
     return this.pointerData(pointerId).timeOver;
   }
 
@@ -382,7 +379,7 @@ export class InputHandler {
    * @param {number} pointerId - TBD.
    * @returns {number} TBD.
    */
-  public pointerTimeOut(pointerId = 0) {
+  public pointerTimeOut(pointerId = 0): number {
     return this.pointerData(pointerId).timeOut;
   }
 
@@ -391,7 +388,7 @@ export class InputHandler {
    * @param {number} pointerId - TBD.
    * @returns {boolean} TBD.
    */
-  public pointerDragged(pointerId = 0) {
+  public pointerDragged(pointerId = 0): boolean {
     return this.pointerData(pointerId).isDragged;
   }
 
@@ -401,7 +398,7 @@ export class InputHandler {
    * @param {boolean} fastTest - TBD.
    * @returns {boolean} TBD.
    */
-  public checkPointerDown(pointer: Pointer, fastTest = false) {
+  public checkPointerDown(pointer: Pointer, fastTest = false): boolean {
     if (
       !pointer.isDown ||
       !this.enabled ||
@@ -430,7 +427,7 @@ export class InputHandler {
    * @param {boolean} fastTest - TBD.
    * @returns {boolean} TBD.
    */
-  public checkPointerOver(pointer: Pointer, fastTest = false) {
+  public checkPointerOver(pointer: Pointer, fastTest = false): boolean {
     if (
       !this.enabled ||
       !this.sprite ||
@@ -459,12 +456,12 @@ export class InputHandler {
    * @param {Pointer} pointer - TBD.
    * @returns {boolean} TBD.
    */
-  public checkPixel(x: number | null, y: number | null, pointer?: any) {
+  public checkPixel(x: number | null, y: number | null, pointer?: Pointer): boolean {
     //  Grab a pixel from our image into the hitCanvas and then test it
     if (this.sprite.texture.baseTexture.source) {
       if (x === null || y === null) {
         //  Use the pointer parameter
-        this.game.input.getLocalPosition(this.sprite, pointer, this._tempPoint);
+        this.game.input.getLocalPosition(this.sprite, pointer!, this._tempPoint);
         x = this._tempPoint.x;
         y = this._tempPoint.y;
       }
@@ -493,10 +490,10 @@ export class InputHandler {
       }
       this._dx = x;
       this._dy = y;
-      this.game.input.hitContext.clearRect(0, 0, 1, 1);
-      this.game.input.hitContext.drawImage(this.sprite.texture.baseTexture.source, x, y, 1, 1, 0, 0, 1, 1);
-      const rgb = this.game.input.hitContext.getImageData(0, 0, 1, 1);
-      if (rgb.data[3] >= this.pixelPerfectAlpha) {
+      this.game.input.hitContext!.clearRect(0, 0, 1, 1);
+      this.game.input.hitContext!.drawImage(this.sprite.texture.baseTexture.source, x, y, 1, 1, 0, 0, 1, 1);
+      const rgb = this.game.input.hitContext!.getImageData(0, 0, 1, 1);
+      if (rgb.data[3]! >= this.pixelPerfectAlpha) {
         return true;
       }
     }
@@ -508,12 +505,12 @@ export class InputHandler {
    * @param {Pointer} pointer - TBD.
    * @returns {boolean} TBD.
    */
-  public update(pointer: Pointer) {
+  public update(pointer: Pointer): boolean {
     if (this.sprite === null || this.sprite.parent === undefined) {
       // Abort. We've been destroyed.
       return false;
     }
-    if (!this.enabled || !this.sprite.visible || !this.sprite.parent.visible) {
+    if (!this.enabled || !this.sprite.visible || !this.sprite.parent?.visible) {
       this._pointerOutHandler(pointer);
       return false;
     }
@@ -545,7 +542,7 @@ export class InputHandler {
    * @param {Pointer} pointer - TBD.
    * @param {boolean} silent - TBD.
    */
-  public _pointerOverHandler(pointer: Pointer, silent: boolean) {
+  public _pointerOverHandler(pointer: Pointer, silent: boolean): void {
     if (this.sprite === null) {
       // Abort. We've been destroyed.
       return;
@@ -566,7 +563,7 @@ export class InputHandler {
         this.sprite.events.onInputOver$dispatch(this.sprite, pointer);
       }
       if (this.sprite.parent && this.sprite.parent.type === GROUP) {
-        this.sprite.parent.onChildInputOver.dispatch(this.sprite, pointer);
+        (this.sprite.parent as Group).onChildInputOver.dispatch(this.sprite, pointer);
       }
     }
   }
@@ -576,7 +573,7 @@ export class InputHandler {
    * @param {Pointer} pointer - TBD.
    * @param {boolean} silent - TBD.
    */
-  public _pointerOutHandler(pointer: Pointer, silent = false) {
+  public _pointerOutHandler(pointer: Pointer, silent = false): void {
     if (this.sprite === null) {
       // Abort. We've been destroyed.
       return;
@@ -592,7 +589,7 @@ export class InputHandler {
     if (!silent && this.sprite && this.sprite.events) {
       this.sprite.events.onInputOut$dispatch(this.sprite, pointer);
       if (this.sprite && this.sprite.parent && this.sprite.parent.type === GROUP) {
-        this.sprite.parent.onChildInputOut.dispatch(this.sprite, pointer);
+        (this.sprite.parent as Group).onChildInputOut.dispatch(this.sprite, pointer);
       }
     }
   }
@@ -601,7 +598,7 @@ export class InputHandler {
    * TBD.
    * @param {Pointer} pointer - TBD.
    */
-  public _touchedHandler(pointer: Pointer) {
+  public _touchedHandler(pointer: Pointer): void {
     if (this.sprite === null) {
       // Abort. We've been destroyed.
       return;
@@ -621,7 +618,7 @@ export class InputHandler {
         this.sprite.events.onInputDown$dispatch(this.sprite, pointer);
         // The event above might have destroyed this sprite.
         if (this.sprite && this.sprite.parent && this.sprite.parent.type === GROUP) {
-          this.sprite.parent.onChildInputDown.dispatch(this.sprite, pointer);
+          (this.sprite.parent as Group).onChildInputDown.dispatch(this.sprite, pointer);
         }
         //  The events might have destroyed this sprite.
         if (this.sprite === null) {
@@ -643,9 +640,6 @@ export class InputHandler {
           }
         }
       }
-      if (this.bringToTop) {
-        this.sprite.bringToTop();
-      }
     }
   }
 
@@ -653,7 +647,7 @@ export class InputHandler {
    * TBD.
    * @param {Pointer} pointer - TBD.
    */
-  public dragTimeElapsed(pointer: Pointer) {
+  public dragTimeElapsed(pointer: Pointer): void {
     this._dragTimePass = true;
     if (this._pendingDrag && this.sprite) {
       if (this._dragDistancePass) {
@@ -666,7 +660,7 @@ export class InputHandler {
    * TBD.
    * @param {Pointer} pointer - TBD.
    */
-  public _releasedHandler(pointer: Pointer) {
+  public _releasedHandler(pointer: Pointer): void {
     if (this.sprite === null) {
       // Abort. We've been destroyed.
       return;
@@ -688,7 +682,7 @@ export class InputHandler {
           this.sprite.events.onInputUp$dispatch(this.sprite, pointer, isOver);
         }
         if (this.sprite && this.sprite.parent && this.sprite.parent.type === GROUP) {
-          this.sprite.parent.onChildInputUp.dispatch(this.sprite, pointer, isOver);
+          (this.sprite.parent as Group).onChildInputUp.dispatch(this.sprite, pointer, isOver);
         }
         // The onInputUp event may have changed the sprite so that checkPointerOver is no longer true, so update it.
         if (isOver) {
@@ -716,7 +710,7 @@ export class InputHandler {
    * @param {boolean} fromStart - TBD.
    * @returns {boolean} TBD.
    */
-  public updateDrag(pointer: Pointer, fromStart = false) {
+  public updateDrag(pointer: Pointer, fromStart = false): boolean {
     if (pointer.isUp) {
       this.stopDrag(pointer);
       return false;
@@ -756,7 +750,7 @@ export class InputHandler {
    * @param {number} delay - TBD.
    * @returns {boolean} TBD.
    */
-  public justOver(pointerId = 0, delay = 500) {
+  public justOver(pointerId = 0, delay = 500): boolean {
     return this.pointerData(pointerId).isOver && this.overDuration(pointerId) < delay;
   }
 
@@ -766,7 +760,7 @@ export class InputHandler {
    * @param {number} delay - TBD.
    * @returns {boolean} TBD.
    */
-  public justOut(pointerId = 0, delay = 500) {
+  public justOut(pointerId = 0, delay = 500): boolean {
     return this.pointerData(pointerId).isOut && this.game.time.time - this.pointerData(pointerId).timeOut < delay;
   }
 
@@ -776,7 +770,7 @@ export class InputHandler {
    * @param {number} delay - TBD.
    * @returns {boolean} TBD.
    */
-  public justPressed(pointerId = 0, delay = 500) {
+  public justPressed(pointerId = 0, delay = 500): boolean {
     return this.pointerData(pointerId).isDown && this.downDuration(pointerId) < delay;
   }
 
@@ -786,7 +780,7 @@ export class InputHandler {
    * @param {number} delay - TBD.
    * @returns {boolean} TBD.
    */
-  public justReleased(pointerId = 0, delay = 500) {
+  public justReleased(pointerId = 0, delay = 500): boolean {
     return this.pointerData(pointerId).isUp && this.game.time.time - this.pointerData(pointerId).timeUp < delay;
   }
 
@@ -795,7 +789,7 @@ export class InputHandler {
    * @param {number} pointerId - TBD.
    * @returns {number} TBD.
    */
-  public overDuration(pointerId = 0) {
+  public overDuration(pointerId = 0): number {
     if (this.pointerData(pointerId).isOver) {
       return this.game.time.time - this.pointerData(pointerId).timeOver;
     }
@@ -807,7 +801,7 @@ export class InputHandler {
    * @param {number} pointerId - TBD.
    * @returns {number} TBD.
    */
-  public downDuration(pointerId = 0) {
+  public downDuration(pointerId = 0): number {
     if (this.pointerData(pointerId).isDown) {
       return this.game.time.time - this.pointerData(pointerId).timeDown;
     }
@@ -821,19 +815,19 @@ export class InputHandler {
    * @param {boolean} pixelPerfect - TBD.
    * @param {number} alphaThreshold - TBD.
    * @param {Rectangle | null | undefined} boundsRect - TBD.
-   * @param {DisplayObject | null | undefined} boundsSprite - TBD.
+   * @param {Image | null | undefined} boundsSprite - TBD.
    */
   public enableDrag(
     lockCenter = false,
-    bringToTop = false,
+    // Kept so the positional signature holds; this engine has no bringToTop to raise the sprite.
+    _bringToTop = false,
     pixelPerfect = false,
     alphaThreshold = 255,
     boundsRect: Rectangle | null | undefined = null,
-    boundsSprite: DisplayObject | null | undefined = null
-  ) {
+    boundsSprite: Image | null | undefined = null
+  ): void {
     this._dragPoint = new Point();
     this.draggable = true;
-    this.bringToTop = bringToTop;
     this.dragOffset = new Point();
     this.dragFromCenter = lockCenter;
     this.pixelPerfectClick = pixelPerfect;
@@ -849,7 +843,7 @@ export class InputHandler {
   /**
    * TBD.
    */
-  public disableDrag() {
+  public disableDrag(): void {
     if (this._pointerData) {
       for (let i = 0; i < 10; i += 1) {
         this.pointerData(i).isDragged = false;
@@ -865,7 +859,7 @@ export class InputHandler {
    * TBD.
    * @param {Pointer} pointer - TBD.
    */
-  public startDrag(pointer: Pointer) {
+  public startDrag(pointer: Pointer): void {
     const { x } = this.sprite;
     const { y } = this.sprite;
     this.isDragged = true;
@@ -883,10 +877,6 @@ export class InputHandler {
       this.sprite.y - this.globalToLocalY(pointer.y)
     );
     this.updateDrag(pointer, true);
-    if (this.bringToTop) {
-      this._dragPhase = true;
-      this.sprite.parent.bringToTop(this.sprite);
-    }
     this.dragStartPoint.setTo(x, y);
     this.sprite.events.onDragStart$dispatch(this.sprite, pointer, x, y);
     this._pendingDrag = false;
@@ -897,7 +887,7 @@ export class InputHandler {
    * @param {number} x - TBD.
    * @returns {number} TBD.
    */
-  public globalToLocalX(x: number) {
+  public globalToLocalX(x: number): number {
     return x;
   }
 
@@ -906,7 +896,7 @@ export class InputHandler {
    * @param {number} y - TBD.
    * @returns {number} TBD.
    */
-  public globalToLocalY(y: number) {
+  public globalToLocalY(y: number): number {
     return y;
   }
 
@@ -914,7 +904,7 @@ export class InputHandler {
    * TBD.
    * @param {Pointer} pointer - TBD.
    */
-  public stopDrag(pointer: Pointer) {
+  public stopDrag(pointer: Pointer): void {
     this.isDragged = false;
     this._draggedPointerID = -1;
     this.pointerData(pointer.id).isDragged = false;
@@ -939,7 +929,7 @@ export class InputHandler {
    * @param {boolean} allowHorizontal - TBD.
    * @param {boolean} allowVertical - TBD.
    */
-  public setDragLock(allowHorizontal = true, allowVertical = true) {
+  public setDragLock(allowHorizontal = true, allowVertical = true): void {
     this.allowHorizontalDrag = allowHorizontal;
     this.allowVerticalDrag = allowVertical;
   }
@@ -953,7 +943,14 @@ export class InputHandler {
    * @param {number} snapOffsetX - TBD.
    * @param {number} snapOffsetY - TBD.
    */
-  public enableSnap(snapX: number, snapY: number, onDrag = true, onRelease = false, snapOffsetX = 0, snapOffsetY = 0) {
+  public enableSnap(
+    snapX: number,
+    snapY: number,
+    onDrag = true,
+    onRelease = false,
+    snapOffsetX = 0,
+    snapOffsetY = 0
+  ): void {
     this.snapX = snapX;
     this.snapY = snapY;
     this.snapOffsetX = snapOffsetX;
@@ -965,7 +962,7 @@ export class InputHandler {
   /**
    * TBD.
    */
-  public disableSnap() {
+  public disableSnap(): void {
     this.snapOnDrag = false;
     this.snapOnRelease = false;
   }
@@ -973,32 +970,32 @@ export class InputHandler {
   /**
    * TBD.
    */
-  public checkBoundsRect() {
-    if (this.sprite.left < this.boundsRect.left) {
-      this.sprite.x = this.boundsRect.x + this.sprite.offsetX;
-    } else if (this.sprite.right > this.boundsRect.right) {
-      this.sprite.x = this.boundsRect.right - (this.sprite.width - this.sprite.offsetX);
+  public checkBoundsRect(): void {
+    if (this.sprite.left < this.boundsRect!.left) {
+      this.sprite.x = this.boundsRect!.x + this.sprite.offsetX;
+    } else if (this.sprite.right > this.boundsRect!.right) {
+      this.sprite.x = this.boundsRect!.right - (this.sprite.width - this.sprite.offsetX);
     }
-    if (this.sprite.top < this.boundsRect.top) {
-      this.sprite.y = this.boundsRect.top + this.sprite.offsetY;
-    } else if (this.sprite.bottom > this.boundsRect.bottom) {
-      this.sprite.y = this.boundsRect.bottom - (this.sprite.height - this.sprite.offsetY);
+    if (this.sprite.top < this.boundsRect!.top) {
+      this.sprite.y = this.boundsRect!.top + this.sprite.offsetY;
+    } else if (this.sprite.bottom > this.boundsRect!.bottom) {
+      this.sprite.y = this.boundsRect!.bottom - (this.sprite.height - this.sprite.offsetY);
     }
   }
 
   /**
    * TBD.
    */
-  public checkBoundsSprite() {
-    if (this.sprite.left < this.boundsSprite.left) {
-      this.sprite.x = this.boundsSprite.left + this.sprite.offsetX;
-    } else if (this.sprite.right > this.boundsSprite.right) {
-      this.sprite.x = this.boundsSprite.right - (this.sprite.width - this.sprite.offsetX);
+  public checkBoundsSprite(): void {
+    if (this.sprite.left < this.boundsSprite!.left) {
+      this.sprite.x = this.boundsSprite!.left + this.sprite.offsetX;
+    } else if (this.sprite.right > this.boundsSprite!.right) {
+      this.sprite.x = this.boundsSprite!.right - (this.sprite.width - this.sprite.offsetX);
     }
-    if (this.sprite.top < this.boundsSprite.top) {
-      this.sprite.y = this.boundsSprite.top + this.sprite.offsetY;
-    } else if (this.sprite.bottom > this.boundsSprite.bottom) {
-      this.sprite.y = this.boundsSprite.bottom - (this.sprite.height - this.sprite.offsetY);
+    if (this.sprite.top < this.boundsSprite!.top) {
+      this.sprite.y = this.boundsSprite!.top + this.sprite.offsetY;
+    } else if (this.sprite.bottom > this.boundsSprite!.bottom) {
+      this.sprite.y = this.boundsSprite!.bottom - (this.sprite.height - this.sprite.offsetY);
     }
   }
 }