@vpmedia/phaser 1.16.0 → 1.18.0

package/src/phaser/core/cache.js

@@ -83,8 +83,9 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   * @returns {object} TBD.
    */
   addImage(key, url, data) {
     if (this.checkImageKey(key)) {
@@ -110,9 +111,9 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
-   * @param atlasData
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   * @param {object} atlasData - TBD.
    */
   addTextureAtlas(key, url, data, atlasData) {
     const obj = {
@@ -129,8 +130,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
+   * @param {string} url - TBD.
+   * @param data - TBD.
    */
   addSound(key, url, data) {
     this._cache.sound[key] = {
@@ -146,8 +147,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
+   * @param {string} url - TBD.
+   * @param data - TBD.
    */
   addText(key, url, data) {
     this._cache.text[key] = { url, data };
@@ -157,12 +158,12 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
-   * @param atlasData
-   * @param atlasType
-   * @param xSpacing
-   * @param ySpacing
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   * @param atlasData - TBD.
+   * @param atlasType - TBD.
+   * @param xSpacing - TBD.
+   * @param ySpacing - TBD.
    */
   addBitmapFont(key, url, data, atlasData, atlasType, xSpacing = 0, ySpacing = 0) {
     const obj = {
@@ -183,8 +184,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
+   * @param {string} url - TBD.
+   * @param data - TBD.
    */
   addJSON(key, url, data) {
     this._cache.json[key] = { url, data };
@@ -194,8 +195,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
+   * @param {string} url - TBD.
+   * @param data - TBD.
    */
   addXML(key, url, data) {
     this._cache.xml[key] = { url, data };
@@ -233,8 +234,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param property
-   * @param value
+   * @param {string} property - TBD.
+   * @param value - TBD.
    */
   updateSound(key, property, value) {
     const sound = this.getSound(key);
@@ -246,7 +247,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param data
+   * @param data - TBD.
    */
   decodedSound(key, data) {
     const sound = this.getSound(key);
@@ -258,6 +259,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   isSoundDecoded(key) {
     const sound = this.getItem(key, SOUND, 'isSoundDecoded');
@@ -270,6 +272,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   isSoundReady(key) {
     const sound = this.getItem(key, SOUND, 'isSoundDecoded');
@@ -283,8 +286,9 @@ export class Cache {
 
   /**
    * TBD.
-   * @param cache
+   * @param {number} cache - TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkKey(cache, key) {
     if (this._cacheMap[cache][key]) {
@@ -295,7 +299,8 @@ export class Cache {
 
   /**
    * TBD.
-   * @param url
+   * @param {string} url - TBD.
+   * @returns {boolean} TBD.
    */
   checkURL(url) {
     if (this._urlMap[this._resolveURL(url)]) {
@@ -307,6 +312,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkCanvasKey(key) {
     return this.checkKey(CANVAS, key);
@@ -315,6 +321,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkImageKey(key) {
     return this.checkKey(IMAGE, key);
@@ -323,6 +330,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkTextureKey(key) {
     return this.checkKey(TEXTURE, key);
@@ -331,6 +339,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkSoundKey(key) {
     return this.checkKey(SOUND, key);
@@ -339,6 +348,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkTextKey(key) {
     return this.checkKey(TEXT, key);
@@ -347,6 +357,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkBitmapDataKey(key) {
     return this.checkKey(BITMAPDATA, key);
@@ -355,6 +366,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkBitmapFontKey(key) {
     return this.checkKey(BITMAPFONT, key);
@@ -363,6 +375,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkJSONKey(key) {
     return this.checkKey(JSON, key);
@@ -371,6 +384,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkXMLKey(key) {
     return this.checkKey(XML, key);
@@ -381,9 +395,10 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param cache
-   * @param method
-   * @param property
+   * @param {number} cache - TBD.
+   * @param {string} method - TBD.
+   * @param {string} property - TBD.
+   * @returns {*} TBD.
    */
   getItem(key, cache, method, property = null) {
     if (this.checkKey(cache, key)) {
@@ -406,7 +421,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param full
+   * @param full - TBD.
    */
   getImage(key = '__default', full = false) {
     let img = this.getItem(key, IMAGE, 'getImage');
@@ -470,7 +485,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param isClone
+   * @param {boolean} isClone - TBD.
    */
   getJSON(key, isClone = false) {
     const data = this.getItem(key, JSON, 'getJSON', 'data');
@@ -498,7 +513,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param cache
+   * @param {number} cache - TBD.
    */
   getBaseTexture(key, cache = IMAGE) {
     return this.getItem(key, cache, 'getBaseTexture', 'base');
@@ -507,7 +522,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param cache
+   * @param {number} cache - TBD.
    */
   getFrame(key, cache = IMAGE) {
     return this.getItem(key, cache, 'getFrame', 'frame');
@@ -516,7 +531,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param cache
+   * @param {number} cache - TBD.
    */
   getFrameCount(key, cache = IMAGE) {
     const data = this.getFrameData(key, cache);
@@ -529,7 +544,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param cache
+   * @param {number} cache - TBD.
    */
   getFrameData(key, cache = IMAGE) {
     return this.getItem(key, cache, 'getFrameData', 'frameData');
@@ -538,7 +553,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param cache
+   * @param {number} cache - TBD.
    */
   hasFrameData(key, cache = IMAGE) {
     return this.getItem(key, cache, '', 'frameData') !== null;
@@ -547,8 +562,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param frameData
-   * @param cache
+   * @param frameData - TBD.
+   * @param {number} cache - TBD.
    */
   updateFrameData(key, frameData, cache = IMAGE) {
     if (this._cacheMap[cache][key]) {
@@ -559,8 +574,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param index - TBD.
-   * @param cache
+   * @param {number} index - TBD.
+   * @param {number} cache - TBD.
    */
   getFrameByIndex(key, index, cache = IMAGE) {
     const data = this.getFrameData(key, cache);
@@ -573,8 +588,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param name
-   * @param cache
+   * @param {string} name - TBD.
+   * @param {number} cache - TBD.
    */
   getFrameByName(key, name, cache = IMAGE) {
     const data = this.getFrameData(key, cache);
@@ -586,7 +601,7 @@ export class Cache {
 
   /**
    * TBD.
-   * @param url
+   * @param {string} url - TBD.
    */
   getURL(url) {
     const resolvedURL = this._resolveURL(url);
@@ -599,7 +614,7 @@ export class Cache {
 
   /**
    * TBD.
-   * @param cache
+   * @param {object} cache - TBD.
    */
   getKeys(cache = IMAGE) {
     const result = [];
@@ -628,7 +643,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param destroyBaseTexture
+   * @param {boolean} destroyBaseTexture - TBD.
    */
   removeImage(key, destroyBaseTexture = true) {
     const img = this.getImage(key, true);
@@ -723,8 +738,9 @@ export class Cache {
 
   /**
    * TBD.
-   * @param url
-   * @param data
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   * @returns {string} TBD.
    */
   _resolveURL(url, data) {
     if (!this.autoResolveURL) {

package/src/phaser/core/const.js

@@ -169,25 +169,91 @@ export const TOUCH_OVERRIDES_MOUSE = 1;
  */
 export const MOUSE_TOUCH_COMBINE = 2;
 // game objects
+/**
+ * @type {number}
+ */
 export const GROUP = 7;
+/**
+ * @type {number}
+ */
 export const SPRITE = 0;
+/**
+ * @type {number}
+ */
 export const SPRITE_BATCH = 17;
+/**
+ * @type {number}
+ */
 export const BUTTON = 1;
+/**
+ * @type {number}
+ */
 export const IMAGE = 2;
+/**
+ * @type {number}
+ */
 export const GRAPHICS = 3;
+/**
+ * @type {number}
+ */
 export const TEXT = 4;
+/**
+ * @type {number}
+ */
 export const BITMAP_TEXT = 6;
+/**
+ * @type {number}
+ */
 export const TILE_SPRITE = 5;
+/**
+ * @type {number}
+ */
 export const RENDER_TEXTURE = 8;
+/**
+ * @type {number}
+ */
 export const FILTER_CANVAS = 14;
+/**
+ * @type {number}
+ */
 export const FILTER_WEBGL = 15;
+/**
+ * @type {number}
+ */
 export const POINTER = 19;
+/**
+ * @type {number}
+ */
 export const GEOM_POLYGON = 12;
+/**
+ * @type {number}
+ */
 export const GEOM_RECTANGLE = 22;
+/**
+ * @type {number}
+ */
 export const GEOM_CIRCLE = 21;
+/**
+ * @type {number}
+ */
 export const GEOM_ELLIPSE = 16;
+/**
+ * @type {number}
+ */
 export const GEOM_ROUNDED_RECTANGLE = 26;
+/**
+ * @type {number}
+ */
 export const GEOM_LINE = 23;
+/**
+ * @type {number}
+ */
 export const GEOM_MATRIX = 24;
+/**
+ * @type {number}
+ */
 export const GEOM_POINT = 25;
+/**
+ * @type {number}
+ */
 export const PENDING_ATLAS = -1;

package/src/phaser/core/device.js

@@ -3,35 +3,122 @@ export class Device {
    * TBD.
    */
   constructor() {
+    /**
+     * @type {boolean}
+     */
     this.desktop = false;
+    /**
+     * @type {boolean}
+     */
     this.iOS = false;
+    /**
+     * @type {boolean}
+     */
     this.android = false;
+    /**
+     * @type {boolean}
+     */
     this.chromeOS = false;
+    /**
+     * @type {boolean}
+     */
     this.linux = false;
+    /**
+     * @type {boolean}
+     */
     this.macOS = false;
+    /**
+     * @type {boolean}
+     */
     this.windows = false;
+    /**
+     * @type {boolean}
+     */
     this.windowsPhone = false;
+    /**
+     * @type {boolean}
+     */
     this.canvas = false;
+    /**
+     * @type {boolean}
+     */
     this.touch = false;
+    /**
+     * @type {boolean}
+     */
     this.mspointer = false;
     this.wheelEvent = null;
+    /**
+     * @type {boolean}
+     */
     this.chrome = false;
+    /**
+     * @type {boolean}
+     */
     this.firefox = false;
+    /**
+     * @type {boolean}
+     */
     this.edge = false;
+    /**
+     * @type {boolean}
+     */
     this.safari = false;
+    /**
+     * @type {boolean}
+     */
     this.silk = false;
+    /**
+     * @type {boolean}
+     */
     this.ogg = false;
+    /**
+     * @type {boolean}
+     */
     this.opus = false;
+    /**
+     * @type {boolean}
+     */
     this.mp3 = false;
+    /**
+     * @type {boolean}
+     */
     this.wav = false;
+    /**
+     * @type {boolean}
+     */
     this.m4a = false;
+    /**
+     * @type {boolean}
+     */
     this.webm = false;
+    /**
+     * @type {boolean}
+     */
     this.dolby = false;
+    /**
+     * @type {boolean}
+     */
     this.avif = false;
+    /**
+     * @type {boolean}
+     */
     this.webp = false;
+    /**
+     * @type {boolean}
+     */
     this.fullscreen = false;
+    /**
+     * @type {string}
+     */
     this.requestFullscreen = '';
+    /**
+     * @type {string}
+     */
     this.cancelFullscreen = '';
+    /**
+     * @type {boolean}
+     */
     this.fullscreenKeyboard = false;
   }
 }

package/src/phaser/core/dom.js

@@ -1,4 +1,5 @@
 import { Point } from '../geom/point';
+import { Device } from './device';
 
 class VisualBoundsDesktopRectangle {
   /**
@@ -182,7 +183,7 @@ class DocumentBoundsRectangle {
 export class DOM {
   /**
    * TBD.
-   * @param device
+   * @param {Device} device - TBD.
    */
   constructor(device) {
     this.treatAsDesktop =
@@ -200,8 +201,9 @@ export class DOM {
 
   /**
    * TBD.
-   * @param element
-   * @param point
+   * @param element - TBD.
+   * @param {Point} point - TBD.
+   * @returns {Point} TBD.
    */
   getOffset(element, point = null) {
     point = point || new Point();
@@ -217,8 +219,9 @@ export class DOM {
 
   /**
    * TBD.
-   * @param element
-   * @param cushion
+   * @param element - TBD.
+   * @param {number} cushion - TBD.
+   * @returns {boolean} TBD.
    */
   getBounds(element, cushion = 0) {
     element = element && !element.nodeType ? element[0] : element;
@@ -230,8 +233,9 @@ export class DOM {
 
   /**
    * TBD.
-   * @param coords
-   * @param cushion
+   * @param coords - TBD.
+   * @param {number} cushion - TBD.
+   * @returns {object} TBD.
    */
   calibrate(coords, cushion = 0) {
     const output = {
@@ -249,7 +253,8 @@ export class DOM {
 
   /**
    * TBD.
-   * @param primaryFallback
+   * @param {string} primaryFallback - TBD.
+   * @returns {string} TBD.
    */
   getScreenOrientation(primaryFallback) {
     const screen = window.screen;

package/src/phaser/core/event_manager.js

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