@vpmedia/phaser 1.20.0 → 1.21.0

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';
@@ -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;

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';
@@ -140,7 +138,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param frame - TBD.
+   * @param {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) {

package/src/phaser/display/sprite_batch.js

@@ -1,4 +1,3 @@
-import { Game } from '../core/game';
 import { DisplayObject } from './display_object';
 
 export class SpriteBatch extends DisplayObject {

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';
 
 /**

package/src/phaser/display/text.js

@@ -1,10 +1,8 @@
 import { Point } from '../geom/point';
 import { Rectangle } from '../geom/rectangle';
-import { Matrix } from '../geom/matrix';
 import { Image } from './image';
 import { create, remove } from './canvas/pool';
 import { textureFromCanvas } from './webgl/texture_util';
-import { Game } from '../core/game';
 import { TEXT } from '../core/const';
 import { snapToCeil } from '../util/math';
 import { renderCanvas, renderWebGL, getBounds } from './sprite_util';
@@ -71,10 +69,11 @@ export class Text extends Image {
    * TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
-   * @param color - TBD.
-   * @param blur - TBD.
-   * @param shadowStroke - TBD.
-   * @param shadowFill - TBD.
+   * @param {string} color - TBD.
+   * @param {number} blur - TBD.
+   * @param {boolean} shadowStroke - TBD.
+   * @param {boolean} shadowFill - TBD.
+   * @returns {Text} TBD.
    */
   setShadow(x = 0, y = 0, color = 'rgba(0, 0, 0, 1)', blur = 0, shadowStroke = true, shadowFill = true) {
     this.style.shadowOffsetX = x;
@@ -89,8 +88,9 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param style
-   * @param update
+   * @param {object} style - TBD.
+   * @param {boolean} update - TBD.
+   * @returns {Text} TBD.
    */
   setStyle(style = null, update = false) {
     style = JSON.parse(JSON.stringify(style)) || {};
@@ -298,10 +298,10 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param line - TBD.
+   * @param {string} line - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
-   * @param fill - TBD.
+   * @param {boolean} fill - TBD.
    */
   renderTabLine(line, x, y, fill) {
     const text = line.split(/(?:\t)/);
@@ -337,7 +337,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param state
+   * @param {string} state - TBD.
    */
   updateShadow(state) {
     if (state) {
@@ -355,7 +355,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param line - TBD.
+   * @param {string} line - TBD.
+   * @returns {number} TBD.
    */
   measureLine(line) {
     let lineLength = 0;
@@ -391,7 +392,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param line - TBD.
+   * @param {string} line - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    */
@@ -451,8 +452,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param color - TBD.
-   * @param position - TBD.
+   * @param {number} color - TBD.
+   * @param {number} position - TBD.
    * @returns {Text} TBD.
    */
   addColor(color, position) {
@@ -463,8 +464,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param color - TBD.
-   * @param position - TBD.
+   * @param {number} color - TBD.
+   * @param {number} position - TBD.
    * @returns {Text} TBD.
    */
   addStrokeColor(color, position) {
@@ -475,8 +476,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param style - TBD.
-   * @param position - TBD.
+   * @param {object} style - TBD.
+   * @param {number} position - TBD.
    * @returns {Text} TBD.
    */
   addFontStyle(style, position) {
@@ -487,8 +488,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param weight - TBD.
-   * @param position - TBD.
+   * @param {number} weight - TBD.
+   * @param {number} position - TBD.
    * @returns {Text} TBD.
    */
   addFontWeight(weight, position) {
@@ -499,7 +500,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param text - TBD.
+   * @param {string} text - TBD.
+   * @returns {string[]} TBD.
    */
   precalculateWordWrap(text) {
     this.texture.baseTexture.resolution = this._res;
@@ -510,7 +512,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param text - TBD.
+   * @param {string} text - TBD.
+   * @returns {string} TBD.
    */
   runWordWrap(text) {
     if (this.useAdvancedWrap) {
@@ -521,7 +524,9 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param text - TBD.
+   * @param {string} text - TBD.
+   * @returns {string} TBD.
+   * @throws Error.
    */
   advancedWordWrap(text) {
     const context = this.context;
@@ -602,7 +607,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param text - TBD.
+   * @param {string} text - TBD.
+   * @returns {string} TBD.
    */
   basicWordWrap(text) {
     let result = '';
@@ -634,7 +640,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param components
+   * @param {object} components - TBD.
    */
   updateFont(components) {
     const font = this.componentsToFont(components);
@@ -649,7 +655,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param font - TBD.
+   * @param {string} font - TBD.
    * @returns {object} TBD.
    */
   fontToComponents(font) {
@@ -685,7 +691,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param components - TBD.
+   * @param {object} components - TBD.
+   * @returns {string} TBD.
    */
   componentsToFont(components) {
     const parts = [];
@@ -719,8 +726,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param text - TBD.
-   * @param immediate - TBD.
+   * @param {string} text - TBD.
+   * @param {boolean} immediate - TBD.
    * @returns {Text} TBD.
    */
   setText(text, immediate = false) {
@@ -735,7 +742,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param list
+   * @param {string[]|string[][]} list - TBD.
    * @returns {Text} TBD.
    */
   parseList(list) {
@@ -876,6 +883,7 @@ export class Text extends Image {
 
   /**
    * TBD.
+   * @returns {CanvasRenderingContext2D} TBD.
    */
   getFontPropertiesContext() {
     if (!window.PhaserRegistry.fontPropertiesContext) {
@@ -888,7 +896,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param fontStyle
+   * @param {string} fontStyle - TBD.
+   * @returns {object} TBD.
    */
   determineFontProperties(fontStyle) {
     const fontPropertiesCache = this.getFontPropertiesCache();

package/src/phaser/display/webgl/abstract_filter.js

@@ -1,7 +1,7 @@
 export class AbstractFilter {
   /**
    * TBD.
-   * @param fragmentSrc - TBD.
+   * @param {string[]} fragmentSrc - TBD.
    * @param {object} uniforms - TBD.
    */
   constructor(fragmentSrc, uniforms) {

package/src/phaser/display/webgl/fast_sprite_batch.js

@@ -96,7 +96,7 @@ export class FastSpriteBatch {
 
   /**
    * TBD.
-   * @param sprite - TBD.
+   * @param {Image} sprite - TBD.
    */
   renderSprite(sprite) {
     if (!sprite.visible) {

package/src/phaser/display/webgl/graphics.js

@@ -53,7 +53,7 @@ export function switchMode(webGL, type) {
 /**
  * TBD.
  * @param {object} graphicsData - TBD.
- * @param {object} webGLData - TBD.
+ * @param {GraphicsData} webGLData - TBD.
  */
 export function buildLine(graphicsData, webGLData) {
   // TODO OPTIMISE!
@@ -218,7 +218,7 @@ export function buildLine(graphicsData, webGLData) {
 /**
  * TBD.
  * @param {object} graphicsData - TBD.
- * @param {object} webGLData - TBD.
+ * @param {GraphicsData} webGLData - TBD.
  */
 export function buildRectangle(graphicsData, webGLData) {
   //
@@ -301,7 +301,7 @@ export function quadraticBezierCurve(fromX, fromY, cpX, cpY, toX, toY) {
 /**
  * TBD.
  * @param {object} graphicsData - TBD.
- * @param {object} webGLData - TBD.
+ * @param {GraphicsData} webGLData - TBD.
  */
 export function buildRoundedRectangle(graphicsData, webGLData) {
   const rrectData = graphicsData.shape;
@@ -351,7 +351,7 @@ export function buildRoundedRectangle(graphicsData, webGLData) {
 /**
  * TBD.
  * @param {object} graphicsData - TBD.
- * @param {object} webGLData - TBD.
+ * @param {GraphicsData} webGLData - TBD.
  */
 export function buildCircle(graphicsData, webGLData) {
   // need to convert points to a nice regular data
@@ -402,7 +402,7 @@ export function buildCircle(graphicsData, webGLData) {
 /**
  * TBD.
  * @param {object} graphicsData - TBD.
- * @param {object} webGLData - TBD.
+ * @param {GraphicsData} webGLData - TBD.
  */
 export function buildComplexPoly(graphicsData, webGLData) {
   // TODO - no need to copy this as it gets turned into a Float32Array anyways..
@@ -446,7 +446,7 @@ export function buildComplexPoly(graphicsData, webGLData) {
 /**
  * TBD.
  * @param {object} graphicsData - TBD.
- * @param {object} webGLData - TBD.
+ * @param {GraphicsData} webGLData - TBD.
  * @returns {boolean} TBD.
  */
 export function buildPoly(graphicsData, webGLData) {

package/src/phaser/display/webgl/render_texture.js

@@ -11,7 +11,7 @@ export class RenderTexture extends Texture {
    * TBD.
    * @param {number} width - TBD.
    * @param {number} height - TBD.
-   * @param renderer - TBD.
+   * @param {WebGLRenderer|CanvasRenderer} renderer - TBD.
    * @param {number} scaleMode - TBD.
    * @param {number} resolution - TBD.
    */

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

@@ -22,14 +22,12 @@ import {
 import { remove } from '../canvas/pool';
 import { isPowerOfTwo } from '../../util/math';
 import { Point } from '../../geom/point';
-import { Matrix } from '../../geom/matrix';
 import { WebGLShaderManager } from './shader_manager';
 import { WebGLSpriteBatch } from './sprite_batch';
 import * as WebGLMaskManager from './mask_manager';
 import { WebGLFilterManager } from './filter_manager';
 import { WebGLStencilManager } from './stencil_manager';
 import { WebGLBlendModeManager } from './blend_manager';
-import { Game } from '../../core/game';
 
 export class WebGLRenderer {
   /**
@@ -121,6 +119,7 @@ export class WebGLRenderer {
 
   /**
    * TBD.
+   * @throws Error.
    */
   initContext() {
     const gl =
@@ -154,7 +153,7 @@ export class WebGLRenderer {
 
   /**
    * TBD.
-   * @param stage - TBD.
+   * @param {Stage} stage - TBD.
    */
   render(stage) {
     if (this.contextLost) {
@@ -176,9 +175,9 @@ export class WebGLRenderer {
 
   /**
    * TBD.
-   * @param displayObject - TBD.
-   * @param projection - TBD.
-   * @param buffer - TBD.
+   * @param {DisplayObject} displayObject - TBD.
+   * @param {Point} projection - TBD.
+   * @param {object} buffer - TBD.
    * @param {Matrix} matrix - TBD.
    */
   renderDisplayObject(displayObject, projection, buffer, matrix) {
@@ -222,7 +221,7 @@ export class WebGLRenderer {
 
   /**
    * TBD.
-   * @param texture - TBD.
+   * @param {BaseTexture} texture - TBD.
    * @returns {boolean} TBD.
    */
   updateTexture(texture) {

package/src/phaser/display/webgl/shader/normal.js

@@ -131,7 +131,7 @@ export class NormalShader {
 
   /**
    * TBD.
-   * @param uniform - TBD.
+   * @param {object} uniform - TBD.
    */
   initSampler2D(uniform) {
     if (!uniform.value || !uniform.value.baseTexture || !uniform.value.baseTexture.hasLoaded) {

package/src/phaser/display/webgl/shader_manager.js

@@ -40,7 +40,7 @@ export class WebGLShaderManager {
 
   /**
    * TBD.
-   * @param attribs - TBD.
+   * @param {number[]} attribs - TBD.
    */
   setAttribs(attribs) {
     // reset temp state
@@ -68,7 +68,8 @@ export class WebGLShaderManager {
 
   /**
    * TBD.
-   * @param shader - TBD.
+   * @param {NormalShader} shader - TBD.
+   * @returns {boolean} TBD.
    */
   setShader(shader) {
     if (this._currentId === shader._UID) {

package/src/phaser/display/webgl/sprite_batch.js

@@ -1,7 +1,5 @@
 import { AbstractFilter } from './abstract_filter';
 import { NormalShader } from './shader/normal';
-import { BaseTexture } from './base_texture';
-import { Matrix } from '../../geom/matrix';
 
 export class WebGLSpriteBatch {
   /**
@@ -88,7 +86,7 @@ export class WebGLSpriteBatch {
 
   /**
    * TBD.
-   * @param sprite - TBD.
+   * @param {Image} sprite - TBD.
    * @param {Matrix} matrix - TBD.
    */
   render(sprite, matrix) {

package/src/phaser/display/webgl/stencil_manager.js

@@ -28,8 +28,8 @@ export class WebGLStencilManager {
 
   /**
    * TBD.
-   * @param graphics - TBD.
-   * @param webGLData - TBD.
+   * @param {Graphics} graphics - TBD.
+   * @param {GraphicsData} webGLData - TBD.
    * @param {object} renderSession - TBD.
    */
   pushStencil(graphics, webGLData, renderSession) {
@@ -86,8 +86,8 @@ export class WebGLStencilManager {
 
   /**
    * TBD.
-   * @param graphics - TBD.
-   * @param webGLData - TBD.
+   * @param {Graphics} graphics - TBD.
+   * @param {GraphicsData} webGLData - TBD.
    * @param {object} renderSession - TBD.
    */
   bindGraphics(graphics, webGLData, renderSession) {
@@ -133,8 +133,8 @@ export class WebGLStencilManager {
 
   /**
    * TBD.
-   * @param graphics - TBD.
-   * @param webGLData - TBD.
+   * @param {Graphics} graphics - TBD.
+   * @param {GraphicsData} webGLData - TBD.
    * @param {object} renderSession - TBD.
    */
   popStencil(graphics, webGLData, renderSession) {

package/src/phaser/display/webgl/texture.js

@@ -1,5 +1,4 @@
 import { Rectangle } from '../../geom/rectangle';
-import { BaseTexture } from './base_texture';
 
 export class TextureUvs {
   /**