@vpmedia/phaser 1.17.0 → 1.18.0

package/src/phaser/core/scale_manager.js

@@ -139,7 +139,7 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @param config - TBD.
+   * @param {object} config - TBD.
    */
   parseConfig(config) {
     if (config.scaleMode !== undefined) {
@@ -236,10 +236,10 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @param hScale - TBD.
-   * @param vScale - TBD.
-   * @param hTrim - TBD.
-   * @param vTrim - TBD.
+   * @param {number} hScale - TBD.
+   * @param {number} vScale - TBD.
+   * @param {number} hTrim - TBD.
+   * @param {number} vTrim - TBD.
    */
   setUserScale(hScale, vScale, hTrim, vTrim) {
     this._userScaleFactor.setTo(hScale, vScale);
@@ -250,7 +250,7 @@ export class ScaleManager {
   /**
    * TBD.
    * @param {Function} callback - TBD.
-   * @param context - TBD.
+   * @param {object} context - TBD.
    */
   setResizeCallback(callback, context) {
     this.onResize = callback;
@@ -282,10 +282,10 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @param minWidth - TBD.
-   * @param minHeight - TBD.
-   * @param maxWidth - TBD.
-   * @param maxHeight - TBD.
+   * @param {number} minWidth - TBD.
+   * @param {number} minHeight - TBD.
+   * @param {number} maxWidth - TBD.
+   * @param {number} maxHeight - TBD.
    */
   setMinMax(minWidth, minHeight, maxWidth, maxHeight) {
     this.minWidth = minWidth;
@@ -344,7 +344,7 @@ export class ScaleManager {
    * TBD.
    * @param {number} width - TBD.
    * @param {number} height - TBD.
-   * @param resize
+   * @param {boolean} resize - TBD.
    */
   updateDimensions(width, height, resize) {
     this.width = width * this.parentScaleFactor.x;
@@ -381,8 +381,8 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @param forceLandscape - TBD.
-   * @param forcePortrait - TBD.
+   * @param {boolean} forceLandscape - TBD.
+   * @param {boolean} forcePortrait - TBD.
    */
   forceOrientation(forceLandscape = false, forcePortrait = false) {
     this.forceLandscape = forceLandscape;
@@ -392,7 +392,8 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @param orientation - TBD.
+   * @param {string} orientation - TBD.
+   * @returns {string} TBD.
    */
   classifyOrientation(orientation) {
     if (orientation === 'portrait-primary' || orientation === 'portrait-secondary') {
@@ -405,6 +406,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   updateOrientationState() {
     const previousOrientation = this.screenOrientation;
@@ -495,7 +497,8 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @param target - TBD.
+   * @param {Rectangle} target - TBD.
+   * @returns {Rectangle} TBD.
    */
   getParentBounds(target) {
     const bounds = target || new Rectangle();
@@ -532,8 +535,8 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @param horizontal - TBD.
-   * @param vertical - TBD.
+   * @param {boolean} horizontal - TBD.
+   * @param {boolean} vertical - TBD.
    */
   alignCanvas(horizontal, vertical) {
     const parentBounds = this.getParentBounds(this._tempBounds);
@@ -608,8 +611,8 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @param cssWidth - TBD.
-   * @param cssHeight - TBD.
+   * @param {string} cssWidth - TBD.
+   * @param {string} cssHeight - TBD.
    */
   resetCanvas(cssWidth = this.width + 'px', cssHeight = this.height + 'px') {
     const canvas = this.game.canvas;
@@ -625,7 +628,7 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @param force - TBD.
+   * @param {boolean} force - TBD.
    */
   queueUpdate(force) {
     if (force) {
@@ -652,7 +655,7 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @param expanding - TBD.
+   * @param {boolean} expanding - TBD.
    */
   setShowAll(expanding = false) {
     const bounds = this.getParentBounds(this._tempBounds);
@@ -689,6 +692,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {HTMLDivElement} TBD.
    */
   createFullScreenTarget() {
     const fsTarget = document.createElement('div');
@@ -700,8 +704,9 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @param antialias - TBD.
-   * @param allowTrampoline - TBD.
+   * @param {boolean} antialias - TBD.
+   * @param {boolean} allowTrampoline - TBD.
+   * @returns {boolean} TBD.
    */
   startFullScreen(antialias, allowTrampoline) {
     if (this.isFullScreen) {
@@ -755,6 +760,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   stopFullScreen() {
     if (!this.isFullScreen || !this.compatibility.supportsFullScreen) {
@@ -782,7 +788,7 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @param enteringFullscreen - TBD.
+   * @param {boolean} enteringFullscreen - TBD.
    */
   prepScreenMode(enteringFullscreen) {
     const fsTarget = this._createdFullScreenTarget || this.fullScreenTarget;
@@ -865,6 +871,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {object} TBD.
    */
   get boundingParent() {
     if (this.parentIsWindow || (this.isFullScreen && this.hasPhaserSetFullScreen && !this._createdFullScreenTarget)) {
@@ -876,6 +883,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get scaleMode() {
     return this._scaleMode;
@@ -897,6 +905,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get fullScreenScaleMode() {
     return this._fullScreenScaleMode;
@@ -922,6 +931,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get currentScaleMode() {
     return this.isFullScreen ? this._fullScreenScaleMode : this._scaleMode;
@@ -929,6 +939,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get pageAlignHorizontally() {
     return this._pageAlignHorizontally;
@@ -936,6 +947,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get pageAlignVertically() {
     return this._pageAlignVertically;
@@ -943,6 +955,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get isFullScreen() {
     return !!(
@@ -955,6 +968,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get isPortrait() {
     return this.classifyOrientation(this.screenOrientation) === 'portrait';
@@ -962,6 +976,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get isLandscape() {
     return this.classifyOrientation(this.screenOrientation) === 'landscape';
@@ -969,6 +984,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get isGamePortrait() {
     return this.height > this.width;
@@ -976,6 +992,7 @@ export class ScaleManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get isGameLandscape() {
     return this.width > this.height;

package/src/phaser/core/scene_manager.js

@@ -5,7 +5,7 @@ export class SceneManager {
   /**
    * TBD.
    * @param {Game} game - TBD.
-   * @param pendingState - TBD.
+   * @param {string} pendingState - TBD.
    */
   constructor(game, pendingState) {
     this.game = game;
@@ -41,7 +41,8 @@ export class SceneManager {
    * TBD.
    * @param {string} key - TBD.
    * @param state - TBD.
-   * @param autoStart - TBD.
+   * @param {boolean} autoStart - TBD.
+   * @returns {Scene|object} TBD.
    */
   add(key, state, autoStart = false) {
     let newState = null;
@@ -85,8 +86,8 @@ export class SceneManager {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param clearWorld - TBD.
-   * @param clearCache - TBD.
+   * @param {boolean} clearWorld - TBD.
+   * @param {boolean} clearCache - TBD.
    * @param {...any} args - TBD.
    */
   start(key, clearWorld = true, clearCache = false, ...args) {
@@ -103,8 +104,8 @@ export class SceneManager {
 
   /**
    * TBD.
-   * @param clearWorld - TBD.
-   * @param clearCache - TBD.
+   * @param {boolean} clearWorld - TBD.
+   * @param {boolean} clearCache - TBD.
    * @param {...any} args - TBD.
    */
   restart(clearWorld = true, clearCache = false, ...args) {
@@ -174,6 +175,7 @@ export class SceneManager {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkState(key) {
     if (this.states[key]) {
@@ -230,6 +232,7 @@ export class SceneManager {
 
   /**
    * TBD.
+   * @returns {Scene} TBD.
    */
   getCurrentState() {
     return this.states[this.current];
@@ -305,6 +308,7 @@ export class SceneManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get created() {
     return this._created;

package/src/phaser/core/sound_manager.js

@@ -229,7 +229,7 @@ export class SoundManager {
 
   /**
    * TBD.
-   * @param files - TBD.
+   * @param {Sound[]|string[]} files - TBD.
    * @param {Function} callback - TBD.
    * @param {object} callbackContext - TBD.
    */
@@ -286,9 +286,10 @@ export class SoundManager {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param volume - TBD.
-   * @param loop - TBD.
-   * @param connect - TBD.
+   * @param {number} volume - TBD.
+   * @param {boolean} loop - TBD.
+   * @param {boolean} connect - TBD.
+   * @returns {Sound} TBD.
    */
   add(key, volume = 1, loop = false, connect = this.connectToMaster) {
     const sound = new Sound(this.game, key, volume, loop, connect);
@@ -299,6 +300,7 @@ export class SoundManager {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {SoundSprite} TBD.
    */
   addSprite(key) {
     return new SoundSprite(this.game, key);
@@ -306,7 +308,8 @@ export class SoundManager {
 
   /**
    * TBD.
-   * @param sound - TBD.
+   * @param {Sound} sound - TBD.
+   * @returns {boolean} TBD.
    */
   remove(sound) {
     let i = this._sounds.length;
@@ -324,6 +327,7 @@ export class SoundManager {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {number} TBD.
    */
   removeByKey(key) {
     let i = this._sounds.length;
@@ -342,8 +346,9 @@ export class SoundManager {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param volume - TBD.
-   * @param loop - TBD.
+   * @param {number} volume - TBD.
+   * @param {boolean} loop - TBD.
+   * @returns {Sound} TBD.
    */
   play(key, volume = 1, loop = false) {
     if (this.noAudio) {
@@ -406,6 +411,7 @@ export class SoundManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get mute() {
     return this._muted;
@@ -432,6 +438,7 @@ export class SoundManager {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get volume() {
     return this._volume;

package/src/phaser/core/sound_sprite.js

@@ -1,4 +1,5 @@
 import { Game } from './game';
+import { Sound } from './sound';
 
 export class SoundSprite {
   /**
@@ -28,8 +29,9 @@ export class SoundSprite {
 
   /**
    * TBD.
-   * @param marker - TBD.
-   * @param volume - TBD.
+   * @param {string} marker - TBD.
+   * @param {number} volume - TBD.
+   * @returns {Sound} TBD.
    */
   play(marker, volume = 1) {
     return this.sounds[marker].play(marker, null, volume);
@@ -37,7 +39,7 @@ export class SoundSprite {
 
   /**
    * TBD.
-   * @param marker - TBD.
+   * @param {string} marker - TBD.
    */
   stop(marker) {
     if (!marker) {
@@ -51,7 +53,8 @@ export class SoundSprite {
 
   /**
    * TBD.
-   * @param marker - TBD.
+   * @param {string} marker - TBD.
+   * @returns {Sound} TBD.
    */
   get(marker) {
     return this.sounds[marker];

package/src/phaser/core/timer.js

@@ -33,12 +33,13 @@ export class Timer {
 
   /**
    * TBD.
-   * @param delay - TBD.
-   * @param loop
-   * @param repeatCount
+   * @param {number} delay - TBD.
+   * @param {boolean} loop - TBD.
+   * @param {number} repeatCount - TBD.
    * @param {Function} callback - TBD.
-   * @param callbackContext
-   * @param args - TBD.
+   * @param {object} callbackContext - TBD.
+   * @param {...any} args - TBD.
+   * @returns {TimerEvent} TBD.
    */
   create(delay, loop, repeatCount, callback, callbackContext, args) {
     const roundedDelay = Math.round(delay);
@@ -57,10 +58,11 @@ export class Timer {
 
   /**
    * TBD.
-   * @param delay - TBD.
+   * @param {number} delay - TBD.
    * @param {Function} callback - TBD.
-   * @param callbackContext
-   * @param {...any} args
+   * @param {object} callbackContext - TBD.
+   * @param {...any} args - TBD.
+   * @returns {TimerEvent} TBD.
    */
   add(delay, callback, callbackContext, ...args) {
     return this.create(delay, false, 0, callback, callbackContext, args);
@@ -68,11 +70,12 @@ export class Timer {
 
   /**
    * TBD.
-   * @param delay - TBD.
-   * @param repeatCount
+   * @param {number} delay - TBD.
+   * @param {number} repeatCount - TBD.
    * @param {Function} callback - TBD.
-   * @param callbackContext
-   * @param {...any} args
+   * @param {object} callbackContext - TBD.
+   * @param {...any} args - TBD.
+   * @returns {TimerEvent} TBD.
    */
   repeat(delay, repeatCount, callback, callbackContext, ...args) {
     return this.create(delay, false, repeatCount, callback, callbackContext, args);
@@ -80,10 +83,11 @@ export class Timer {
 
   /**
    * TBD.
-   * @param delay - TBD.
+   * @param {number} delay - TBD.
    * @param {Function} callback - TBD.
-   * @param callbackContext
-   * @param {...any} args
+   * @param {object} callbackContext - TBD.
+   * @param {...any} args - TBD.
+   * @returns {TimerEvent} TBD.
    */
   loop(delay, callback, callbackContext, ...args) {
     return this.create(delay, true, 0, callback, callbackContext, args);
@@ -91,7 +95,7 @@ export class Timer {
 
   /**
    * TBD.
-   * @param delay - TBD.
+   * @param {number} delay - TBD.
    */
   start(delay) {
     if (this.running) {
@@ -106,7 +110,7 @@ export class Timer {
 
   /**
    * TBD.
-   * @param clearEvents
+   * @param {boolean} clearEvents - TBD.
    */
   stop(clearEvents = true) {
     this.running = false;
@@ -118,6 +122,7 @@ export class Timer {
   /**
    * TBD.
    * @param {Event} event - TBD.
+   * @returns {boolean} TBD.
    */
   remove(event) {
     for (let i = 0; i < this.events.length; i += 1) {
@@ -142,8 +147,9 @@ export class Timer {
 
   /**
    * TBD.
-   * @param a - TBD.
-   * @param b - TBD.
+   * @param {TimerEvent} a - TBD.
+   * @param {TimerEvent} b - TBD.
+   * @returns {number} TBD.
    */
   sortHandler(a, b) {
     if (a.tick < b.tick) {
@@ -171,7 +177,8 @@ export class Timer {
 
   /**
    * TBD.
-   * @param time - TBD.
+   * @param {number} time - TBD.
+   * @returns {boolean} TBD.
    */
   update(time) {
     if (this.paused) {
@@ -256,7 +263,7 @@ export class Timer {
 
   /**
    * TBD.
-   * @param baseTime - TBD.
+   * @param {number} baseTime - TBD.
    */
   adjustEvents(baseTime) {
     for (let i = 0; i < this.events.length; i += 1) {
@@ -326,6 +333,7 @@ export class Timer {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get next() {
     return this.nextTick;
@@ -333,6 +341,7 @@ export class Timer {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get duration() {
     if (this.running && this.nextTick > this._now) {
@@ -343,6 +352,7 @@ export class Timer {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get length() {
     return this.events.length;
@@ -350,6 +360,7 @@ export class Timer {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get ms() {
     if (this.running) {
@@ -360,6 +371,7 @@ export class Timer {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get seconds() {
     if (this.running) {

package/src/phaser/core/timer_event.js

@@ -1,14 +1,16 @@
+import { Timer } from './timer';
+
 export class TimerEvent {
   /**
    * TBD.
-   * @param timer - TBD.
-   * @param delay - TBD.
-   * @param tick - TBD.
-   * @param repeatCount - TBD.
-   * @param loop - TBD.
+   * @param {Timer} timer - TBD.
+   * @param {number} delay - TBD.
+   * @param {number} tick - TBD.
+   * @param {number} repeatCount - TBD.
+   * @param {boolean} loop - TBD.
    * @param {Function} callback - TBD.
    * @param {object} callbackContext - TBD.
-   * @param args - TBD.
+   * @param {...any} args - TBD.
    */
   constructor(timer, delay, tick, repeatCount, loop, callback, callbackContext, args) {
     this.timer = timer;