@vpmedia/phaser 1.18.0 → 1.19.0

package/src/phaser/display/text.js

@@ -71,10 +71,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 +90,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 +300,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 +339,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param state
+   * @param {string} state - TBD.
    */
   updateShadow(state) {
     if (state) {
@@ -355,7 +357,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param line - TBD.
+   * @param {string} line - TBD.
+   * @returns {number} TBD.
    */
   measureLine(line) {
     let lineLength = 0;
@@ -391,7 +394,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param line - TBD.
+   * @param {string} line - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    */
@@ -451,8 +454,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 +466,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 +478,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 +490,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 +502,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 +514,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param text - TBD.
+   * @param {string} text - TBD.
+   * @returns {string} TBD.
    */
   runWordWrap(text) {
     if (this.useAdvancedWrap) {
@@ -521,7 +526,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 +609,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param text - TBD.
+   * @param {string} text - TBD.
+   * @returns {string} TBD.
    */
   basicWordWrap(text) {
     let result = '';
@@ -634,7 +642,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param components
+   * @param {object} components - TBD.
    */
   updateFont(components) {
     const font = this.componentsToFont(components);
@@ -649,7 +657,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param font - TBD.
+   * @param {string} font - TBD.
    * @returns {object} TBD.
    */
   fontToComponents(font) {
@@ -685,7 +693,8 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param components - TBD.
+   * @param {object} components - TBD.
+   * @returns {string} TBD.
    */
   componentsToFont(components) {
     const parts = [];
@@ -719,8 +728,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 +744,7 @@ export class Text extends Image {
 
   /**
    * TBD.
-   * @param list
+   * @param {string[]|string[][]} list - TBD.
    * @returns {Text} TBD.
    */
   parseList(list) {
@@ -876,6 +885,7 @@ export class Text extends Image {
 
   /**
    * TBD.
+   * @returns {CanvasRenderingContext2D} TBD.
    */
   getFontPropertiesContext() {
     if (!window.PhaserRegistry.fontPropertiesContext) {
@@ -888,7 +898,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

@@ -1,3 +1,5 @@
+import { Image } from '../image';
+
 export class FastSpriteBatch {
   /**
    * TBD.
@@ -96,7 +98,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

@@ -4,6 +4,8 @@ import { Texture } from './texture';
 import { BaseTexture } from './base_texture';
 import { FilterTexture } from './filter_texture';
 import { CanvasBuffer } from '../canvas/buffer';
+import { CanvasRenderer } from '../canvas/renderer';
+import { WebGLRenderer } from './renderer';
 import { RENDER_WEBGL } from '../../core/const';
 
 export class RenderTexture extends Texture {
@@ -11,7 +13,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

@@ -29,6 +29,9 @@ import * as WebGLMaskManager from './mask_manager';
 import { WebGLFilterManager } from './filter_manager';
 import { WebGLStencilManager } from './stencil_manager';
 import { WebGLBlendModeManager } from './blend_manager';
+import { BaseTexture } from './base_texture';
+import { DisplayObject } from '../../display/display_object';
+import { Stage } from '../../core/stage';
 import { Game } from '../../core/game';
 
 export class WebGLRenderer {
@@ -121,6 +124,7 @@ export class WebGLRenderer {
 
   /**
    * TBD.
+   * @throws Error.
    */
   initContext() {
     const gl =
@@ -154,7 +158,7 @@ export class WebGLRenderer {
 
   /**
    * TBD.
-   * @param stage - TBD.
+   * @param {Stage} stage - TBD.
    */
   render(stage) {
     if (this.contextLost) {
@@ -176,9 +180,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 +226,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

@@ -2,6 +2,7 @@ import { AbstractFilter } from './abstract_filter';
 import { NormalShader } from './shader/normal';
 import { BaseTexture } from './base_texture';
 import { Matrix } from '../../geom/matrix';
+import { Image } from '../../display/image';
 
 export class WebGLSpriteBatch {
   /**
@@ -88,7 +89,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

@@ -1,4 +1,6 @@
 import { hex2rgb } from '../../util/math';
+import { GraphicsData } from './graphics_data';
+import { Graphics } from '../../display/graphics';
 
 export class WebGLStencilManager {
   /**
@@ -28,8 +30,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 +88,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 +135,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/typedefs/global.d.ts

@@ -1,6 +1,6 @@
 declare global {
   interface Window {
-    PhaserRegistry: object;
+    PhaserRegistry: any;
   }
 }