@vpmedia/phaser 1.20.0 → 1.22.0

package/src/phaser/core/signal_binding.js

@@ -1,12 +1,12 @@
 export class SignalBinding {
   /**
    * TBD.
-   * @param signal
-   * @param listener
-   * @param isOnce
-   * @param listenerContext
-   * @param priority
-   * @param args - TBD.
+   * @param {import('./signal').Signal} signal - TBD.
+   * @param {Function} listener - TBD.
+   * @param {boolean} isOnce - TBD.
+   * @param {object} listenerContext - TBD.
+   * @param {number} priority - TBD.
+   * @param {...any} args - TBD.
    */
   constructor(signal, listener, isOnce = false, listenerContext = null, priority = 0, args = null) {
     this._signal = signal;
@@ -22,7 +22,8 @@ export class SignalBinding {
 
   /**
    * TBD.
-   * @param paramsArr
+   * @param {any[]} paramsArr - TBD.
+   * @returns {Function} TBD.
    */
   execute(paramsArr) {
     let handlerReturn;
@@ -43,6 +44,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {Function} TBD.
    */
   detach() {
     return this.isBound() ? this._signal.remove(this._listener, this.context) : null;
@@ -50,6 +52,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   isBound() {
     return !!this._signal && !!this._listener;
@@ -57,6 +60,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   isOnce() {
     return this._isOnce;
@@ -64,6 +68,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {Function} TBD.
    */
   getListener() {
     return this._listener;
@@ -71,6 +76,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {import('./signal').Signal} TBD.
    */
   getSignal() {
     return this._signal;
@@ -87,6 +93,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {string} TBD.
    */
   toString() {
     return '[SignalBinding isOnce:' + this._isOnce + ', isBound:' + this.isBound() + ', active:' + this.active + ']';

package/src/phaser/core/sound.js

@@ -1,10 +1,9 @@
-import { Game } from './game';
 import { Signal } from './signal';
 
 export class Sound {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {string} key - TBD.
    * @param {number} volume - TBD.
    * @param {boolean} loop - TBD.

package/src/phaser/core/sound_manager.js

@@ -1,5 +1,4 @@
 import { ArraySet } from './array_set';
-import { Game } from './game';
 import { Signal } from './signal';
 import { Sound } from './sound';
 import { SoundSprite } from './sound_sprite';
@@ -7,7 +6,7 @@ import { SoundSprite } from './sound_sprite';
 export class SoundManager {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/sound_sprite.js

@@ -1,10 +1,7 @@
-import { Game } from './game';
-import { Sound } from './sound';
-
 export class SoundSprite {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {string} key - TBD.
    */
   constructor(game, key) {
@@ -31,7 +28,7 @@ export class SoundSprite {
    * TBD.
    * @param {string} marker - TBD.
    * @param {number} volume - TBD.
-   * @returns {Sound} TBD.
+   * @returns {import('./sound').Sound} TBD.
    */
   play(marker, volume = 1) {
     return this.sounds[marker].play(marker, null, volume);
@@ -54,7 +51,7 @@ export class SoundSprite {
   /**
    * TBD.
    * @param {string} marker - TBD.
-   * @returns {Sound} TBD.
+   * @returns {import('./sound').Sound} TBD.
    */
   get(marker) {
     return this.sounds[marker];

package/src/phaser/core/stage.js

@@ -3,12 +3,11 @@ 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.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     super();

package/src/phaser/core/time.js

@@ -1,10 +1,9 @@
-import { Game } from './game';
 import { Timer } from './timer';
 
 export class Time {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/timer.js

@@ -1,11 +1,10 @@
-import { Game } from './game';
 import { Signal } from './signal';
 import { TimerEvent } from './timer_event';
 
 export class Timer {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {boolean} autoDestroy - TBD.
    */
   constructor(game, autoDestroy = false) {

package/src/phaser/core/timer_event.js

@@ -1,9 +1,7 @@
-import { Timer } from './timer';
-
 export class TimerEvent {
   /**
    * TBD.
-   * @param {Timer} timer - TBD.
+   * @param {import('./timer').Timer} timer - TBD.
    * @param {number} delay - TBD.
    * @param {number} tick - TBD.
    * @param {number} repeatCount - TBD.

package/src/phaser/core/tween.js

@@ -1,17 +1,14 @@
 import { Signal } from './signal';
 import { TweenData } from './tween_data';
-import { TweenManager } from './tween_manager';
-import { DisplayObject } from '../display/display_object';
 import * as MathUtils from '../util/math';
 import { TWEEN_PENDING, TWEEN_RUNNING, TWEEN_COMPLETE, TWEEN_LOOPED } from './const';
-import { Game } from './game';
 
 export class Tween {
   /**
    * TBD.
-   * @param {DisplayObject} target - TBD.
-   * @param {Game} game - TBD.
-   * @param {TweenManager} manager - TBD.
+   * @param {import('../display/display_object').DisplayObject} target - TBD.
+   * @param {import('./game').Game} game - TBD.
+   * @param {import('./tween_manager').TweenManager} manager - TBD.
    */
   constructor(target, game, manager) {
     this.game = game;
@@ -148,7 +145,7 @@ export class Tween {
   /**
    * TBD.
    * @param {string} property - TBD.
-   * @param {number} value - TBD.
+   * @param {object} value - TBD.
    * @param {number} index - TBD.
    * @returns {Tween} TBD.
    */
@@ -235,8 +232,8 @@ export class Tween {
 
   /**
    * TBD.
-   * @param interpolation - TBD.
-   * @param context - TBD.
+   * @param {Function} interpolation - TBD.
+   * @param {object} context - TBD.
    * @param {number} index - TBD.
    * @returns {Tween} TBD.
    */
@@ -424,7 +421,8 @@ export class Tween {
   /**
    * TBD.
    * @param {number} frameRate - TBD.
-   * @param data - TBD.
+   * @param {object[]} data - TBD.
+   * @returns {object[]} TBD.
    */
   generateData(frameRate = 60, data = []) {
     if (this.game === null || this.target === null) {

package/src/phaser/core/tween_data.js

@@ -4,7 +4,7 @@ import { TWEEN_PENDING, TWEEN_RUNNING, TWEEN_COMPLETE, TWEEN_LOOPED } from './co
 export class TweenData {
   /**
    * TBD.
-   * @param parent - TBD.
+   * @param {import('./tween').Tween} parent - TBD.
    */
   constructor(parent) {
     this.parent = parent;

package/src/phaser/core/tween_manager.js

@@ -33,12 +33,11 @@ import {
   BounceInOut,
 } from './tween_easing';
 import { GROUP } from './const';
-import { Game } from './game';
 
 export class TweenManager {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/world.js

@@ -1,10 +1,9 @@
 import { Group } from '../display/group';
-import { Game } from './game';
 
 export class World extends Group {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     super(game, null, '__world', false);

package/src/phaser/display/bitmap_text.js

@@ -1,13 +1,12 @@
 import { DisplayObject } from './display_object';
 import { Image } from './image';
-import { Game } from '../core/game';
 import { Point } from '../geom/point';
 import { BITMAP_TEXT, SCALE_LINEAR, SCALE_NEAREST } from '../core/const';
 
 export class BitmapText extends DisplayObject {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('../core/game').Game} game - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {string} font - TBD.

package/src/phaser/display/button.js

@@ -1,6 +1,5 @@
 import { Image } from './image';
 import { Signal } from '../core/signal';
-import { Game } from '../core/game';
 import { InputHandler } from '../core/input_handler';
 import { BUTTON, POINTER_CONTACT } from '../core/const';
 
@@ -13,7 +12,7 @@ const STATE_DISABLED = 'Disabled';
 export class Button extends Image {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('../core/game').Game} game - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {string} key - TBD.

package/src/phaser/display/canvas/renderer.js

@@ -23,12 +23,11 @@ import {
 import { getSmoothingPrefix } from './util';
 import { detectCapabilities } from './tinter';
 import * as CanvasMaskManager from './masker';
-import { Game } from '../../core/game';
 
 export class CanvasRenderer {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('../../core/game').Game} game - TBD.
    */
   constructor(game) {
     detectCapabilities();
@@ -60,7 +59,7 @@ export class CanvasRenderer {
 
   /**
    * TBD.
-   * @param root - TBD.
+   * @param {import('../../core/stage').Stage} root - TBD.
    */
   render(root) {
     if (!this.context) {
@@ -85,7 +84,7 @@ export class CanvasRenderer {
 
   /**
    * TBD.
-   * @param removeView - TBD.
+   * @param {boolean} removeView - TBD.
    */
   destroy(removeView = true) {
     if (removeView && this.view.parent) {
@@ -117,9 +116,9 @@ export class CanvasRenderer {
 
   /**
    * TBD.
-   * @param displayObject - TBD.
-   * @param context - TBD.
-   * @param matrix - TBD.
+   * @param {Image} displayObject - TBD.
+   * @param {CanvasRenderingContext2D} context - TBD.
+   * @param {import('../../geom/matrix').Matrix} matrix - TBD.
    */
   renderDisplayObject(displayObject, context, matrix) {
     this.renderSession.context = context || this.context;

package/src/phaser/display/display_object.js

@@ -671,6 +671,7 @@ export class DisplayObject {
 
   /**
    * TBD.
+   * @returns {import('./graphics').Graphics} TBD.
    */
   get mask() {
     return this._mask;

package/src/phaser/display/graphics.js

@@ -1,13 +1,11 @@
 import { DisplayObject } from './display_object';
 import { Image } from './image';
-import { Game } from '../core/game';
 import { Rectangle } from '../geom/rectangle';
 import { RoundedRectangle } from '../geom/rounded_rectangle';
 import { Polygon } from '../geom/polygon';
 import { Circle } from '../geom/circle';
 import { Ellipse } from '../geom/ellipse';
 import { Point } from '../geom/point';
-import { Matrix } from '../geom/matrix';
 import { GraphicsData } from './graphics_data';
 import { CanvasBuffer } from './canvas/buffer';
 import { textureFromCanvas } from './webgl/texture_util';
@@ -29,7 +27,7 @@ import {
 export class Graphics extends DisplayObject {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('../core/game').Game} game - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    */
@@ -555,7 +553,7 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param {Matrix} matrix - TBD.
+   * @param {import('../geom/matrix').Matrix} matrix - TBD.
    * @returns {Rectangle} TBD.
    */
   getBounds(matrix = null) {
@@ -791,7 +789,7 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param shape - TBD.
+   * @param {object} shape - TBD.
    * @returns {GraphicsData} TBD.
    */
   drawShape(shape) {
@@ -841,8 +839,8 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param points - TBD.
-   * @param cull - TBD.
+   * @param {Point[]} points - TBD.
+   * @param {boolean} cull - TBD.
    */
   drawTriangle(points, cull = false) {
     const triangle = new Polygon(points);
@@ -861,8 +859,8 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param vertices - TBD.
-   * @param indices - TBD.
+   * @param {number[]|Point[]} vertices - TBD.
+   * @param {number[]} indices - TBD.
    * @param {boolean} cull - TBD.
    */
   drawTriangles(vertices, indices, cull = false) {

package/src/phaser/display/group.js

@@ -1,7 +1,6 @@
 import { DisplayObject } from './display_object';
 import { Image } from './image';
 import { Signal } from '../core/signal';
-import { Game } from '../core/game';
 import { GROUP } from '../core/const';
 
 export const SORT_ASCENDING = -1;
@@ -10,7 +9,7 @@ export const SORT_DESCENDING = 1;
 export class Group extends DisplayObject {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('../core/game').Game} game - TBD.
    * @param {DisplayObject} parent - TBD.
    * @param {string} name - TBD.
    * @param {boolean} addToStage - TBD.

package/src/phaser/display/image.js

@@ -2,9 +2,7 @@ import { Texture } from './webgl/texture';
 import { AnimationManager } from '../core/animation_manager';
 import { EventManager } from '../core/event_manager';
 import { Rectangle } from '../geom/rectangle';
-import { Matrix } from '../geom/matrix';
 import { DisplayObject } from './display_object';
-import { Game } from '../core/game';
 import { clone } from '../geom/util/rectangle';
 import { IMAGE, PENDING_ATLAS, BLEND_NORMAL, SCALE_NEAREST } from '../core/const';
 import { setTexture, getBounds, getLocalBounds, renderCanvas, renderWebGL } from './sprite_util';
@@ -12,7 +10,7 @@ import { setTexture, getBounds, getLocalBounds, renderCanvas, renderWebGL } from
 export class Image extends DisplayObject {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('../core/game').Game} game - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {string} key - TBD.
@@ -140,7 +138,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param frame - TBD.
+   * @param {import('../core/frame').Frame} frame - TBD.
    */
   setFrame(frame) {
     this._frame = frame;
@@ -185,7 +183,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param parent - TBD.
+   * @param {DisplayObject} parent - TBD.
    * @param {number} width - TBD.
    * @param {number} height - TBD.
    */
@@ -205,6 +203,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get frame() {
     return this.animations.frame;
@@ -236,7 +235,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param rect - TBD.
+   * @param {Rectangle} rect - TBD.
    * @param {boolean} copy - TBD.
    */
   crop(rect, copy = false) {
@@ -335,7 +334,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param texture - TBD.
+   * @param {Texture} texture - TBD.
    * @param {boolean} destroyBase - TBD.
    */
   setTexture(texture, destroyBase = false) {
@@ -344,7 +343,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param {Matrix} matrix - TBD.
+   * @param {import('../geom/matrix').Matrix} matrix - TBD.
    * @returns {Rectangle} TBD.
    */
   getBounds(matrix = null) {
@@ -362,7 +361,7 @@ export class Image extends DisplayObject {
   /**
    * TBD.
    * @param {object} renderSession - TBD.
-   * @param {Matrix} matrix - TBD.
+   * @param {import('../geom/matrix').Matrix} matrix - TBD.
    */
   renderWebGL(renderSession, matrix = null) {
     renderWebGL(this, renderSession, matrix);
@@ -371,7 +370,7 @@ export class Image extends DisplayObject {
   /**
    * TBD.
    * @param {object} renderSession - TBD.
-   * @param {Matrix} matrix - TBD.
+   * @param {import('../geom/matrix').Matrix} matrix - TBD.
    */
   renderCanvas(renderSession, matrix = null) {
     renderCanvas(this, renderSession, matrix);

package/src/phaser/display/sprite_batch.js

@@ -1,10 +1,9 @@
-import { Game } from '../core/game';
 import { DisplayObject } from './display_object';
 
 export class SpriteBatch extends DisplayObject {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('../core/game').Game} game - TBD.
    */
   constructor(game) {
     super();

package/src/phaser/display/sprite_util.js

@@ -1,6 +1,5 @@
 import { getTintedTexture } from './canvas/tinter';
 import { getIdentityMatrix } from '../geom/util/matrix';
-import { Rectangle } from '../geom/rectangle';
 import { SCALE_LINEAR } from '../core/const';
 
 /**
@@ -23,7 +22,7 @@ export function setTexture(target, texture, destroyBase = false) {
  * TBD.
  * @param {object} target - TBD.
  * @param {object} matrix - TBD.
- * @returns {Rectangle} TBD.
+ * @returns {import('../geom/rectangle').Rectangle} TBD.
  */
 export function getBounds(target, matrix = null) {
   // TODO verify
@@ -105,7 +104,7 @@ export function getBounds(target, matrix = null) {
 /**
  * TBD.
  * @param {object} target - TBD.
- * @returns {Rectangle} TBD.
+ * @returns {import('../geom/rectangle').Rectangle} TBD.
  */
 export function getLocalBounds(target) {
   const matrixCache = target.worldTransform;