@vpmedia/phaser 1.0.2 → 1.0.3

package/src/phaser/core/tween_easing.js

@@ -3,16 +3,11 @@
  * @author       Richard Davey <rich@photonstorm.com>
  * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-/* eslint-disable no-cond-assign */
-/* eslint-disable no-return-assign */
-/* eslint-disable no-restricted-properties */
-/* eslint-disable no-plusplus */
-
-// TODO fix eslint
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function LinearNone(k) {
   return k;
@@ -20,7 +15,8 @@ export function LinearNone(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function QuadraticIn(k) {
   return k * k;
@@ -28,7 +24,8 @@ export function QuadraticIn(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function QuadraticOut(k) {
   return k * (2 - k);
@@ -36,7 +33,8 @@ export function QuadraticOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function QuadraticInOut(k) {
   if ((k *= 2) < 1) return 0.5 * k * k;
@@ -45,7 +43,8 @@ export function QuadraticInOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function CubicIn(k) {
   return k * k * k;
@@ -53,7 +52,8 @@ export function CubicIn(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function CubicOut(k) {
   return --k * k * k + 1;
@@ -61,7 +61,8 @@ export function CubicOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function CubicInOut(k) {
   if ((k *= 2) < 1) return 0.5 * k * k * k;
@@ -70,7 +71,8 @@ export function CubicInOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function QuarticIn(k) {
   return k * k * k * k;
@@ -78,7 +80,8 @@ export function QuarticIn(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function QuarticOut(k) {
   return 1 - (--k * k * k * k);
@@ -86,7 +89,8 @@ export function QuarticOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function QuarticInOut(k) {
   if ((k *= 2) < 1) return 0.5 * k * k * k * k;
@@ -95,7 +99,8 @@ export function QuarticInOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function QuinticIn(k) {
   return k * k * k * k * k;
@@ -103,7 +108,8 @@ export function QuinticIn(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function QuinticOut(k) {
   return --k * k * k * k * k + 1;
@@ -111,7 +117,8 @@ export function QuinticOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function QuinticInOut(k) {
   if ((k *= 2) < 1) return 0.5 * k * k * k * k * k;
@@ -120,7 +127,8 @@ export function QuinticInOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function SinusoidalIn(k) {
   if (k === 0) return 0;
@@ -130,7 +138,8 @@ export function SinusoidalIn(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function SinusoidalOut(k) {
   if (k === 0) return 0;
@@ -140,7 +149,8 @@ export function SinusoidalOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function SinusoidalInOut(k) {
   if (k === 0) return 0;
@@ -150,7 +160,8 @@ export function SinusoidalInOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function ExponentialIn(k) {
   return k === 0 ? 0 : Math.pow(1024, k - 1);
@@ -158,7 +169,8 @@ export function ExponentialIn(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function ExponentialOut(k) {
   return k === 1 ? 1 : 1 - Math.pow(2, -10 * k);
@@ -166,7 +178,8 @@ export function ExponentialOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function ExponentialInOut(k) {
   if (k === 0) return 0;
@@ -177,7 +190,8 @@ export function ExponentialInOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function CircularIn(k) {
   return 1 - Math.sqrt(1 - k * k);
@@ -185,7 +199,8 @@ export function CircularIn(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function CircularOut(k) {
   return Math.sqrt(1 - (--k * k));
@@ -193,7 +208,8 @@ export function CircularOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function CircularInOut(k) {
   if ((k *= 2) < 1) return -0.5 * (Math.sqrt(1 - k * k) - 1);
@@ -202,7 +218,8 @@ export function CircularInOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function ElasticIn(k) {
   let s;
@@ -220,7 +237,8 @@ export function ElasticIn(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function ElasticOut(k) {
   let s;
@@ -238,7 +256,8 @@ export function ElasticOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function ElasticInOut(k) {
   let s;
@@ -257,7 +276,8 @@ export function ElasticInOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function BackIn(k) {
   const s = 1.70158;
@@ -266,7 +286,8 @@ export function BackIn(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function BackOut(k) {
   const s = 1.70158;
@@ -275,7 +296,8 @@ export function BackOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function BackInOut(k) {
   const s = 1.70158 * 1.525;
@@ -285,7 +307,8 @@ export function BackInOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function BounceOut(k) {
   if (k < (1 / 2.75)) {
@@ -300,7 +323,8 @@ export function BounceOut(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function BounceIn(k) {
   return 1 - BounceOut(1 - k);
@@ -308,7 +332,8 @@ export function BounceIn(k) {
 
 /**
  *
- * @param k
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function BounceInOut(k) {
   if (k < 0.5) return BounceIn(k * 2) * 0.5;

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

@@ -8,7 +8,7 @@ import { GEOM_POLYGON, GEOM_RECTANGLE, GEOM_CIRCLE, GEOM_ELLIPSE, GEOM_ROUNDED_R
 
 /**
  *
- * @param graphics
+ * @param {object} graphics TBD
  */
 export function updateGraphicsTint(graphics) {
   if (graphics.tint === 0xFFFFFF) {
@@ -28,8 +28,8 @@ export function updateGraphicsTint(graphics) {
 
 /**
  *
- * @param graphics
- * @param context
+ * @param {object} graphics TBD
+ * @param {object} context TBD
  */
 export function renderGraphics(graphics, context) {
   const worldAlpha = graphics.worldAlpha;
@@ -157,8 +157,8 @@ export function renderGraphics(graphics, context) {
 
 /**
  *
- * @param graphics
- * @param context
+ * @param {object} graphics TBD
+ * @param {object} context TBD
  */
 export function renderGraphicsMask(graphics, context) {
   const len = graphics.graphicsData.length;

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

@@ -8,8 +8,8 @@ import { renderGraphicsMask } from './graphics';
 
 /**
  *
- * @param maskData
- * @param renderSession
+ * @param {object} maskData TBD
+ * @param {object} renderSession TBD
  */
 export function pushMask(maskData, renderSession) {
   const context = renderSession.context;
@@ -32,7 +32,7 @@ export function pushMask(maskData, renderSession) {
 
 /**
  *
- * @param renderSession
+ * @param {object} renderSession TBD
  */
 export function popMask(renderSession) {
   renderSession.context.restore();

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

@@ -7,6 +7,7 @@
 
 /**
  *
+ * @returns {object} TBD
  */
 export function getPool() {
   if (!window.PhaserRegistry) {
@@ -20,6 +21,7 @@ export function getPool() {
 
 /**
  *
+ * @returns {object} TBD
  */
 export function getFirst() {
   const pool = getPool();
@@ -33,7 +35,7 @@ export function getFirst() {
 
 /**
  *
- * @param parent
+ * @param {object} parent TBD
  */
 export function remove(parent) {
   const pool = getPool();
@@ -48,7 +50,7 @@ export function remove(parent) {
 
 /**
  *
- * @param canvas
+ * @param {object} canvas TBD
  */
 export function removeByCanvas(canvas) {
   const pool = getPool();
@@ -63,6 +65,7 @@ export function removeByCanvas(canvas) {
 
 /**
  *
+ * @returns {number} TBD
  */
 export function getTotal() {
   const pool = getPool();
@@ -77,6 +80,7 @@ export function getTotal() {
 
 /**
  *
+ * @returns {number} TBD
  */
 export function getFree() {
   const pool = getPool();
@@ -91,9 +95,10 @@ export function getFree() {
 
 /**
  *
- * @param parent
- * @param width
- * @param height
+ * @param {object} parent TBD
+ * @param {number} width TBD
+ * @param {number} height TBD
+ * @returns {object} TBD
  */
 export function create(parent, width, height) {
   if (parent === undefined) {

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

@@ -10,8 +10,9 @@ import { hex2rgb } from '../../util/math';
 
 /**
  *
- * @param sprite
- * @param color
+ * @param {object} sprite TBD
+ * @param {object} color TBD
+ * @returns {object} TBD
  */
 export function getTintedTexture(sprite, color) {
   const canvas = sprite.tintedTexture || create('CanvasTinter');
@@ -21,9 +22,9 @@ export function getTintedTexture(sprite, color) {
 
 /**
  *
- * @param texture
- * @param color
- * @param canvas
+ * @param {object} texture TBD
+ * @param {object} color TBD
+ * @param {object} canvas TBD
  */
 export function tintWithMultiply(texture, color, canvas) {
   const context = canvas.getContext('2d');
@@ -43,9 +44,9 @@ export function tintWithMultiply(texture, color, canvas) {
 
 /**
  *
- * @param texture
- * @param color
- * @param canvas
+ * @param {object} texture TBD
+ * @param {object} color TBD
+ * @param {object} canvas TBD
  */
 export function tintWithPerPixel(texture, color, canvas) {
   const context = canvas.getContext('2d');
@@ -77,6 +78,7 @@ export function tintWithPerPixel(texture, color, canvas) {
 
 /**
  *
+ * @returns {boolean} TBD
  */
 export function checkInverseAlpha() {
   const canvas = new CanvasBuffer(2, 1);
@@ -98,6 +100,7 @@ export function checkInverseAlpha() {
 
 /**
  *
+ * @returns {boolean} TBD
  */
 export function canUseNewCanvasBlendModes() {
   if (document === undefined) {
@@ -123,7 +126,7 @@ export function canUseNewCanvasBlendModes() {
 }
 
 /**
- *
+ * TBD
  */
 export function detectCapabilities() {
   if (!window.PhaserRegistry) {

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

@@ -8,11 +8,12 @@ import { create as createCanvas } from './pool';
 
 /**
  *
- * @param parent
- * @param width
- * @param height
- * @param id
- * @param skipPool
+ * @param {object} parent TBD
+ * @param {number} width TBD
+ * @param {number} height TBD
+ * @param {string} id TBD
+ * @param {boolean} skipPool TBD
+ * @returns {object} TBD
  */
 export function create(parent, width, height, id, skipPool) {
   width = width || 256;
@@ -29,8 +30,9 @@ export function create(parent, width, height, id, skipPool) {
 
 /**
  *
- * @param canvas
- * @param color
+ * @param {object} canvas TBD
+ * @param {string} color TBD
+ * @returns {object} TBD
  */
 export function setBackgroundColor(canvas, color) {
   color = color || 'rgb(0,0,0)';
@@ -40,8 +42,9 @@ export function setBackgroundColor(canvas, color) {
 
 /**
  *
- * @param canvas
- * @param value
+ * @param {object} canvas TBD
+ * @param {string} value TBD
+ * @returns {object} TBD
  */
 export function setTouchAction(canvas, value) {
   value = value || 'none';
@@ -53,8 +56,9 @@ export function setTouchAction(canvas, value) {
 
 /**
  *
- * @param canvas
- * @param value
+ * @param {object} canvas TBD
+ * @param {string} value TBD
+ * @returns {object} TBD
  */
 export function setUserSelect(canvas, value) {
   value = value || 'none';
@@ -70,9 +74,10 @@ export function setUserSelect(canvas, value) {
 
 /**
  *
- * @param canvas
- * @param parent
- * @param overflowHidden
+ * @param {object} canvas TBD
+ * @param {object} parent TBD
+ * @param {boolean} overflowHidden TBD
+ * @returns {object} TBD
  */
 export function addToDOM(canvas, parent, overflowHidden = true) {
   let target;
@@ -98,7 +103,7 @@ export function addToDOM(canvas, parent, overflowHidden = true) {
 
 /**
  *
- * @param canvas
+ * @param {object} canvas TBD
  */
 export function removeFromDOM(canvas) {
   if (canvas.parentNode) {
@@ -108,13 +113,14 @@ export function removeFromDOM(canvas) {
 
 /**
  *
- * @param context
- * @param translateX
- * @param translateY
- * @param scaleX
- * @param scaleY
- * @param skewX
- * @param skewY
+ * @param {object} context TBD
+ * @param {number} translateX TBD
+ * @param {number} translateY TBD
+ * @param {number} scaleX TBD
+ * @param {number} scaleY TBD
+ * @param {number} skewX TBD
+ * @param {number} skewY TBD
+ * @returns {object} TBD
  */
 export function setTransform(context, translateX, translateY, scaleX, scaleY, skewX, skewY) {
   context.setTransform(scaleX, skewX, skewY, scaleY, translateX, translateY);
@@ -123,7 +129,8 @@ export function setTransform(context, translateX, translateY, scaleX, scaleY, sk
 
 /**
  *
- * @param context
+ * @param {object} context TBD
+ * @returns {object} TBD
  */
 export function getSmoothingPrefix(context) {
   const VENDORS = ['i', 'webkitI', 'msI', 'mozI', 'oI'];
@@ -139,8 +146,9 @@ export function getSmoothingPrefix(context) {
 
 /**
  *
- * @param context
- * @param value
+ * @param {object} context TBD
+ * @param {number} value TBD
+ * @returns {object} TBD
  */
 export function setSmoothingEnabled(context, value) {
   const s = getSmoothingPrefix(context);

package/src/phaser/display/graphics_data_util.js

@@ -7,7 +7,8 @@ import GraphicsData from './graphics_data';
 
 /**
  *
- * @param source
+ * @param {object} source TBD
+ * @returns {object} TBD
  */
 export function clone(source) {
   return new GraphicsData(source.lineWidth, source.lineColor, source.lineAlpha, source.fillColor, source.fillAlpha, source.fill, source.shape);

package/src/phaser/display/sprite_util.js

@@ -9,9 +9,9 @@ import { SCALE_LINEAR } from '../core/const';
 
 /**
  *
- * @param target
- * @param texture
- * @param destroyBase
+ * @param {object} target TBD
+ * @param {object} texture TBD
+ * @param {boolean} destroyBase TBD
  */
 export function setTexture(target, texture, destroyBase = false) {
   if (destroyBase) {
@@ -25,8 +25,9 @@ export function setTexture(target, texture, destroyBase = false) {
 
 /**
  *
- * @param target
- * @param matrix
+ * @param {object} target TBD
+ * @param {object} matrix TBD
+ * @returns {object} TBD
  */
 export function getBounds(target, matrix = null) {
   // TODO verify
@@ -107,7 +108,8 @@ export function getBounds(target, matrix = null) {
 
 /**
  *
- * @param target
+ * @param {object} target TBD
+ * @returns {object} TBD
  */
 export function getLocalBounds(target) {
   const matrixCache = target.worldTransform;
@@ -126,9 +128,9 @@ export function getLocalBounds(target) {
 
 /**
  *
- * @param target
- * @param renderSession
- * @param matrix
+ * @param {object} target TBD
+ * @param {object} renderSession TBD
+ * @param {object} matrix TBD
  */
 export function renderWebGL(target, renderSession, matrix) {
   // if the sprite is not visible or the alpha is 0 then no need to render this element
@@ -175,9 +177,9 @@ export function renderWebGL(target, renderSession, matrix) {
 
 /**
  *
- * @param target
- * @param renderSession
- * @param matrix
+ * @param {object} target TBD
+ * @param {object} renderSession TBD
+ * @param {object} matrix TBD
  */
 export function renderCanvas(target, renderSession, matrix) {
   // If the sprite is not visible or the alpha is 0 then no need to render this element