@vpmedia/phaser 1.0.2 → 1.0.3

package/src/phaser/geom/util/rectangle.js

@@ -8,9 +8,10 @@ import Point from '../point';
 
 /**
  *
- * @param a
- * @param dx
- * @param dy
+ * @param {object} a TBD
+ * @param {number} dx TBD
+ * @param {number} dy TBD
+ * @returns {object} TBD
  */
 export function inflate(a, dx, dy) {
   a.x -= dx;
@@ -22,8 +23,9 @@ export function inflate(a, dx, dy) {
 
 /**
  *
- * @param a
- * @param point
+ * @param {object} a TBD
+ * @param {object} point TBD
+ * @returns {object} TBD
  */
 export function inflatePoint(a, point) {
   return inflate(a, point.x, point.y);
@@ -31,8 +33,9 @@ export function inflatePoint(a, point) {
 
 /**
  *
- * @param a
- * @param output
+ * @param {object} a TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function size(a, output = null) {
   const result = output || new Point();
@@ -42,8 +45,9 @@ export function size(a, output = null) {
 
 /**
  *
- * @param input
- * @param output
+ * @param {object} input TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function clone(input, output = null) {
   const result = output || new Rectangle();
@@ -53,9 +57,10 @@ export function clone(input, output = null) {
 
 /**
  *
- * @param a
- * @param x
- * @param y
+ * @param {object} a TBD
+ * @param {number} x TBD
+ * @param {number} y TBD
+ * @returns {boolean} TBD
  */
 export function contains(a, x, y) {
   if (a.width <= 0 || a.height <= 0) {
@@ -66,12 +71,13 @@ export function contains(a, x, y) {
 
 /**
  *
- * @param rx
- * @param ry
- * @param rw
- * @param rh
- * @param x
- * @param y
+ * @param {number} rx TBD
+ * @param {number} ry TBD
+ * @param {number} rw TBD
+ * @param {number} rh TBD
+ * @param {number} x TBD
+ * @param {number} y TBD
+ * @returns {boolean} TBD
  */
 export function containsRaw(rx, ry, rw, rh, x, y) {
   return (x >= rx && x < (rx + rw) && y >= ry && y < (ry + rh));
@@ -79,8 +85,9 @@ export function containsRaw(rx, ry, rw, rh, x, y) {
 
 /**
  *
- * @param a
- * @param point
+ * @param {object} a TBD
+ * @param {object} point TBD
+ * @returns {boolean} TBD
  */
 export function containsPoint(a, point) {
   return contains(a, point.x, point.y);
@@ -88,8 +95,9 @@ export function containsPoint(a, point) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {boolean} TBD
  */
 export function containsRect(a, b) {
   if (a.volume > b.volume) {
@@ -100,8 +108,9 @@ export function containsRect(a, b) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {boolean} TBD
  */
 export function equals(a, b) {
   return (a.x === b.x && a.y === b.y && a.width === b.width && a.height === b.height);
@@ -109,8 +118,9 @@ export function equals(a, b) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {boolean} TBD
  */
 export function sameDimensions(a, b) {
   return (a.width === b.width && a.height === b.height);
@@ -118,8 +128,9 @@ export function sameDimensions(a, b) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {boolean} TBD
  */
 export function intersects(a, b) {
   if (a.width <= 0 || a.height <= 0 || b.width <= 0 || b.height <= 0) {
@@ -130,9 +141,10 @@ export function intersects(a, b) {
 
 /**
  *
- * @param a
- * @param b
- * @param output
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function intersection(a, b, output = null) {
   const result = output || new Rectangle();
@@ -147,12 +159,13 @@ export function intersection(a, b, output = null) {
 
 /**
  *
- * @param a
- * @param left
- * @param right
- * @param top
- * @param bottom
- * @param tolerance
+ * @param {object} a TBD
+ * @param {number} left TBD
+ * @param {number} right TBD
+ * @param {number} top TBD
+ * @param {number} bottom TBD
+ * @param {number} tolerance TBD
+ * @returns {boolean} TBD
  */
 export function intersectsRaw(a, left, right, top, bottom, tolerance = 0) {
   return !(left > a.right + tolerance || right < a.left - tolerance || top > a.bottom + tolerance || bottom < a.top - tolerance);
@@ -160,9 +173,10 @@ export function intersectsRaw(a, left, right, top, bottom, tolerance = 0) {
 
 /**
  *
- * @param a
- * @param b
- * @param output
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function union(a, b, output = null) {
   const result = output || new Rectangle();
@@ -171,8 +185,9 @@ export function union(a, b, output = null) {
 
 /**
  *
- * @param points
- * @param output
+ * @param {object[]} points TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function aabb(points, output = null) {
   const result = output || new Rectangle();
@@ -199,7 +214,9 @@ export function aabb(points, output = null) {
 }
 
 /**
+ * TBD
  *
+ * @returns {object} TBD
  */
 export function getEmptyRectangle() {
   if (!window.PhaserRegistry) {

package/src/phaser/geom/util/rounded_rectangle.js

@@ -6,7 +6,10 @@
 import RoundedRectangle from '../rounded_rectangle';
 
 /**
+ * TBD
  *
+ * @deprecated
+ * @returns {boolean} TBD
  */
 export default function () {
   return true;
@@ -14,8 +17,9 @@ export default function () {
 
 /**
  *
- * @param input
- * @param output
+ * @param {object} input TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function clone(input, output = null) {
   const result = output || new RoundedRectangle();

package/src/phaser/util/math.js

@@ -9,7 +9,8 @@ export const PI_2 = Math.PI * 2;
 
 /**
  *
- * @param hex
+ * @param {number} hex TBD
+ * @returns {number[]} TBD
  */
 export function hex2rgb(hex) {
   return [(hex >> 16 & 0xFF) / 255, (hex >> 8 & 0xFF) / 255, (hex & 0xFF) / 255];
@@ -17,7 +18,8 @@ export function hex2rgb(hex) {
 
 /**
  *
- * @param rgb
+ * @param {number} rgb TBD
+ * @returns {number} TBD
  */
 export function rgb2hex(rgb) {
   return ((rgb[0] * 255 << 16) + (rgb[1] * 255 << 8) + rgb[2] * 255);
@@ -25,7 +27,8 @@ export function rgb2hex(rgb) {
 
 /**
  *
- * @param value
+ * @param {number} value TBD
+ * @returns {number} TBD
  */
 export function getNextPowerOfTwo(value) {
   // see: https://en.wikipedia.org/wiki/Power_of_two#Fast_algorithm_to_check_if_a_positive_number_is_a_power_of_two
@@ -41,8 +44,9 @@ export function getNextPowerOfTwo(value) {
 
 /**
  *
- * @param width
- * @param height
+ * @param {number} width TBD
+ * @param {number} height TBD
+ * @returns {boolean} TBD
  */
 export function isPowerOfTwo(width, height) {
   return (width > 0 && (width & (width - 1)) === 0 && height > 0 && (height & (height - 1)) === 0);
@@ -50,7 +54,8 @@ export function isPowerOfTwo(width, height) {
 
 /**
  *
- * @param degrees
+ * @param {number} degrees TBD
+ * @returns {number} TBD
  */
 export function degToRad(degrees) {
   return degrees * DEG_TO_RAD;
@@ -58,7 +63,8 @@ export function degToRad(degrees) {
 
 /**
  *
- * @param radians
+ * @param {number} radians TBD
+ * @returns {number} TBD
  */
 export function radToDeg(radians) {
   return radians * RAD_TO_DEG;
@@ -66,8 +72,9 @@ export function radToDeg(radians) {
 
 /**
  *
- * @param min
- * @param max
+ * @param {number} min TBD
+ * @param {number} max TBD
+ * @returns {number} TBD
  */
 export function between(min, max) {
   return Math.floor(Math.random() * (max - min + 1) + min);
@@ -75,9 +82,10 @@ export function between(min, max) {
 
 /**
  *
- * @param input
- * @param gap
- * @param start
+ * @param {number} input TBD
+ * @param {number} gap TBD
+ * @param {number} start TBD
+ * @returns {number} TBD
  */
 export function snapToCeil(input, gap = 0, start = 0) {
   if (gap === 0) {
@@ -90,9 +98,10 @@ export function snapToCeil(input, gap = 0, start = 0) {
 
 /**
  *
- * @param value
- * @param min
- * @param max
+ * @param {number} value TBD
+ * @param {number} min TBD
+ * @param {number} max TBD
+ * @returns {number} TBD
  */
 export function wrap(value, min, max) {
   const range = max - min;
@@ -108,9 +117,10 @@ export function wrap(value, min, max) {
 
 /**
  *
- * @param p0
- * @param p1
- * @param t
+ * @param {number} p0 TBD
+ * @param {number} p1 TBD
+ * @param {number} t TBD
+ * @returns {number} TBD
  */
 export function linear(p0, p1, t) {
   return (p1 - p0) * t + p0;
@@ -118,8 +128,9 @@ export function linear(p0, p1, t) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {number} a TBD
+ * @param {number} b TBD
+ * @returns {number} TBD
  */
 export function difference(a, b) {
   return Math.abs(a - b);
@@ -127,8 +138,9 @@ export function difference(a, b) {
 
 /**
  *
- * @param v
- * @param k
+ * @param {number[]} v TBD
+ * @param {number} k TBD
+ * @returns {number} TBD
  */
 export function linearInterpolation(v, k) {
   const m = v.length - 1;
@@ -145,10 +157,11 @@ export function linearInterpolation(v, k) {
 
 /**
  *
- * @param x1
- * @param y1
- * @param x2
- * @param y2
+ * @param {number} x1 TBD
+ * @param {number} y1 TBD
+ * @param {number} x2 TBD
+ * @param {number} y2 TBD
+ * @returns {number} TBD
  */
 export function distance(x1, y1, x2, y2) {
   const dx = x1 - x2;
@@ -158,9 +171,10 @@ export function distance(x1, y1, x2, y2) {
 
 /**
  *
- * @param a
- * @param b
- * @param tolerance
+ * @param {number} a TBD
+ * @param {number} b TBD
+ * @param {number} tolerance TBD
+ * @returns {boolean} TBD
  */
 export function within(a, b, tolerance) {
   return (Math.abs(a - b) <= tolerance);
@@ -168,10 +182,11 @@ export function within(a, b, tolerance) {
 
 /**
  *
- * @param a
- * @param r
- * @param g
- * @param b
+ * @param {number} a TBD
+ * @param {number} r TBD
+ * @param {number} g TBD
+ * @param {number} b TBD
+ * @returns {number} TBD
  */
 export function getColor32(a, r, g, b) {
   return a << 24 | r << 16 | g << 8 | b;
@@ -179,9 +194,10 @@ export function getColor32(a, r, g, b) {
 
 /**
  *
- * @param r
- * @param g
- * @param b
+ * @param {number} r TBD
+ * @param {number} g TBD
+ * @param {number} b TBD
+ * @returns {number} TBD
  */
 export function getColor(r, g, b) {
   return r << 16 | g << 8 | b;
@@ -189,8 +205,8 @@ export function getColor(r, g, b) {
 
 /**
  *
- * @param value
- * @param out
+ * @param {number} value TBD
+ * @param {object} out TBD
  */
 export function hexToColor(value, out) {
   // Expand shorthand form (e.g. "03F") to full form (e.g. "0033FF")
@@ -205,8 +221,8 @@ export function hexToColor(value, out) {
 
 /**
  *
- * @param value
- * @param out
+ * @param {number} value TBD
+ * @param {object} out TBD
  */
 export function webToColor(value, out) {
   const result = /^rgba?\(\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*(?:,\s*(\d+(?:\.\d+)?))?\s*\)$/.exec(value);
@@ -220,7 +236,8 @@ export function webToColor(value, out) {
 
 /**
  *
- * @param color
+ * @param {number} color TBD
+ * @returns {object} TBD
  */
 export function getRGB(color) {
   if (color > 16777215) {
@@ -250,8 +267,9 @@ export function getRGB(color) {
 
 /**
  *
- * @param value
- * @param out
+ * @param {number} value TBD
+ * @param {object} out TBD
+ * @returns {object} TBD
  */
 export function valueToColor(value, out) {
   if (typeof value === 'string') {

package/src/phaser/util/string.js

@@ -5,21 +5,27 @@
  */
 
 /**
+ * TBD
  *
+ * @returns {string} TBD
  */
 export function generateID() {
   return (((1 + Math.random()) * 0x10000) | 0).toString(16).substring(1);
 }
 
 /**
+ * TBD
  *
+ * @returns {string} TBD
  */
 export function generateUUID() {
   return (`${generateID()}${generateID()}-${generateID()}-4${generateID().substr(0, 3)}-${generateID()}-${generateID()}${generateID()}${generateID()}`).toLowerCase();
 }
 
 /**
+ * TBD
  *
+ * @returns {string} TBD
  */
 export function generateShaderID() {
   return (`${generateID()}${generateID()}-${generateID()}`).toLowerCase();