@vpmedia/phaser 1.14.0 → 1.16.0

package/src/phaser/core/const.js

@@ -1,40 +1,119 @@
+// rectangle
 /**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
+ * @type {number}
  */
-// rectangle
 export const TOP_LEFT = 0;
+/**
+ * @type {number}
+ */
 export const TOP_CENTER = 1;
+/**
+ * @type {number}
+ */
 export const TOP_RIGHT = 2;
+/**
+ * @type {number}
+ */
 export const LEFT_TOP = 3;
+/**
+ * @type {number}
+ */
 export const LEFT_CENTER = 4;
+/**
+ * @type {number}
+ */
 export const LEFT_BOTTOM = 5;
+/**
+ * @type {number}
+ */
 export const CENTER = 6;
+/**
+ * @type {number}
+ */
 export const RIGHT_TOP = 7;
+/**
+ * @type {number}
+ */
 export const RIGHT_CENTER = 8;
+/**
+ * @type {number}
+ */
 export const RIGHT_BOTTOM = 9;
+/**
+ * @type {number}
+ */
 export const BOTTOM_LEFT = 10;
+/**
+ * @type {number}
+ */
 export const BOTTOM_CENTER = 11;
+/**
+ * @type {number}
+ */
 export const BOTTOM_RIGHT = 12;
 // scale modes
+/**
+ * @type {number}
+ */
 export const SCALE_LINEAR = 0;
+/**
+ * @type {number}
+ */
 export const SCALE_NEAREST = 1;
 // scale manager modes
+/**
+ * @type {number}
+ */
 export const SCALE_EXACT_FIT = 0;
+/**
+ * @type {number}
+ */
 export const SCALE_OFF = 1;
+/**
+ * @type {number}
+ */
 export const SCALE_SHOW_ALL = 2;
+/**
+ * @type {number}
+ */
 export const SCALE_RESIZE = 3;
+/**
+ * @type {number}
+ */
 export const SCALE_USER = 4;
 // times
+/**
+ * @type {number}
+ */
 export const TIME_MINUTE = 60000;
+/**
+ * @type {number}
+ */
 export const TIME_SECOND = 1000;
+/**
+ * @type {number}
+ */
 export const TIME_HALF = 500;
+/**
+ * @type {number}
+ */
 export const TIME_QUARTER = 250;
 // tween statuses
+/**
+ * @type {number}
+ */
 export const TWEEN_PENDING = 0;
+/**
+ * @type {number}
+ */
 export const TWEEN_RUNNING = 1;
+/**
+ * @type {number}
+ */
 export const TWEEN_LOOPED = 2;
+/**
+ * @type {number}
+ */
 export const TWEEN_COMPLETE = 3;
 // blend modes
 export const BLEND_NORMAL = 0;
@@ -55,15 +134,39 @@ export const BLEND_SATURATION = 14;
 export const BLEND_COLOR = 15;
 export const BLEND_LUMINOSITY = 16;
 // render modes
+/**
+ * @type {number}
+ */
 export const RENDER_AUTO = 0;
+/**
+ * @type {number}
+ */
 export const RENDER_CANVAS = 1;
+/**
+ * @type {number}
+ */
 export const RENDER_WEBGL = 2;
 // pointer modes
+/**
+ * @type {number}
+ */
 export const POINTER_CURSOR = 1;
+/**
+ * @type {number}
+ */
 export const POINTER_CONTACT = 2;
 // input modes
+/**
+ * @type {number}
+ */
 export const MOUSE_OVERRIDES_TOUCH = 0;
+/**
+ * @type {number}
+ */
 export const TOUCH_OVERRIDES_MOUSE = 1;
+/**
+ * @type {number}
+ */
 export const MOUSE_TOUCH_COMBINE = 2;
 // game objects
 export const GROUP = 7;

package/src/phaser/core/device.js

@@ -1,10 +1,7 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- */
-
 export class Device {
+  /**
+   * TBD.
+   */
   constructor() {
     this.desktop = false;
     this.iOS = false;
@@ -30,6 +27,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

@@ -1,13 +1,7 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- */
-import { Device } from "./device";
+import { Device } from './device';
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  * @param {string} type - TBD.
  * @returns {boolean} TBD.
@@ -33,7 +27,6 @@ export function canPlayAudio(device, type) {
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function checkOS(device) {
@@ -65,19 +58,13 @@ export function checkOS(device) {
     device.desktop = true;
   }
   // iOS / Windows Phone / Tablet reset
-  if (
-    device.android ||
-    device.iOS ||
-    device.windowsPhone ||
-    (/Windows NT/i.test(ua) && /Touch/i.test(ua))
-  ) {
+  if (device.android || device.iOS || device.windowsPhone || (/Windows NT/i.test(ua) && /Touch/i.test(ua))) {
     device.desktop = false;
   }
 }
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function checkInput(device) {
@@ -98,7 +85,6 @@ export function checkInput(device) {
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function checkFullScreenSupport(device) {
@@ -145,7 +131,6 @@ export function checkFullScreenSupport(device) {
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function checkBrowser(device) {
@@ -167,7 +152,6 @@ export function checkBrowser(device) {
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function checkAudio(device) {
@@ -192,10 +176,7 @@ export function checkAudio(device) {
       if (audioElement.canPlayType('audio/wav; codecs="1"').replace(/^no$/, '')) {
         device.wav = true;
       }
-      if (
-        audioElement.canPlayType('audio/x-m4a;') ||
-        audioElement.canPlayType('audio/aac;').replace(/^no$/, '')
-      ) {
+      if (audioElement.canPlayType('audio/x-m4a;') || audioElement.canPlayType('audio/aac;').replace(/^no$/, '')) {
         device.m4a = true;
       }
       if (audioElement.canPlayType('audio/webm; codecs="vorbis"').replace(/^no$/, '')) {
@@ -214,7 +195,6 @@ export function checkAudio(device) {
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function checkImage(device) {
@@ -239,7 +219,6 @@ export function checkImage(device) {
 
 /**
  * TBD.
- *
  * @param {Device} device - TBD.
  */
 export function initialize(device) {
@@ -253,7 +232,6 @@ export function initialize(device) {
 
 /**
  * TBD.
- *
  * @returns {Device} TBD.
  */
 export function createDevice() {

package/src/phaser/core/dom.js

@@ -1,87 +1,138 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- */
 import { Point } from '../geom/point';
 
 class VisualBoundsDesktopRectangle {
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get x() {
-    return window && 'pageXOffset' in window
-      ? window.pageXOffset
-      : document.documentElement.scrollLeft;
+    return window && 'pageXOffset' in window ? window.pageXOffset : document.documentElement.scrollLeft;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get y() {
-    return window && 'pageYOffset' in window
-      ? window.pageYOffset
-      : document.documentElement.scrollTop;
+    return window && 'pageYOffset' in window ? window.pageYOffset : document.documentElement.scrollTop;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get width() {
     return Math.max(window.innerWidth, document.documentElement.clientWidth);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get height() {
     return Math.max(window.innerHeight, document.documentElement.clientHeight);
   }
 }
 
 class LayoutBoundsDesktopRectangle {
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get x() {
     return 0;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get y() {
     return 0;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get width() {
     return Math.max(window.innerWidth, document.documentElement.clientWidth);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get height() {
     return Math.max(window.innerHeight, document.documentElement.clientHeight);
   }
 }
 
 class VisualBoundsRectangle {
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get x() {
-    return window && 'pageXOffset' in window
-      ? window.pageXOffset
-      : document.documentElement.scrollLeft;
+    return window && 'pageXOffset' in window ? window.pageXOffset : document.documentElement.scrollLeft;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get y() {
-    return window && 'pageYOffset' in window
-      ? window.pageYOffset
-      : document.documentElement.scrollTop;
+    return window && 'pageYOffset' in window ? window.pageYOffset : document.documentElement.scrollTop;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get width() {
     return window.innerWidth;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get height() {
     return window.innerHeight;
   }
 }
 
 class LayoutBoundsRectangle {
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get x() {
     return 0;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get y() {
     return 0;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get width() {
     const a = document.documentElement.clientWidth;
     const b = window.innerWidth;
     return a < b ? b : a; // max
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get height() {
     const a = document.documentElement.clientHeight;
     const b = window.innerHeight;
@@ -93,19 +144,35 @@ class LayoutBoundsRectangle {
 // Ref. http://www.quirksmode.org/mobile/tableViewport_desktop.html
 
 class DocumentBoundsRectangle {
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get x() {
     return 0;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get y() {
     return 0;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get width() {
     const d = document.documentElement;
     return Math.max(d.clientWidth, d.offsetWidth, d.scrollWidth);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get height() {
     const d = document.documentElement;
     return Math.max(d.clientHeight, d.offsetHeight, d.scrollHeight);
@@ -113,28 +180,29 @@ class DocumentBoundsRectangle {
 }
 
 export class DOM {
+  /**
+   * TBD.
+   * @param device
+   */
   constructor(device) {
     this.treatAsDesktop =
       device.desktop &&
       document.documentElement.clientWidth <= window.innerWidth &&
       document.documentElement.clientHeight <= window.innerHeight;
-    this.visualBounds = this.treatAsDesktop
-      ? new VisualBoundsDesktopRectangle()
-      : new VisualBoundsRectangle();
-    this.layoutBounds = this.treatAsDesktop
-      ? new LayoutBoundsDesktopRectangle()
-      : new LayoutBoundsRectangle();
+    this.visualBounds = this.treatAsDesktop ? new VisualBoundsDesktopRectangle() : new VisualBoundsRectangle();
+    this.layoutBounds = this.treatAsDesktop ? new LayoutBoundsDesktopRectangle() : new LayoutBoundsRectangle();
     this.documentBounds = new DocumentBoundsRectangle();
     this.scrollXProvider =
-      window && 'pageXOffset' in window
-        ? () => window.pageXOffset
-        : () => document.documentElement.scrollLeft;
+      window && 'pageXOffset' in window ? () => window.pageXOffset : () => document.documentElement.scrollLeft;
     this.scrollYProvider =
-      window && 'pageYOffset' in window
-        ? () => window.pageYOffset
-        : () => document.documentElement.scrollTop;
+      window && 'pageYOffset' in window ? () => window.pageYOffset : () => document.documentElement.scrollTop;
   }
 
+  /**
+   * TBD.
+   * @param element
+   * @param point
+   */
   getOffset(element, point = null) {
     point = point || new Point();
     const box = element.getBoundingClientRect();
@@ -147,6 +215,11 @@ export class DOM {
     return point;
   }
 
+  /**
+   * TBD.
+   * @param element
+   * @param cushion
+   */
   getBounds(element, cushion = 0) {
     element = element && !element.nodeType ? element[0] : element;
     if (!element || element.nodeType !== 1) {
@@ -155,6 +228,11 @@ export class DOM {
     return this.calibrate(element.getBoundingClientRect(), cushion);
   }
 
+  /**
+   * TBD.
+   * @param coords
+   * @param cushion
+   */
   calibrate(coords, cushion = 0) {
     const output = {
       width: 0,
@@ -169,6 +247,10 @@ export class DOM {
     return output;
   }
 
+  /**
+   * TBD.
+   * @param primaryFallback
+   */
   getScreenOrientation(primaryFallback) {
     const screen = window.screen;
     const orientation = screen.orientation || screen.mozOrientation || screen.msOrientation;
@@ -198,18 +280,34 @@ export class DOM {
     return this.visualBounds.height > this.visualBounds.width ? PORTRAIT : LANDSCAPE;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get scrollX() {
     return this.scrollXProvider();
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get scrollY() {
     return this.scrollYProvider();
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get clientWidth() {
     return Math.max(window.innerWidth, document.documentElement.clientWidth);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get clientHeight() {
     return Math.max(window.innerHeight, document.documentElement.clientHeight);
   }