@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/core/loader_parser.js

@@ -1,10 +1,5 @@
-/**
- * @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 { Texture } from '../display/webgl/texture';
-import { Rectangle } from  '../geom/rectangle';
+import { Rectangle } from '../geom/rectangle';
 
 /**
  * TBD.
@@ -15,10 +10,7 @@ import { Rectangle } from  '../geom/rectangle';
 export function finalizeBitmapFont(baseTexture, bitmapFontData) {
   Object.keys(bitmapFontData.chars).forEach((charCode) => {
     const letter = bitmapFontData.chars[charCode];
-    letter.texture = new Texture(
-      baseTexture,
-      new Rectangle(letter.x, letter.y, letter.width, letter.height)
-    );
+    letter.texture = new Texture(baseTexture, new Rectangle(letter.x, letter.y, letter.width, letter.height));
   });
   return bitmapFontData;
 }

package/src/phaser/core/raf.js

@@ -1,23 +1,34 @@
-/**
- * @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 { Game } from './game';
+
 export class RequestAnimationFrame {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   */
   constructor(game) {
     this.game = game;
     this.rafId = 0;
     this.updateBinded = this.update.bind(this);
   }
 
+  /**
+   * TBD.
+   */
   start() {
     this.rafId = requestAnimationFrame(this.updateBinded);
   }
 
+  /**
+   * TBD.
+   */
   stop() {
     cancelAnimationFrame(this.rafId);
   }
 
+  /**
+   * TBD.
+   * @param {number} rafTime - TBD.
+   */
   update(rafTime) {
     this.game.update(rafTime);
     this.rafId = requestAnimationFrame(this.updateBinded);

package/src/phaser/core/scale_manager.js

@@ -1,22 +1,17 @@
-/**
- * @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 { Signal } from  './signal';
+import { Signal } from './signal';
 import { DOM } from './dom';
 import { Point } from '../geom/point';
-import { Rectangle } from  '../geom/rectangle';
-import {
-  SCALE_OFF,
-  SCALE_RESIZE,
-  SCALE_EXACT_FIT,
-  SCALE_USER,
-  SCALE_SHOW_ALL,
-  RENDER_CANVAS,
-} from './const';
+import { Rectangle } from '../geom/rectangle';
+import { SCALE_OFF, SCALE_RESIZE, SCALE_EXACT_FIT, SCALE_USER, SCALE_SHOW_ALL, RENDER_CANVAS } from './const';
+import { Game } from './game';
 
 export class ScaleManager {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   */
   constructor(game, width, height) {
     this.game = game;
     this.dom = new DOM(game.device);
@@ -95,6 +90,9 @@ export class ScaleManager {
     this.setupScale(width, height);
   }
 
+  /**
+   * TBD.
+   */
   boot() {
     // Configure device-dependent compatibility
     const compat = this.compatibility;
@@ -139,6 +137,10 @@ export class ScaleManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param config - TBD.
+   */
   parseConfig(config) {
     if (config.scaleMode !== undefined) {
       if (this._booted) {
@@ -157,6 +159,11 @@ export class ScaleManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   */
   setupScale(width, height) {
     let target;
     const rect = new Rectangle();
@@ -207,10 +214,18 @@ export class ScaleManager {
     this.updateDimensions(newWidth, newHeight, false);
   }
 
+  /**
+   * TBD.
+   */
   _gameResumed() {
     this.queueUpdate(true);
   }
 
+  /**
+   * TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   */
   setGameSize(width, height) {
     this._gameSize.setTo(0, 0, width, height);
     if (this.currentScaleMode !== SCALE_RESIZE) {
@@ -219,17 +234,32 @@ export class ScaleManager {
     this.queueUpdate(true);
   }
 
+  /**
+   * TBD.
+   * @param hScale - TBD.
+   * @param vScale - TBD.
+   * @param hTrim - TBD.
+   * @param vTrim - TBD.
+   */
   setUserScale(hScale, vScale, hTrim, vTrim) {
     this._userScaleFactor.setTo(hScale, vScale);
     this._userScaleTrim.setTo(hTrim | 0, vTrim | 0);
     this.queueUpdate(true);
   }
 
+  /**
+   * TBD.
+   * @param {Function} callback - TBD.
+   * @param context - TBD.
+   */
   setResizeCallback(callback, context) {
     this.onResize = callback;
     this.onResizeContext = context;
   }
 
+  /**
+   * TBD.
+   */
   signalSizeChange() {
     if (
       this.width !== this._lastReportedCanvasSize.width ||
@@ -250,6 +280,13 @@ export class ScaleManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param minWidth - TBD.
+   * @param minHeight - TBD.
+   * @param maxWidth - TBD.
+   * @param maxHeight - TBD.
+   */
   setMinMax(minWidth, minHeight, maxWidth, maxHeight) {
     this.minWidth = minWidth;
     this.minHeight = minHeight;
@@ -261,6 +298,9 @@ export class ScaleManager {
     }
   }
 
+  /**
+   * TBD.
+   */
   preUpdate() {
     if (this.game.time.time < this._lastUpdate + this._updateThrottle) {
       return;
@@ -291,12 +331,21 @@ export class ScaleManager {
     this._lastUpdate = this.game.time.time;
   }
 
+  /**
+   * TBD.
+   */
   pauseUpdate() {
     this.preUpdate();
     // Updates at slowest.
     this._updateThrottle = this.trackParentInterval;
   }
 
+  /**
+   * TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   * @param resize
+   */
   updateDimensions(width, height, resize) {
     this.width = width * this.parentScaleFactor.x;
     this.height = height * this.parentScaleFactor.y;
@@ -310,6 +359,9 @@ export class ScaleManager {
     }
   }
 
+  /**
+   * TBD.
+   */
   updateScalingAndBounds() {
     this.scaleFactor.x = this.game.width / this.width;
     this.scaleFactor.y = this.game.height / this.height;
@@ -327,12 +379,21 @@ export class ScaleManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param forceLandscape - TBD.
+   * @param forcePortrait - TBD.
+   */
   forceOrientation(forceLandscape = false, forcePortrait = false) {
     this.forceLandscape = forceLandscape;
     this.forcePortrait = forcePortrait;
     this.queueUpdate(true);
   }
 
+  /**
+   * TBD.
+   * @param orientation - TBD.
+   */
   classifyOrientation(orientation) {
     if (orientation === 'portrait-primary' || orientation === 'portrait-secondary') {
       return 'portrait';
@@ -342,12 +403,14 @@ export class ScaleManager {
     return null;
   }
 
+  /**
+   * TBD.
+   */
   updateOrientationState() {
     const previousOrientation = this.screenOrientation;
     const previouslyIncorrect = this.incorrectOrientation;
     this.screenOrientation = this.dom.getScreenOrientation(this.compatibility.orientationFallback);
-    this.incorrectOrientation =
-      (this.forceLandscape && !this.isLandscape) || (this.forcePortrait && !this.isPortrait);
+    this.incorrectOrientation = (this.forceLandscape && !this.isLandscape) || (this.forcePortrait && !this.isPortrait);
     const changed = previousOrientation !== this.screenOrientation;
     const correctnessChanged = previouslyIncorrect !== this.incorrectOrientation;
     if (correctnessChanged) {
@@ -363,20 +426,34 @@ export class ScaleManager {
     return changed || correctnessChanged;
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   orientationChange(event) {
     this.event = event;
     this.queueUpdate(true);
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   windowResize(event) {
     this.event = event;
     this.queueUpdate(true);
   }
 
+  /**
+   * TBD.
+   */
   refresh() {
     this.queueUpdate(true);
   }
 
+  /**
+   * TBD.
+   */
   updateLayout() {
     const scaleMode = this.currentScaleMode;
     if (scaleMode === SCALE_RESIZE) {
@@ -405,10 +482,7 @@ export class ScaleManager {
       this.width = this.game.width * this._userScaleFactor.x - this._userScaleTrim.x;
       this.height = this.game.height * this._userScaleFactor.y - this._userScaleTrim.y;
     }
-    if (
-      !this.compatibility.canExpandParent &&
-      (scaleMode === SCALE_SHOW_ALL || scaleMode === SCALE_USER)
-    ) {
+    if (!this.compatibility.canExpandParent && (scaleMode === SCALE_SHOW_ALL || scaleMode === SCALE_USER)) {
       const bounds = this.getParentBounds(this._tempBounds);
       this.width = Math.min(this.width, bounds.width);
       this.height = Math.min(this.height, bounds.height);
@@ -419,6 +493,10 @@ export class ScaleManager {
     this.reflowCanvas();
   }
 
+  /**
+   * TBD.
+   * @param target - TBD.
+   */
   getParentBounds(target) {
     const bounds = target || new Rectangle();
     const parentNode = this.boundingParent;
@@ -448,15 +526,15 @@ export class ScaleManager {
         bounds.bottom = Math.min(bounds.bottom, windowBounds.height);
       }
     }
-    bounds.setTo(
-      Math.round(bounds.x),
-      Math.round(bounds.y),
-      Math.round(bounds.width),
-      Math.round(bounds.height)
-    );
+    bounds.setTo(Math.round(bounds.x), Math.round(bounds.y), Math.round(bounds.width), Math.round(bounds.height));
     return bounds;
   }
 
+  /**
+   * TBD.
+   * @param horizontal - TBD.
+   * @param vertical - TBD.
+   */
   alignCanvas(horizontal, vertical) {
     const parentBounds = this.getParentBounds(this._tempBounds);
     const canvas = this.game.canvas;
@@ -500,19 +578,22 @@ export class ScaleManager {
     margin.y = margin.top;
   }
 
+  /**
+   * TBD.
+   */
   reflowGame() {
     this.resetCanvas('', '');
     const bounds = this.getParentBounds(this._tempBounds);
     this.updateDimensions(bounds.width, bounds.height, true);
   }
 
+  /**
+   * TBD.
+   */
   reflowCanvas() {
     if (!this.incorrectOrientation) {
       this.width = Math.max(this.minWidth || 0, Math.min(this.maxWidth || this.width, this.width));
-      this.height = Math.max(
-        this.minHeight || 0,
-        Math.min(this.maxHeight || this.height, this.height)
-      );
+      this.height = Math.max(this.minHeight || 0, Math.min(this.maxHeight || this.height, this.height));
     }
     this.resetCanvas();
     if (!this.compatibility.noMargins) {
@@ -525,6 +606,11 @@ export class ScaleManager {
     this.updateScalingAndBounds();
   }
 
+  /**
+   * TBD.
+   * @param cssWidth - TBD.
+   * @param cssHeight - TBD.
+   */
   resetCanvas(cssWidth = this.width + 'px', cssHeight = this.height + 'px') {
     const canvas = this.game.canvas;
     if (!this.compatibility.noMargins) {
@@ -537,6 +623,10 @@ export class ScaleManager {
     canvas.style.height = cssHeight;
   }
 
+  /**
+   * TBD.
+   * @param force - TBD.
+   */
   queueUpdate(force) {
     if (force) {
       this._parentBounds.width = 0;
@@ -545,15 +635,25 @@ export class ScaleManager {
     this._updateThrottle = this._updateThrottleReset;
   }
 
+  /**
+   * TBD.
+   */
   reset() {
     // pass
   }
 
+  /**
+   * TBD.
+   */
   setMaximum() {
     this.width = this.dom.visualBounds.width;
     this.height = this.dom.visualBounds.height;
   }
 
+  /**
+   * TBD.
+   * @param expanding - TBD.
+   */
   setShowAll(expanding = false) {
     const bounds = this.getParentBounds(this._tempBounds);
     const width = bounds.width;
@@ -568,6 +668,9 @@ export class ScaleManager {
     this.height = Math.round(this.game.height * multiplier);
   }
 
+  /**
+   * TBD.
+   */
   setExactFit() {
     const bounds = this.getParentBounds(this._tempBounds);
     this.width = bounds.width;
@@ -584,6 +687,9 @@ export class ScaleManager {
     }
   }
 
+  /**
+   * TBD.
+   */
   createFullScreenTarget() {
     const fsTarget = document.createElement('div');
     fsTarget.style.margin = '0';
@@ -592,6 +698,11 @@ export class ScaleManager {
     return fsTarget;
   }
 
+  /**
+   * TBD.
+   * @param antialias - TBD.
+   * @param allowTrampoline - TBD.
+   */
   startFullScreen(antialias, allowTrampoline) {
     if (this.isFullScreen) {
       return false;
@@ -611,10 +722,7 @@ export class ScaleManager {
         input.activePointer !== input.mousePointer &&
         (allowTrampoline || allowTrampoline !== false)
       ) {
-        input.activePointer.addClickTrampoline('startFullScreen', this.startFullScreen, this, [
-          antialias,
-          false,
-        ]);
+        input.activePointer.addClickTrampoline('startFullScreen', this.startFullScreen, this, [antialias, false]);
         return false;
       }
     }
@@ -645,6 +753,9 @@ export class ScaleManager {
     return true;
   }
 
+  /**
+   * TBD.
+   */
   stopFullScreen() {
     if (!this.isFullScreen || !this.compatibility.supportsFullScreen) {
       return false;
@@ -654,6 +765,9 @@ export class ScaleManager {
     return true;
   }
 
+  /**
+   * TBD.
+   */
   cleanupCreatedTarget() {
     const fsTarget = this._createdFullScreenTarget;
     if (fsTarget && fsTarget.parentNode) {
@@ -666,6 +780,10 @@ export class ScaleManager {
     this._createdFullScreenTarget = null;
   }
 
+  /**
+   * TBD.
+   * @param enteringFullscreen - TBD.
+   */
   prepScreenMode(enteringFullscreen) {
     const fsTarget = this._createdFullScreenTarget || this.fullScreenTarget;
     if (!fsTarget) {
@@ -696,6 +814,10 @@ export class ScaleManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   fullScreenChange(event) {
     this.event = event;
     if (this.isFullScreen) {
@@ -711,12 +833,19 @@ export class ScaleManager {
     this.onFullScreenChange.dispatch(this, this.width, this.height);
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   fullScreenError(event) {
     this.event = event;
     this.cleanupCreatedTarget();
     this.onFullScreenError.dispatch(this);
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.game.onResume.remove(this._gameResumed, this);
     window.removeEventListener('orientationchange', this._orientationChange, false);
@@ -734,21 +863,27 @@ export class ScaleManager {
     }
   }
 
+  /**
+   * TBD.
+   */
   get boundingParent() {
-    if (
-      this.parentIsWindow ||
-      (this.isFullScreen && this.hasPhaserSetFullScreen && !this._createdFullScreenTarget)
-    ) {
+    if (this.parentIsWindow || (this.isFullScreen && this.hasPhaserSetFullScreen && !this._createdFullScreenTarget)) {
       return null;
     }
     const parentNode = this.game.canvas && this.game.canvas.parentNode;
     return parentNode || null;
   }
 
+  /**
+   * TBD.
+   */
   get scaleMode() {
     return this._scaleMode;
   }
 
+  /**
+   * TBD.
+   */
   set scaleMode(value) {
     if (value !== this._scaleMode) {
       if (!this.isFullScreen) {
@@ -760,10 +895,16 @@ export class ScaleManager {
     // return this._scaleMode;
   }
 
+  /**
+   * TBD.
+   */
   get fullScreenScaleMode() {
     return this._fullScreenScaleMode;
   }
 
+  /**
+   * TBD.
+   */
   set fullScreenScaleMode(value) {
     if (value !== this._fullScreenScaleMode) {
       // If in fullscreen then need a wee bit more work
@@ -779,18 +920,30 @@ export class ScaleManager {
     // return this._fullScreenScaleMode;
   }
 
+  /**
+   * TBD.
+   */
   get currentScaleMode() {
     return this.isFullScreen ? this._fullScreenScaleMode : this._scaleMode;
   }
 
+  /**
+   * TBD.
+   */
   get pageAlignHorizontally() {
     return this._pageAlignHorizontally;
   }
 
+  /**
+   * TBD.
+   */
   get pageAlignVertically() {
     return this._pageAlignVertically;
   }
 
+  /**
+   * TBD.
+   */
   get isFullScreen() {
     return !!(
       document.fullscreenElement ||
@@ -800,18 +953,30 @@ export class ScaleManager {
     );
   }
 
+  /**
+   * TBD.
+   */
   get isPortrait() {
     return this.classifyOrientation(this.screenOrientation) === 'portrait';
   }
 
+  /**
+   * TBD.
+   */
   get isLandscape() {
     return this.classifyOrientation(this.screenOrientation) === 'landscape';
   }
 
+  /**
+   * TBD.
+   */
   get isGamePortrait() {
     return this.height > this.width;
   }
 
+  /**
+   * TBD.
+   */
   get isGameLandscape() {
     return this.width > this.height;
   }

package/src/phaser/core/scene.js

@@ -1,38 +1,57 @@
-/**
- * @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 Scene {
+  /**
+   * TBD.
+   */
   constructor() {
     this.game = null;
     this.key = '';
   }
 
+  /**
+   * TBD.
+   */
   init() {
     // inherit
   }
 
+  /**
+   * TBD.
+   */
   preload() {
     // inherit
   }
 
+  /**
+   * TBD.
+   */
   create() {
     // inherit
   }
 
+  /**
+   * TBD.
+   */
   update() {
     // inherit
   }
 
+  /**
+   * TBD.
+   */
   resize() {
     // inherit
   }
 
+  /**
+   * TBD.
+   */
   pauseUpdate() {
     // inherit
   }
 
+  /**
+   * TBD.
+   */
   shutdown() {
     // inherit
   }