@vpmedia/phaser 1.14.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.14.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.14.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_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/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/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/input_mouse.js

@@ -3,14 +3,14 @@
  * @author       Andras Csizmadia <andras@vpmedia.hu>
  * @author       Richard Davey <rich@photonstorm.com>
  */
-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) {

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/tween_easing.js

@@ -6,7 +6,6 @@
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -16,7 +15,6 @@ export function LinearNone(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -26,7 +24,6 @@ export function QuadraticIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -36,7 +33,6 @@ export function QuadraticOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -47,7 +43,6 @@ export function QuadraticInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -57,7 +52,6 @@ export function CubicIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -67,7 +61,6 @@ export function CubicOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -78,7 +71,6 @@ export function CubicInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -88,7 +80,6 @@ export function QuarticIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -98,7 +89,6 @@ export function QuarticOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -109,7 +99,6 @@ export function QuarticInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -119,7 +108,6 @@ export function QuinticIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -129,7 +117,6 @@ export function QuinticOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -140,7 +127,6 @@ export function QuinticInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -152,7 +138,6 @@ export function SinusoidalIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -164,7 +149,6 @@ export function SinusoidalOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -176,7 +160,6 @@ export function SinusoidalInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -186,7 +169,6 @@ export function ExponentialIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -196,7 +178,6 @@ export function ExponentialOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -209,7 +190,6 @@ export function ExponentialInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -219,7 +199,6 @@ export function CircularIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -229,7 +208,6 @@ export function CircularOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -240,7 +218,6 @@ export function CircularInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -261,7 +238,6 @@ export function ElasticIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -282,7 +258,6 @@ export function ElasticOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -305,7 +280,6 @@ export function ElasticInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -316,7 +290,6 @@ export function BackIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -327,7 +300,6 @@ export function BackOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -339,7 +311,6 @@ export function BackInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -356,7 +327,6 @@ export function BounceOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -366,7 +336,6 @@ 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,6 +6,7 @@
  */
 import { Image } from './image';
 import { Signal } from  '../core/signal';
+import { Game } from  '../core/game';
 import { InputHandler } from '../core/input_handler';
 import { BUTTON, POINTER_CONTACT } from '../core/const';
 
@@ -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/graphics.js

@@ -14,7 +14,6 @@ import {
 
 /**
  * TBD.
- *
  * @param {object} graphics - TBD.
  */
 export function updateGraphicsTint(graphics) {
@@ -41,7 +40,6 @@ export function updateGraphicsTint(graphics) {
 
 /**
  * TBD.
- *
  * @param {object} graphics - TBD.
  * @param {object} context - TBD.
  */
@@ -171,7 +169,6 @@ export function renderGraphics(graphics, context) {
 
 /**
  * TBD.
- *
  * @param {object} graphics - TBD.
  * @param {object} context - TBD.
  */

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

@@ -8,7 +8,6 @@ import { renderGraphicsMask } from './graphics';
 
 /**
  * TBD.
- *
  * @param {object} maskData - TBD.
  * @param {object} renderSession - TBD.
  */
@@ -33,7 +32,6 @@ export function pushMask(maskData, renderSession) {
 
 /**
  * TBD.
- *
  * @param {object} renderSession - TBD.
  */
 export function popMask(renderSession) {

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

@@ -7,7 +7,6 @@
 
 /**
  * TBD.
- *
  * @returns {object[]} TBD.
  */
 export function getPool() {
@@ -22,7 +21,6 @@ export function getPool() {
 
 /**
  * TBD.
- *
  * @returns {object} TBD.
  */
 export function getFirst() {
@@ -37,7 +35,6 @@ export function getFirst() {
 
 /**
  * TBD.
- *
  * @param {object} parent - TBD.
  */
 export function remove(parent) {
@@ -53,7 +50,6 @@ export function remove(parent) {
 
 /**
  * TBD.
- *
  * @param {HTMLCanvasElement} canvas - TBD.
  */
 export function removeByCanvas(canvas) {
@@ -69,7 +65,6 @@ export function removeByCanvas(canvas) {
 
 /**
  * TBD.
- *
  * @returns {number} TBD.
  */
 export function getTotal() {
@@ -85,7 +80,6 @@ export function getTotal() {
 
 /**
  * TBD.
- *
  * @returns {number} TBD.
  */
 export function getFree() {
@@ -101,7 +95,6 @@ export function getFree() {
 
 /**
  * TBD.
- *
  * @param {object} parent - TBD.
  * @param {number} width - TBD.
  * @param {number} height - TBD.

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

@@ -10,7 +10,6 @@ import { hex2rgb } from '../../util/math';
 
 /**
  * TBD.
- *
  * @param {object} sprite - TBD.
  * @param {object} color - TBD.
  * @returns {object} TBD.
@@ -23,7 +22,6 @@ export function getTintedTexture(sprite, color) {
 
 /**
  * TBD.
- *
  * @param {object} texture - TBD.
  * @param {object} color - TBD.
  * @param {HTMLCanvasElement} canvas - TBD.
@@ -66,7 +64,6 @@ export function tintWithMultiply(texture, color, canvas) {
 
 /**
  * TBD.
- *
  * @param {object} texture - TBD.
  * @param {object} color - TBD.
  * @param {HTMLCanvasElement} canvas - TBD.
@@ -111,7 +108,6 @@ export function tintWithPerPixel(texture, color, canvas) {
 
 /**
  * TBD.
- *
  * @returns {boolean} TBD.
  */
 export function checkInverseAlpha() {
@@ -139,7 +135,6 @@ export function checkInverseAlpha() {
 
 /**
  * TBD.
- *
  * @returns {boolean} TBD.
  */
 export function canUseNewCanvasBlendModes() {

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

@@ -8,7 +8,6 @@ import { create as createCanvas } from './pool';
 
 /**
  * TBD.
- *
  * @param {object} parent - TBD.
  * @param {number} width - TBD.
  * @param {number} height - TBD.
@@ -31,7 +30,6 @@ export function create(parent, width, height, id, skipPool) {
 
 /**
  * TBD.
- *
  * @param {HTMLCanvasElement} canvas - TBD.
  * @param {string} color - TBD.
  * @returns {object} TBD.
@@ -44,7 +42,6 @@ export function setBackgroundColor(canvas, color) {
 
 /**
  * TBD.
- *
  * @param {HTMLCanvasElement} canvas - TBD.
  * @param {string} value - TBD.
  * @returns {object} TBD.
@@ -59,7 +56,6 @@ export function setTouchAction(canvas, value) {
 
 /**
  * TBD.
- *
  * @param {HTMLCanvasElement} canvas - TBD.
  * @param {string} value - TBD.
  * @returns {object} TBD.
@@ -78,7 +74,6 @@ export function setUserSelect(canvas, value) {
 
 /**
  * TBD.
- *
  * @param {HTMLCanvasElement} canvas - TBD.
  * @param {object} parent - TBD.
  * @param {boolean} overflowHidden - TBD.
@@ -108,7 +103,6 @@ export function addToDOM(canvas, parent, overflowHidden = true) {
 
 /**
  * TBD.
- *
  * @param {HTMLCanvasElement} canvas - TBD.
  */
 export function removeFromDOM(canvas) {
@@ -119,7 +113,6 @@ export function removeFromDOM(canvas) {
 
 /**
  * TBD.
- *
  * @param {object} context - TBD.
  * @param {number} translateX - TBD.
  * @param {number} translateY - TBD.
@@ -136,7 +129,6 @@ export function setTransform(context, translateX, translateY, scaleX, scaleY, sk
 
 /**
  * TBD.
- *
  * @param {object} context - TBD.
  * @returns {object} TBD.
  */
@@ -153,7 +145,6 @@ export function getSmoothingPrefix(context) {
 
 /**
  * TBD.
- *
  * @param {object} context - TBD.
  * @param {number} value - TBD.
  * @returns {object} TBD.

package/src/phaser/display/graphics.js

@@ -6,6 +6,7 @@
  */
 import { DisplayObject } from  './display_object';
 import { Image } from './image';
+import { Game } from  '../core/game';
 import { Rectangle } from  '../geom/rectangle';
 import { RoundedRectangle } from  '../geom/rounded_rectangle';
 import { Polygon } from  '../geom/polygon';
@@ -36,8 +37,7 @@ import {
 export class Graphics extends DisplayObject {
   /**
    * TBD.
-   *
-   * @param {object} game - TBD.
+   * @param {Game} game - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    */

package/src/phaser/display/graphics_data_util.js

@@ -8,7 +8,6 @@ import { GraphicsData } from  './graphics_data';
 
 /**
  * TBD.
- *
  * @param {object} source - TBD.
  * @returns {object} TBD.
  */

package/src/phaser/display/group.js

@@ -7,6 +7,7 @@
 import { DisplayObject } from  './display_object';
 import { Image } from './image';
 import { Signal } from  '../core/signal';
+import { Game } from  '../core/game';
 import { GROUP } from '../core/const';
 
 export const SORT_ASCENDING = -1;
@@ -15,8 +16,7 @@ export const SORT_DESCENDING = 1;
 export class Group extends DisplayObject {
   /**
    * TBD.
-   *
-   * @param {object} game - TBD.
+   * @param {Game} game - TBD.
    * @param {DisplayObject} parent - TBD.
    * @param {string} name - TBD.
    * @param {boolean} addToStage - TBD.