@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/core/sound.js

@@ -1,11 +1,15 @@
-/**
- * @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 { Game } from './game';
+import { Signal } from './signal';
 
 export class Sound {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   * @param {string} key - TBD.
+   * @param {number} volume - TBD.
+   * @param {boolean} loop - TBD.
+   * @param {boolean} connect - TBD.
+   */
   constructor(game, key, volume = 1, loop = false, connect = null) {
     // TODO
     // https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Migrating_from_webkitAudioContext
@@ -74,6 +78,10 @@ export class Sound {
     this._paused = false;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   soundHasUnlocked(key) {
     if (key === this.key) {
       this._sound = this.game.cache.getSoundData(this.key);
@@ -81,6 +89,14 @@ export class Sound {
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} name - TBD.
+   * @param {number} start - TBD.
+   * @param {number} duration - TBD.
+   * @param {number} volume - TBD.
+   * @param {boolean} loop - TBD.
+   */
   addMarker(name, start, duration = 1, volume = 1, loop = false) {
     this.markers[name] = {
       name,
@@ -93,10 +109,17 @@ export class Sound {
     };
   }
 
+  /**
+   * TBD.
+   * @param {string} name - TBD.
+   */
   removeMarker(name) {
     delete this.markers[name];
   }
 
+  /**
+   * TBD.
+   */
   onEndedHandler() {
     this._sound.onended = null;
     this.isPlaying = false;
@@ -126,6 +149,9 @@ export class Sound {
     }
   }
 
+  /**
+   * TBD.
+   */
   update() {
     if (!this.game.cache.checkSoundKey(this.key)) {
       this.destroy();
@@ -173,10 +199,24 @@ export class Sound {
     }
   }
 
+  /**
+   * TBD.
+   * @param {number} volume - TBD.
+   * @returns {Sound} TBD.
+   */
   loopFull(volume) {
     return this.play(null, 0, volume, true);
   }
 
+  /**
+   * TBD.
+   * @param {string} marker - TBD.
+   * @param {number} position - TBD.
+   * @param {number} volume - TBD.
+   * @param {boolean} loop - TBD.
+   * @param {boolean} forceRestart - TBD.
+   * @returns {Sound} TBD.
+   */
   play(marker, position, volume, loop, forceRestart) {
     if (marker === undefined || marker === false || marker === null) {
       marker = '';
@@ -287,10 +327,7 @@ export class Sound {
         this.onPlay.dispatch(this);
       } else {
         this.pendingPlayback = true;
-        if (
-          this.game.cache.getSound(this.key) &&
-          this.game.cache.getSound(this.key).isDecoding === false
-        ) {
+        if (this.game.cache.getSound(this.key) && this.game.cache.getSound(this.key).isDecoding === false) {
           this.game.sound.decode(this.key, this);
         }
       }
@@ -323,10 +360,20 @@ export class Sound {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {string} marker - TBD.
+   * @param {number} position - TBD.
+   * @param {number} volume - TBD.
+   * @param {boolean} loop - TBD.
+   */
   restart(marker = '', position = 0, volume = 1, loop = false) {
     this.play(marker, position, volume, loop, true);
   }
 
+  /**
+   * TBD.
+   */
   pause() {
     if (this.isPlaying && this._sound) {
       this.paused = true;
@@ -338,6 +385,9 @@ export class Sound {
     }
   }
 
+  /**
+   * TBD.
+   */
   resume() {
     if (this.paused && this._sound) {
       if (!this.game.sound.noAudio) {
@@ -372,6 +422,9 @@ export class Sound {
     }
   }
 
+  /**
+   * TBD.
+   */
   stop() {
     if (this.isPlaying && this._sound) {
       if (!this.game.sound.noAudio) {
@@ -402,6 +455,12 @@ export class Sound {
     }
   }
 
+  /**
+   * TBD.
+   * @param {number} duration - TBD.
+   * @param {boolean} loop - TBD.
+   * @param {string} marker - TBD.
+   */
   fadeIn(duration, loop = false, marker = this.currentMarker) {
     if (this.paused) {
       return;
@@ -410,10 +469,19 @@ export class Sound {
     this.fadeTo(duration, 1);
   }
 
+  /**
+   * TBD.
+   * @param {number} duration - TBD.
+   */
   fadeOut(duration) {
     this.fadeTo(duration, 0);
   }
 
+  /**
+   * TBD.
+   * @param {number} duration - TBD.
+   * @param {number} volume - TBD.
+   */
   fadeTo(duration = 100, volume = 0) {
     if (!this.isPlaying || this.paused || volume === this.volume) {
       return;
@@ -422,6 +490,9 @@ export class Sound {
     this.fadeTween.onComplete.add(this.fadeComplete, this);
   }
 
+  /**
+   * TBD.
+   */
   fadeComplete() {
     this.onFadeComplete.dispatch(this, this.volume);
     if (this.volume === 0) {
@@ -429,6 +500,10 @@ export class Sound {
     }
   }
 
+  /**
+   * TBD.
+   * @param {boolean} remove - TBD.
+   */
   destroy(remove = true) {
     this._markedToDelete = true;
     this._removeFromSoundManager = remove;
@@ -450,10 +525,17 @@ export class Sound {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get mute() {
     return this._muted || this.game.sound.mute;
   }
 
+  /**
+   * TBD.
+   */
   set mute(value) {
     value = value || false;
     if (value === this._muted) {
@@ -474,10 +556,17 @@ export class Sound {
     this.onMute.dispatch(this);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get volume() {
     return this._volume;
   }
 
+  /**
+   * TBD.
+   */
   set volume(value) {
     if (this._muted) {
       this._muteVolume = value;

package/src/phaser/core/sound_manager.js

@@ -1,14 +1,14 @@
-/**
- * @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 { ArraySet } from './array_set';
-import { Signal } from  './signal';
+import { Game } from './game';
+import { Signal } from './signal';
 import { Sound } from './sound';
 import { SoundSprite } from './sound_sprite';
 
 export class SoundManager {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   */
   constructor(game) {
     this.game = game;
     this.onChange = new Signal();
@@ -29,6 +29,9 @@ export class SoundManager {
     this._watchContext = null;
   }
 
+  /**
+   * TBD.
+   */
   boot() {
     if (this.game.config.isForceDisabledAudio) {
       this.noAudio = true;
@@ -57,9 +60,7 @@ export class SoundManager {
     }
     if (
       this.context === null ||
-      (this.context &&
-        this.context.createGain === undefined &&
-        this.context.createGainNode === undefined)
+      (this.context && this.context.createGain === undefined && this.context.createGainNode === undefined)
     ) {
       this.noAudio = true;
       return;
@@ -83,10 +84,7 @@ export class SoundManager {
         state: this.context.state,
         isLocked: this.isLocked,
       });
-      if (
-        !this.isLocked &&
-        (this.context.state === 'suspended' || this.context.state === 'interrupted')
-      ) {
+      if (!this.isLocked && (this.context.state === 'suspended' || this.context.state === 'interrupted')) {
         this.addUnlockHandlers();
       } else if (this.isLocked && this.context.state === 'running') {
         this.removeUnlockHandlers();
@@ -94,6 +92,9 @@ export class SoundManager {
     });
   }
 
+  /**
+   * TBD.
+   */
   addUnlockHandlers() {
     this.isLocked = true;
     this.onChange.dispatch('addUnlockHandlers', {
@@ -106,6 +107,9 @@ export class SoundManager {
     document.body.addEventListener('keydown', this.onUnlockEventBinded, false);
   }
 
+  /**
+   * TBD.
+   */
   removeUnlockHandlers() {
     this.isLocked = false;
     this.onChange.dispatch('removeUnlockHandlers', {
@@ -118,6 +122,10 @@ export class SoundManager {
     document.body.removeEventListener('keydown', this.onUnlockEventBinded);
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   onUnlockEvent(event) {
     const initialState = this.context.state;
     if (initialState !== 'suspended' && initialState !== 'interrupted') {
@@ -156,6 +164,9 @@ export class SoundManager {
       });
   }
 
+  /**
+   * TBD.
+   */
   stopAll() {
     if (this.noAudio) {
       return;
@@ -167,6 +178,9 @@ export class SoundManager {
     }
   }
 
+  /**
+   * TBD.
+   */
   pauseAll() {
     if (this.noAudio) {
       return;
@@ -178,6 +192,9 @@ export class SoundManager {
     }
   }
 
+  /**
+   * TBD.
+   */
   resumeAll() {
     if (this.noAudio) {
       return;
@@ -189,6 +206,10 @@ export class SoundManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   decode(key) {
     const soundData = this.game.cache.getSoundData(key);
     if (soundData) {
@@ -206,6 +227,12 @@ export class SoundManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param files - TBD.
+   * @param {Function} callback - TBD.
+   * @param {object} callbackContext - TBD.
+   */
   setDecodedCallback(files, callback, callbackContext) {
     if (typeof files === 'string') {
       files = [files];
@@ -231,6 +258,9 @@ export class SoundManager {
     }
   }
 
+  /**
+   * TBD.
+   */
   update() {
     if (this.noAudio) {
       return;
@@ -253,16 +283,31 @@ export class SoundManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param volume - TBD.
+   * @param loop - TBD.
+   * @param connect - TBD.
+   */
   add(key, volume = 1, loop = false, connect = this.connectToMaster) {
     const sound = new Sound(this.game, key, volume, loop, connect);
     this._sounds.push(sound);
     return sound;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   addSprite(key) {
     return new SoundSprite(this.game, key);
   }
 
+  /**
+   * TBD.
+   * @param sound - TBD.
+   */
   remove(sound) {
     let i = this._sounds.length;
     while (i) {
@@ -276,6 +321,10 @@ export class SoundManager {
     return false;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   removeByKey(key) {
     let i = this._sounds.length;
     let removed = 0;
@@ -290,6 +339,12 @@ export class SoundManager {
     return removed;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param volume - TBD.
+   * @param loop - TBD.
+   */
   play(key, volume = 1, loop = false) {
     if (this.noAudio) {
       return null;
@@ -299,6 +354,9 @@ export class SoundManager {
     return sound;
   }
 
+  /**
+   * TBD.
+   */
   setMute() {
     if (this._muted) {
       return;
@@ -311,6 +369,9 @@ export class SoundManager {
     this.onChange.dispatch('muted');
   }
 
+  /**
+   * TBD.
+   */
   unsetMute() {
     if (!this._muted || this._codeMuted) {
       return;
@@ -322,6 +383,9 @@ export class SoundManager {
     this.onChange.dispatch('unmuted');
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.stopAll();
     for (let i = 0; i < this._sounds.length; i += 1) {
@@ -340,10 +404,16 @@ export class SoundManager {
     }
   }
 
+  /**
+   * TBD.
+   */
   get mute() {
     return this._muted;
   }
 
+  /**
+   * TBD.
+   */
   set mute(value) {
     if (value || false) {
       if (this._muted) {
@@ -360,10 +430,16 @@ export class SoundManager {
     }
   }
 
+  /**
+   * TBD.
+   */
   get volume() {
     return this._volume;
   }
 
+  /**
+   * TBD.
+   */
   set volume(value) {
     if (value < 0) {
       value = 0;

package/src/phaser/core/sound_sprite.js

@@ -1,9 +1,11 @@
-/**
- * @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 SoundSprite {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   * @param {string} key - TBD.
+   */
   constructor(game, key) {
     this.game = game;
     this.key = key;
@@ -24,10 +26,19 @@ export class SoundSprite {
     }
   }
 
+  /**
+   * TBD.
+   * @param marker - TBD.
+   * @param volume - TBD.
+   */
   play(marker, volume = 1) {
     return this.sounds[marker].play(marker, null, volume);
   }
 
+  /**
+   * TBD.
+   * @param marker - TBD.
+   */
   stop(marker) {
     if (!marker) {
       for (let key in this.sounds) {
@@ -38,6 +49,10 @@ export class SoundSprite {
     }
   }
 
+  /**
+   * TBD.
+   * @param marker - TBD.
+   */
   get(marker) {
     return this.sounds[marker];
   }

package/src/phaser/core/stage.js

@@ -1,15 +1,15 @@
-/**
- * @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 { Matrix } from  '../geom/matrix';
-import { DisplayObject } from  '../display/display_object';
+import { Matrix } from '../geom/matrix';
+import { DisplayObject } from '../display/display_object';
 import { setUserSelect, setTouchAction } from '../display/canvas/util';
 import { valueToColor } from '../util/math';
 import { SCALE_LINEAR, SCALE_NEAREST } from './const';
+import { Game } from './game';
 
 export class Stage extends DisplayObject {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   */
   constructor(game) {
     super();
     this.game = game;
@@ -33,6 +33,10 @@ export class Stage extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @param {number} color - TBD.
+   */
   setBackgroundColor(color) {
     if (this.game.config.transparent) {
       return;
@@ -45,11 +49,17 @@ export class Stage extends DisplayObject {
     this._bgColor.a = 1;
   }
 
+  /**
+   * TBD.
+   */
   boot() {
     setUserSelect(this.game.canvas, 'none');
     setTouchAction(this.game.canvas, 'none');
   }
 
+  /**
+   * TBD.
+   */
   preUpdate() {
     this.currentRenderOrderID = 0;
     //  This can't loop in reverse, we need the renderOrderID to be in sequence
@@ -58,6 +68,9 @@ export class Stage extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   */
   update() {
     let i = this.children.length;
     while (i) {
@@ -66,6 +79,9 @@ export class Stage extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   */
   postUpdate() {
     for (let i = 0; i < this.children.length; i += 1) {
       this.children[i].postUpdate();
@@ -73,6 +89,9 @@ export class Stage extends DisplayObject {
     this.updateTransform();
   }
 
+  /**
+   * TBD.
+   */
   updateTransform() {
     this.worldAlpha = 1;
     for (let i = 0; i < this.children.length; i += 1) {
@@ -80,6 +99,9 @@ export class Stage extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.exists = false;
     this.game = null;
@@ -87,18 +109,32 @@ export class Stage extends DisplayObject {
     this._bgColor = null;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get backgroundColor() {
     return this._bgColor.color;
   }
 
+  /**
+   * TBD.
+   */
   set backgroundColor(value) {
     this.setBackgroundColor(value);
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get smoothed() {
     return window.PhaserRegistry.TEXTURE_SCALE_MODE === SCALE_LINEAR;
   }
 
+  /**
+   * TBD.
+   */
   set smoothed(value) {
     window.PhaserRegistry.TEXTURE_SCALE_MODE = value ? SCALE_LINEAR : SCALE_NEAREST;
   }