@vpmedia/phaser 1.13.0 → 1.15.0

package/README.md

@@ -1,7 +1,7 @@
 @vpmedia/phaser
 ===============
 
-[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.13.0)](https://badge.fury.io/js/@vpmedia%2Fphaser)
+[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.15.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.13.0",
+  "version": "1.15.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",
@@ -26,7 +26,7 @@
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-jsdoc": "^41.1.2",
+    "eslint-plugin-jsdoc": "^43.0.0",
     "eslint-plugin-prettier": "^4.2.1",
     "husky": "^8.0.3",
     "jest": "^29.5.0",

package/src/phaser/core/animation_manager.js

@@ -5,7 +5,7 @@
  */
 import { Animation } from './animation';
 
-export default class {
+export class AnimationManager {
   constructor(sprite) {
     this.sprite = sprite;
     this.game = sprite.game;

package/src/phaser/core/animation_parser.js

@@ -8,7 +8,6 @@ import { FrameData } from './frame_data';
 
 /**
  * TBD.
- *
  * @param {object} game - TBD.
  * @param {object} key - TBD.
  * @param {number} frameWidth - TBD.
@@ -66,7 +65,6 @@ export function spriteSheet(game, key, frameWidth, frameHeight, frameMax, margin
 
 /**
  * TBD.
- *
  * @param {object} game - TBD.
  * @param {object} json - TBD.
  * @returns {object} TBD.

package/src/phaser/core/cache.js

@@ -22,7 +22,7 @@ export const JSON = 7;
 export const XML = 8;
 export const RENDER_TEXTURE = 9;
 
-export default class {
+export class Cache {
   constructor(game) {
     this.game = game;
     this.autoResolveURL = false;

package/src/phaser/core/device.js

@@ -30,6 +30,8 @@ export class Device {
     this.m4a = false;
     this.webm = false;
     this.dolby = false;
+    this.avif = false;
+    this.webp = false;
     this.fullscreen = false;
     this.requestFullscreen = '';
     this.cancelFullscreen = '';

package/src/phaser/core/device_util.js

@@ -7,7 +7,6 @@ import { Device } from "./device";
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  * @param {string} type - TBD.
  * @returns {boolean} TBD.
@@ -33,7 +32,6 @@ export function canPlayAudio(device, type) {
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function checkOS(device) {
@@ -77,7 +75,6 @@ export function checkOS(device) {
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function checkInput(device) {
@@ -98,7 +95,6 @@ export function checkInput(device) {
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function checkFullScreenSupport(device) {
@@ -145,7 +141,6 @@ export function checkFullScreenSupport(device) {
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function checkBrowser(device) {
@@ -167,7 +162,6 @@ export function checkBrowser(device) {
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function checkAudio(device) {
@@ -214,7 +208,6 @@ export function checkAudio(device) {
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function checkImage(device) {
@@ -239,7 +232,6 @@ export function checkImage(device) {
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function initialize(device) {
@@ -253,7 +245,6 @@ export function initialize(device) {
 
 /**
  * TBD.
- *
  * @returns {Device} TBD.
  */
 export function createDevice() {

package/src/phaser/core/dom.js

@@ -112,7 +112,7 @@ class DocumentBoundsRectangle {
   }
 }
 
-export default class {
+export class DOM {
   constructor(device) {
     this.treatAsDesktop =
       device.desktop &&

package/src/phaser/core/event_manager.js

@@ -5,7 +5,7 @@
  */
 import { Signal } from  './signal';
 
-export default class {
+export class EventManager {
   constructor(sprite) {
     this.parent = sprite;
     this._onAddedToGroup = null;

package/src/phaser/core/frame_util.js

@@ -8,7 +8,6 @@ import { FrameData } from './frame_data';
 
 /**
  * TBD.
- *
  * @param {object} frame - TBD.
  * @param {object} output - TBD.
  * @returns {object} TBD.
@@ -21,7 +20,6 @@ export function cloneFrame(frame, output = null) {
 
 /**
  * TBD.
- *
  * @param {object} frameData - TBD.
  * @param {object} output - TBD.
  * @returns {object} TBD.

package/src/phaser/core/game.js

@@ -4,12 +4,12 @@
  * @author       Andras Csizmadia <andras@vpmedia.hu>
  * @author       Richard Davey <rich@photonstorm.com>
  */
-import CanvasRenderer from '../display/canvas/renderer';
-import WebGLRenderer from '../display/webgl/renderer';
+import { CanvasRenderer } from '../display/canvas/renderer';
+import { WebGLRenderer } from '../display/webgl/renderer';
 import { Signal } from  './signal';
-import Loader from './loader';
-import Cache from './cache';
-import Input from './input';
+import { Loader } from './loader';
+import { Cache } from './cache';
+import { Input } from './input';
 import { Device } from './device';
 import { GameObjectFactory } from './factory';
 import { RequestAnimationFrame } from './raf';

package/src/phaser/core/input.js

@@ -9,16 +9,16 @@ import { Image } from '../display/image';
 import { Signal } from  './signal';
 import { Point } from '../geom/point';
 import { Circle } from  '../geom/circle';
-import Mouse from './input_mouse';
-import MSPointer from './input_mspointer';
-import Pointer from './input_pointer';
-import Touch from './input_touch';
+import { Mouse } from './input_mouse';
+import { MSPointer } from './input_mspointer';
+import { Pointer } from './input_pointer';
+import { Touch } from './input_touch';
 import { POINTER_CURSOR, POINTER_CONTACT, MOUSE_TOUCH_COMBINE } from './const';
 import { create, remove } from '../display/canvas/pool';
 
 const MAX_POINTERS = 10;
 
-export default class {
+export class Input {
   constructor(game) {
     this.game = game;
     this.hitCanvas = null;

package/src/phaser/core/input_handler.js

@@ -7,7 +7,7 @@ import { Point } from '../geom/point';
 import { GROUP } from './const';
 import { distance } from '../util/math';
 
-export default class {
+export class InputHandler {
   constructor(sprite) {
     this.sprite = sprite;
     this.game = sprite.game;

package/src/phaser/core/input_mouse.js

@@ -3,16 +3,14 @@
  * @author       Andras Csizmadia <andras@vpmedia.hu>
  * @author       Richard Davey <rich@photonstorm.com>
  */
-import { Signal } from  './signal';
-
-const NO_BUTTON = -1;
+/* const NO_BUTTON = -1;
 const LEFT_BUTTON = 0;
 const MIDDLE_BUTTON = 1;
 const RIGHT_BUTTON = 2;
 const BACK_BUTTON = 3;
 const FORWARD_BUTTON = 4;
 const WHEEL_UP = 1;
-const WHEEL_DOWN = -1;
+const WHEEL_DOWN = -1; */
 
 class WheelEventProxy {
   constructor(scaleFactor, deltaMode) {
@@ -54,7 +52,7 @@ class WheelEventProxy {
   }
 }
 
-export default class {
+export class Mouse {
   constructor(game) {
     this.game = game;
     this.input = game.input;

package/src/phaser/core/input_mspointer.js

@@ -4,7 +4,7 @@
  * @author       Richard Davey <rich@photonstorm.com>
  */
 
-export default class {
+export class MSPointer {
   constructor(game) {
     this.game = game;
     this.input = game.input;

package/src/phaser/core/input_pointer.js

@@ -14,7 +14,7 @@ import {
   MOUSE_TOUCH_COMBINE,
 } from './const';
 
-export default class {
+export class Pointer {
   constructor(game, id, pointerMode) {
     this.game = game;
     this.id = id;

package/src/phaser/core/input_touch.js

@@ -4,7 +4,7 @@
  * @author       Richard Davey <rich@photonstorm.com>
  */
 
-export default class {
+export class Touch {
   constructor(game) {
     this.game = game;
     this.enabled = true;

package/src/phaser/core/loader.js

@@ -9,7 +9,7 @@ import { canPlayAudio } from './device_util';
 
 const TEXTURE_ATLAS_JSON_HASH = 1;
 
-export default class {
+export class Loader {
   constructor(game) {
     this.game = game;
     this.cache = game.cache;

package/src/phaser/core/loader_parser.js

@@ -8,7 +8,6 @@ import { Rectangle } from  '../geom/rectangle';
 
 /**
  * TBD.
- *
  * @param {object} baseTexture - TBD.
  * @param {object} bitmapFontData - TBD.
  * @returns {object} TBD.
@@ -26,7 +25,6 @@ export function finalizeBitmapFont(baseTexture, bitmapFontData) {
 
 /**
  * TBD.
- *
  * @param {object} xml - TBD.
  * @param {object} baseTexture - TBD.
  * @param {number} xSpacing - TBD.
@@ -67,7 +65,6 @@ export function xmlBitmapFont(xml, baseTexture, xSpacing, ySpacing) {
 
 /**
  * TBD.
- *
  * @param {object} xml - TBD.
  * @param {object} baseTexture - TBD.
  * @param {number} xSpacing - TBD.
@@ -80,7 +77,6 @@ export function bitmapFont(xml, baseTexture, xSpacing, ySpacing) {
 
 /**
  * TBD.
- *
  * @param {object} json - TBD.
  * @param {object} baseTexture - TBD.
  * @param {number} xSpacing - TBD.

package/src/phaser/core/scale_manager.js

@@ -4,7 +4,7 @@
  * @author       Richard Davey <rich@photonstorm.com>
  */
 import { Signal } from  './signal';
-import DOM from './dom';
+import { DOM } from './dom';
 import { Point } from '../geom/point';
 import { Rectangle } from  '../geom/rectangle';
 import {

package/src/phaser/core/timer.js

@@ -4,7 +4,7 @@
  * @author       Richard Davey <rich@photonstorm.com>
  */
 import { Signal } from  './signal';
-import TimerEvent from './timer_event';
+import { TimerEvent } from './timer_event';
 
 export class Timer {
   constructor(game, autoDestroy = false) {

package/src/phaser/core/timer_event.js

@@ -4,7 +4,7 @@
  * @author       Richard Davey <rich@photonstorm.com>
  */
 
-export default class {
+export class TimerEvent {
   constructor(timer, delay, tick, repeatCount, loop, callback, callbackContext, args) {
     this.timer = timer;
     this.delay = delay;

package/src/phaser/core/tween_easing.js

@@ -5,7 +5,7 @@
  */
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -14,7 +14,7 @@ export function LinearNone(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -23,7 +23,7 @@ export function QuadraticIn(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -32,7 +32,7 @@ export function QuadraticOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -42,7 +42,7 @@ export function QuadraticInOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -51,7 +51,7 @@ export function CubicIn(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -60,7 +60,7 @@ export function CubicOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -70,7 +70,7 @@ export function CubicInOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -79,7 +79,7 @@ export function QuarticIn(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -88,7 +88,7 @@ export function QuarticOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -98,7 +98,7 @@ export function QuarticInOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -107,7 +107,7 @@ export function QuinticIn(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -116,7 +116,7 @@ export function QuinticOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -126,7 +126,7 @@ export function QuinticInOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -137,7 +137,7 @@ export function SinusoidalIn(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -148,7 +148,7 @@ export function SinusoidalOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -159,7 +159,7 @@ export function SinusoidalInOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -168,7 +168,7 @@ export function ExponentialIn(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -177,7 +177,7 @@ export function ExponentialOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -189,7 +189,7 @@ export function ExponentialInOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -198,7 +198,7 @@ export function CircularIn(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -207,7 +207,7 @@ export function CircularOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -217,7 +217,7 @@ export function CircularInOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -237,7 +237,7 @@ export function ElasticIn(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -257,7 +257,7 @@ export function ElasticOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -279,7 +279,7 @@ export function ElasticInOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -289,7 +289,7 @@ export function BackIn(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -299,7 +299,7 @@ export function BackOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -310,7 +310,7 @@ export function BackInOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -326,7 +326,7 @@ export function BounceOut(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -335,7 +335,7 @@ export function BounceIn(k) {
 }
 
 /**
- *
+ * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */

package/src/phaser/display/bitmap_text.js

@@ -6,14 +6,14 @@
  */
 import { DisplayObject } from  './display_object';
 import { Image } from './image';
+import { Game } from  '../core/game';
 import { Point } from '../geom/point';
 import { BITMAP_TEXT, SCALE_LINEAR, SCALE_NEAREST } from '../core/const';
 
 export class BitmapText extends DisplayObject {
   /**
    * TBD.
-   *
-   * @param {object} game - TBD.
+   * @param {Game} game - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {string} font - TBD.

package/src/phaser/display/button.js

@@ -6,7 +6,8 @@
  */
 import { Image } from './image';
 import { Signal } from  '../core/signal';
-import InputHandler from '../core/input_handler';
+import { Game } from  '../core/game';
+import { InputHandler } from '../core/input_handler';
 import { BUTTON, POINTER_CONTACT } from '../core/const';
 
 const STATE_OVER = 'Over';
@@ -18,8 +19,7 @@ const STATE_DISABLED = 'Disabled';
 export class Button extends Image {
   /**
    * TBD.
-   *
-   * @param {object} game - TBD.
+   * @param {Game} game - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {string} key - TBD.

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

@@ -6,7 +6,7 @@
  */
 import { create, removeByCanvas } from './pool';
 
-export default class {
+export class CanvasBuffer {
   constructor(width, height) {
     this.width = width;
     this.height = height;