@vpmedia/phaser 1.21.0 → 1.22.0

package/README.md

@@ -1,6 +1,6 @@
 # @vpmedia/phaser
 
-[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.21.0)](https://badge.fury.io/js/@vpmedia%2Fphaser)
+[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.22.0)](https://badge.fury.io/js/@vpmedia%2Fphaser)
 [![Node.js CI](https://github.com/vpmedia/phaser/actions/workflows/node.js.yml/badge.svg)](https://github.com/vpmedia/phaser/actions/workflows/node.js.yml)
 
 @vpmedia/phaser is the modern ECMAScript port of the popular Phaser game engine v2.6.2.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vpmedia/phaser",
-  "version": "1.21.0",
+  "version": "1.22.0",
   "description": "@vpmedia/phaser is the modern ECMAScript port of the popular Phaser game engine v2.6.2",
   "author": "Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)",
   "license": "MIT",

package/src/phaser/core/animation.js

@@ -3,10 +3,10 @@ import { Signal } from './signal';
 export class Animation {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {Image} parent - TBD.
    * @param {string} name - TBD.
-   * @param {FrameData} frameData - TBD.
+   * @param {import('./frame_data').FrameData} frameData - TBD.
    * @param {string[]|number[]} frames - TBD.
    * @param {number} frameRate - TBD.
    * @param {boolean} loop - TBD.
@@ -308,7 +308,7 @@ export class Animation {
 
   /**
    * TBD.
-   * @param {FrameData} frameData - TBD.
+   * @param {import('./frame_data').FrameData} frameData - TBD.
    */
   updateFrameData(frameData) {
     this._frameData = frameData;

package/src/phaser/core/animation_manager.js

@@ -36,7 +36,7 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param {FrameData} frameData - TBD.
+   * @param {import('./frame_data').FrameData} frameData - TBD.
    * @param {number|string} frame - TBD.
    * @returns {boolean} TBD.
    */
@@ -66,7 +66,7 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param {FrameData} frameData - TBD.
+   * @param {import('./frame_data').FrameData} frameData - TBD.
    * @param {number|string} frame - TBD.
    * @returns {boolean} TBD.
    */
@@ -246,7 +246,7 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @returns {FrameData} TBD.
+   * @returns {import('./frame_data').FrameData} TBD.
    */
   get frameData() {
     return this._frameData;

package/src/phaser/core/animation_parser.js

@@ -3,7 +3,7 @@ import { FrameData } from './frame_data';
 
 /**
  * TBD.
- * @param {Game} game - TBD.
+ * @param {import('./game').Game} game - TBD.
  * @param {string} key - TBD.
  * @param {number} frameWidth - TBD.
  * @param {number} frameHeight - TBD.
@@ -58,7 +58,7 @@ export function spriteSheet(game, key, frameWidth, frameHeight, frameMax, margin
 
 /**
  * TBD.
- * @param {Game} game - TBD.
+ * @param {import('./game').Game} game - TBD.
  * @param {object} json - TBD.
  * @returns {object} TBD.
  */

package/src/phaser/core/cache.js

@@ -20,7 +20,7 @@ export const RENDER_TEXTURE = 9;
 export class Cache {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;
@@ -512,7 +512,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @returns {RenderTexture} TBD.
+   * @returns {import('../display/webgl/render_texture').RenderTexture} TBD.
    */
   getRenderTexture(key) {
     return this.getItem(key, RENDER_TEXTURE, 'getRenderTexture');

package/src/phaser/core/dom.js

@@ -182,7 +182,7 @@ class DocumentBoundsRectangle {
 export class DOM {
   /**
    * TBD.
-   * @param {Device} device - TBD.
+   * @param {import('./device').Device} device - TBD.
    */
   constructor(device) {
     this.treatAsDesktop =

package/src/phaser/core/event_manager.js

@@ -3,7 +3,7 @@ import { Signal } from './signal';
 export class EventManager {
   /**
    * TBD.
-   * @param {DisplayObject} sprite - TBD.
+   * @param {import('../display/display_object').DisplayObject} sprite - TBD.
    */
   constructor(sprite) {
     this.parent = sprite;

package/src/phaser/core/factory.js

@@ -8,7 +8,7 @@ import { Text } from '../display/text';
 export class GameObjectFactory {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/frame_data.js

@@ -6,7 +6,7 @@ export class FrameData {
    */
   constructor() {
     /**
-     * @type {Frame[]}
+     * @type {import('./frame').Frame[]}
      */
     this._frames = [];
     /**
@@ -17,8 +17,8 @@ export class FrameData {
 
   /**
    * TBD.
-   * @param {Frame} frame - TBD.
-   * @returns {Frame} TBD.
+   * @param {import('./frame').Frame} frame - TBD.
+   * @returns {import('./frame').Frame} TBD.
    */
   addFrame(frame) {
     frame.index = this._frames.length;
@@ -32,7 +32,7 @@ export class FrameData {
   /**
    * TBD.
    * @param {number} index - TBD.
-   * @returns {Frame} TBD.
+   * @returns {import('./frame').Frame} TBD.
    */
   getFrame(index = 0) {
     if (index >= this._frames.length) {
@@ -44,7 +44,7 @@ export class FrameData {
   /**
    * TBD.
    * @param {string} name - TBD.
-   * @returns {Frame} TBD.
+   * @returns {import('./frame').Frame} TBD.
    */
   getFrameByName(name) {
     if (typeof this._frameNames[name] === 'number') {
@@ -77,8 +77,8 @@ export class FrameData {
    * TBD.
    * @param {number} start - TBD.
    * @param {number} end - TBD.
-   * @param {Frame[]} output - TBD.
-   * @returns {Frame[]} TBD.
+   * @param {import('./frame').Frame[]} output - TBD.
+   * @returns {import('./frame').Frame[]} TBD.
    */
   getFrameRange(start, end, output = null) {
     const result = output || [];

package/src/phaser/core/input.js

@@ -16,7 +16,7 @@ const MAX_POINTERS = 10;
 export class Input {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;
@@ -360,7 +360,7 @@ export class Input {
 
   /**
    * TBD.
-   * @param {DisplayObject} displayObject - TBD.
+   * @param {import('../display/display_object').DisplayObject} displayObject - TBD.
    * @param {Pointer} pointer - TBD.
    * @param {Point} output - TBD.
    * @returns {Point} TBD.
@@ -377,7 +377,7 @@ export class Input {
 
   /**
    * TBD.
-   * @param {DisplayObject} displayObject - TBD.
+   * @param {import('../display/display_object').DisplayObject} displayObject - TBD.
    * @param {Pointer} pointer - TBD.
    * @param {Point} localPoint - TBD.
    * @returns {boolean} TBD.

package/src/phaser/core/input_handler.js

@@ -72,7 +72,7 @@ export class InputHandler {
    * TBD.
    * @param {number} priority - TBD.
    * @param {boolean} useHandCursor - TBD.
-   * @returns {DisplayObject} TBD.
+   * @returns {import('../display/display_object').DisplayObject} TBD.
    */
   start(priority = 0, useHandCursor = false) {
     //  Turning on
@@ -343,7 +343,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @param {boolean} fastTest - TBD.
    * @returns {boolean} TBD.
    */
@@ -372,7 +372,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @param {boolean} fastTest - TBD.
    * @returns {boolean} TBD.
    */
@@ -402,7 +402,7 @@ export class InputHandler {
    * TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @returns {boolean} TBD.
    */
   checkPixel(x, y, pointer) {
@@ -451,7 +451,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @returns {boolean} TBD.
    */
   update(pointer) {
@@ -488,7 +488,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @param {boolean} silent - TBD.
    */
   _pointerOverHandler(pointer, silent) {
@@ -519,7 +519,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @param {boolean} silent - TBD.
    */
   _pointerOutHandler(pointer, silent = false) {
@@ -545,7 +545,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    */
   _touchedHandler(pointer) {
     if (this.sprite === null) {
@@ -597,7 +597,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    */
   dragTimeElapsed(pointer) {
     this._dragTimePass = true;
@@ -610,7 +610,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    */
   _releasedHandler(pointer) {
     if (this.sprite === null) {
@@ -658,7 +658,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @param {boolean} fromStart - TBD.
    * @returns {boolean} TBD.
    */
@@ -766,8 +766,8 @@ export class InputHandler {
    * @param {boolean} bringToTop - TBD.
    * @param {boolean} pixelPerfect - TBD.
    * @param {number} alphaThreshold - TBD.
-   * @param {Rectangle} boundsRect - TBD.
-   * @param {DisplayObject} boundsSprite - TBD.
+   * @param {import('../geom/rectangle').Rectangle} boundsRect - TBD.
+   * @param {import('../display/display_object').DisplayObject} boundsSprite - TBD.
    */
   enableDrag(
     lockCenter = false,
@@ -809,7 +809,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    */
   startDrag(pointer) {
     const x = this.sprite.x;
@@ -866,7 +866,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    */
   stopDrag(pointer) {
     this.isDragged = false;

package/src/phaser/core/input_mouse.js

@@ -72,7 +72,7 @@ class WheelEventProxy {
 export class Mouse {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/input_mspointer.js

@@ -1,7 +1,7 @@
 export class MSPointer {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/input_pointer.js

@@ -12,7 +12,7 @@ import {
 export class Pointer {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {number} id - TBD.
    * @param {number} pointerMode - TBD.
    */
@@ -301,7 +301,7 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param {InputHandler} newTarget - TBD.
+   * @param {import('./input_handler').InputHandler} newTarget - TBD.
    * @param {boolean} silent - TBD.
    */
   swapTarget(newTarget, silent = false) {

package/src/phaser/core/input_touch.js

@@ -1,7 +1,7 @@
 export class Touch {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/loader.js

@@ -7,7 +7,7 @@ const TEXTURE_ATLAS_JSON_HASH = 1;
 export class Loader {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/raf.js

@@ -1,7 +1,7 @@
 export class RequestAnimationFrame {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/scale_manager.js

@@ -7,7 +7,7 @@ import { SCALE_OFF, SCALE_RESIZE, SCALE_EXACT_FIT, SCALE_USER, SCALE_SHOW_ALL, R
 export class ScaleManager {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {number} width - TBD.
    * @param {number} height - TBD.
    */

package/src/phaser/core/scene_manager.js

@@ -3,7 +3,7 @@ import { Scene } from './scene';
 export class SceneManager {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {string} pendingState - TBD.
    */
   constructor(game, pendingState) {

package/src/phaser/core/signal_binding.js

@@ -1,7 +1,7 @@
 export class SignalBinding {
   /**
    * TBD.
-   * @param {Signal} signal - TBD.
+   * @param {import('./signal').Signal} signal - TBD.
    * @param {Function} listener - TBD.
    * @param {boolean} isOnce - TBD.
    * @param {object} listenerContext - TBD.
@@ -76,7 +76,7 @@ export class SignalBinding {
 
   /**
    * TBD.
-   * @returns {Signal} TBD.
+   * @returns {import('./signal').Signal} TBD.
    */
   getSignal() {
     return this._signal;

package/src/phaser/core/sound.js

@@ -3,7 +3,7 @@ import { Signal } from './signal';
 export class Sound {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {string} key - TBD.
    * @param {number} volume - TBD.
    * @param {boolean} loop - TBD.

package/src/phaser/core/sound_manager.js

@@ -6,7 +6,7 @@ import { SoundSprite } from './sound_sprite';
 export class SoundManager {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/sound_sprite.js

@@ -1,7 +1,7 @@
 export class SoundSprite {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {string} key - TBD.
    */
   constructor(game, key) {
@@ -28,7 +28,7 @@ export class SoundSprite {
    * TBD.
    * @param {string} marker - TBD.
    * @param {number} volume - TBD.
-   * @returns {Sound} TBD.
+   * @returns {import('./sound').Sound} TBD.
    */
   play(marker, volume = 1) {
     return this.sounds[marker].play(marker, null, volume);
@@ -51,7 +51,7 @@ export class SoundSprite {
   /**
    * TBD.
    * @param {string} marker - TBD.
-   * @returns {Sound} TBD.
+   * @returns {import('./sound').Sound} TBD.
    */
   get(marker) {
     return this.sounds[marker];

package/src/phaser/core/stage.js

@@ -7,7 +7,7 @@ import { SCALE_LINEAR, SCALE_NEAREST } from './const';
 export class Stage extends DisplayObject {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     super();

package/src/phaser/core/time.js

@@ -3,7 +3,7 @@ import { Timer } from './timer';
 export class Time {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/timer.js

@@ -4,7 +4,7 @@ import { TimerEvent } from './timer_event';
 export class Timer {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {boolean} autoDestroy - TBD.
    */
   constructor(game, autoDestroy = false) {

package/src/phaser/core/timer_event.js

@@ -1,7 +1,7 @@
 export class TimerEvent {
   /**
    * TBD.
-   * @param {Timer} timer - TBD.
+   * @param {import('./timer').Timer} timer - TBD.
    * @param {number} delay - TBD.
    * @param {number} tick - TBD.
    * @param {number} repeatCount - TBD.

package/src/phaser/core/tween.js

@@ -6,9 +6,9 @@ import { TWEEN_PENDING, TWEEN_RUNNING, TWEEN_COMPLETE, TWEEN_LOOPED } from './co
 export class Tween {
   /**
    * TBD.
-   * @param {DisplayObject} target - TBD.
-   * @param {Game} game - TBD.
-   * @param {TweenManager} manager - TBD.
+   * @param {import('../display/display_object').DisplayObject} target - TBD.
+   * @param {import('./game').Game} game - TBD.
+   * @param {import('./tween_manager').TweenManager} manager - TBD.
    */
   constructor(target, game, manager) {
     this.game = game;

package/src/phaser/core/tween_data.js

@@ -4,7 +4,7 @@ import { TWEEN_PENDING, TWEEN_RUNNING, TWEEN_COMPLETE, TWEEN_LOOPED } from './co
 export class TweenData {
   /**
    * TBD.
-   * @param {Tween} parent - TBD.
+   * @param {import('./tween').Tween} parent - TBD.
    */
   constructor(parent) {
     this.parent = parent;

package/src/phaser/core/tween_manager.js

@@ -37,7 +37,7 @@ import { GROUP } from './const';
 export class TweenManager {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/world.js

@@ -3,7 +3,7 @@ import { Group } from '../display/group';
 export class World extends Group {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     super(game, null, '__world', false);

package/src/phaser/display/bitmap_text.js

@@ -6,7 +6,7 @@ import { BITMAP_TEXT, SCALE_LINEAR, SCALE_NEAREST } from '../core/const';
 export class BitmapText extends DisplayObject {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('../core/game').Game} game - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {string} font - TBD.

package/src/phaser/display/button.js

@@ -12,7 +12,7 @@ const STATE_DISABLED = 'Disabled';
 export class Button extends Image {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('../core/game').Game} game - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {string} key - TBD.

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

@@ -27,7 +27,7 @@ import * as CanvasMaskManager from './masker';
 export class CanvasRenderer {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('../../core/game').Game} game - TBD.
    */
   constructor(game) {
     detectCapabilities();
@@ -59,7 +59,7 @@ export class CanvasRenderer {
 
   /**
    * TBD.
-   * @param {Stage} root - TBD.
+   * @param {import('../../core/stage').Stage} root - TBD.
    */
   render(root) {
     if (!this.context) {
@@ -118,7 +118,7 @@ export class CanvasRenderer {
    * TBD.
    * @param {Image} displayObject - TBD.
    * @param {CanvasRenderingContext2D} context - TBD.
-   * @param {Matrix} matrix - TBD.
+   * @param {import('../../geom/matrix').Matrix} matrix - TBD.
    */
   renderDisplayObject(displayObject, context, matrix) {
     this.renderSession.context = context || this.context;

package/src/phaser/display/display_object.js

@@ -671,7 +671,7 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @returns {Graphics} TBD.
+   * @returns {import('./graphics').Graphics} TBD.
    */
   get mask() {
     return this._mask;

package/src/phaser/display/graphics.js

@@ -27,7 +27,7 @@ import {
 export class Graphics extends DisplayObject {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('../core/game').Game} game - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    */
@@ -553,7 +553,7 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param {Matrix} matrix - TBD.
+   * @param {import('../geom/matrix').Matrix} matrix - TBD.
    * @returns {Rectangle} TBD.
    */
   getBounds(matrix = null) {
@@ -789,7 +789,7 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param shape - TBD.
+   * @param {object} shape - TBD.
    * @returns {GraphicsData} TBD.
    */
   drawShape(shape) {