melonjs 10.1.0 → 10.2.2

package/src/tweens/tween.js

@@ -5,9 +5,9 @@ import { Easing } from "./easing.js";
 import { Interpolation } from "./interpolation.js";
 
 /**
-* Tween.js - Licensed under the MIT license
-* https://github.com/tweenjs/tween.js
-*/
+ * Tween.js - Licensed under the MIT license
+ * https://github.com/tweenjs/tween.js
+ */
 
 /**
  * @classdesc
@@ -25,7 +25,7 @@ import { Interpolation } from "./interpolation.js";
  * @class Tween
  * @memberOf me
  * @constructor
- * @param {Object} object object on which to apply the tween
+ * @param {object} object object on which to apply the tween
  * @example
  * // add a tween to change the object pos.x and pos.y variable to 200 in 3 seconds
  * tween = new me.Tween(myObject.pos).to({
@@ -124,15 +124,16 @@ class Tween {
      * @memberOf me.Tween
      * @public
      * @function
-     * @param {Object} properties hash of properties
-     * @param {Object|Number} [options] object of tween properties, or a duration if a numeric value is passed
-     * @param {Number} [options.duration] tween duration
+     * @param {object} properties hash of properties
+     * @param {object|number} [options] object of tween properties, or a duration if a numeric value is passed
+     * @param {number} [options.duration] tween duration
      * @param {me.Tween.Easing} [options.easing] easing function
-     * @param {Number} [options.delay] delay amount expressed in milliseconds
-     * @param {Boolean} [options.yoyo] allows the tween to bounce back to their original value when finished. To be used together with repeat to create endless loops.
-     * @param {Number} [options.repeat] amount of times the tween should be repeated
+     * @param {number} [options.delay] delay amount expressed in milliseconds
+     * @param {boolean} [options.yoyo] allows the tween to bounce back to their original value when finished. To be used together with repeat to create endless loops.
+     * @param {number} [options.repeat] amount of times the tween should be repeated
      * @param {me.Tween.Interpolation} [options.interpolation] interpolation function
-     * @param {Boolean} [options.autoStart] allow this tween to start automatically. Otherwise call me.Tween.start().
+     * @param {boolean} [options.autoStart] allow this tween to start automatically. Otherwise call me.Tween.start().
+     * @returns {me.Tween} this instance for object chaining
      */
     to( properties, options ) {
 
@@ -157,7 +158,6 @@ class Tween {
         }
 
         return this;
-
     }
 
     /**
@@ -166,6 +166,8 @@ class Tween {
      * @memberOf me.Tween
      * @public
      * @function
+     * @param {number} [time] the current time when the tween was started
+     * @returns {me.Tween} this instance for object chaining
      */
     start( time = timer.getTime() ) {
 
@@ -203,7 +205,6 @@ class Tween {
         }
 
         return this;
-
     }
 
     /**
@@ -212,6 +213,7 @@ class Tween {
      * @memberOf me.Tween
      * @public
      * @function
+     * @returns {me.Tween} this instance for object chaining
      */
     stop() {
         // remove the tween from the world container
@@ -225,7 +227,8 @@ class Tween {
      * @memberOf me.Tween
      * @public
      * @function
-     * @param {Number} amount delay amount expressed in milliseconds
+     * @param {number} amount delay amount expressed in milliseconds
+     * @returns {me.Tween} this instance for object chaining
      */
     delay( amount ) {
 
@@ -240,7 +243,8 @@ class Tween {
      * @memberOf me.Tween
      * @public
      * @function
-     * @param {Number} times amount of times the tween should be repeated
+     * @param {number} times amount of times the tween should be repeated
+     * @returns {me.Tween} this instance for object chaining
      */
     repeat( times ) {
 
@@ -257,7 +261,8 @@ class Tween {
      * @public
      * @function
      * @see me.Tween#repeat
-     * @param {Boolean} yoyo
+     * @param {boolean} yoyo
+     * @returns {me.Tween} this instance for object chaining
      */
     yoyo( yoyo ) {
 
@@ -272,7 +277,8 @@ class Tween {
      * @memberOf me.Tween
      * @public
      * @function
-     * @param {me.Tween.Easing} fn easing function
+     * @param {me.Tween.Easing} easing easing function
+     * @returns {me.Tween} this instance for object chaining
      */
     easing( easing ) {
         if (typeof easing !== "function") {
@@ -280,7 +286,6 @@ class Tween {
         }
         this._easingFunction = easing;
         return this;
-
     }
 
     /**
@@ -289,7 +294,8 @@ class Tween {
      * @memberOf me.Tween
      * @public
      * @function
-     * @param {me.Tween.Interpolation} fn interpolation function
+     * @param {me.Tween.Interpolation} interpolation interpolation function
+     * @returns {me.Tween} this instance for object chaining
      */
     interpolation( interpolation ) {
         this._interpolationFunction = interpolation;
@@ -302,9 +308,10 @@ class Tween {
      * @memberOf me.Tween
      * @public
      * @function
-     * @param {me.Tween} chainedTween Tween to be chained
+     * @param {...me.Tween} chainedTween Tween(s) to be chained
+     * @returns {me.Tween} this instance for object chaining
      */
-    chain() {
+    chain( chainedTween ) {
         this._chainedTweens = arguments;
         return this;
     }
@@ -316,9 +323,10 @@ class Tween {
      * @public
      * @function
      * @param {Function} onStartCallback callback
+     * @returns {me.Tween} this instance for object chaining
      */
-    onStart( callback ) {
-        this._onStartCallback = callback;
+    onStart( onStartCallback ) {
+        this._onStartCallback = onStartCallback;
         return this;
     }
 
@@ -329,9 +337,10 @@ class Tween {
      * @public
      * @function
      * @param {Function} onUpdateCallback callback
+     * @returns {me.Tween} this instance for object chaining
      */
-    onUpdate( callback ) {
-        this._onUpdateCallback = callback;
+    onUpdate( onUpdateCallback ) {
+        this._onUpdateCallback = onUpdateCallback;
         return this;
     }
 
@@ -342,9 +351,10 @@ class Tween {
      * @public
      * @function
      * @param {Function} onCompleteCallback callback
+     * @returns {me.Tween} this instance for object chaining
      */
-    onComplete( callback ) {
-        this._onCompleteCallback = callback;
+    onComplete( onCompleteCallback ) {
+        this._onCompleteCallback = onCompleteCallback;
         return this;
     };
 

package/src/utils/agent.js

@@ -17,9 +17,9 @@ var vendors = [ "ms", "MS", "moz", "webkit", "o" ];
  * @public
  * @name prefixed
  * @function
- * @param {String} name Property name
- * @param {Object} [obj=window] Object or element reference to access
- * @return {Mixed} Value of property
+ * @param {string} name Property name
+ * @param {object} [obj=window] Object or element reference to access
+ * @returns {string} Value of property
  * @memberOf me.utils.agent
  */
 export function prefixed(name, obj) {
@@ -43,10 +43,10 @@ export function prefixed(name, obj) {
  * @public
  * @name setPrefixed
  * @function
- * @param {String} name Property name
- * @param {Mixed} value Property value
- * @param {Object} [obj=window] Object or element reference to access
- * @return true if one of the vendor-prefixed property was found
+ * @param {string} name Property name
+ * @param {string} value Property value
+ * @param {object} [obj=window] Object or element reference to access
+ * @returns {boolean} true if one of the vendor-prefixed property was found
  * @memberOf me.utils.agent
  */
 export function setPrefixed(name, value, obj) {
@@ -64,6 +64,7 @@ export function setPrefixed(name, value, obj) {
             obj[name] = value;
             return true;
         }
-        return false;
     });
+
+    return false;
 };

package/src/utils/array.js

@@ -13,8 +13,8 @@ import {random as mathRandom, weightedRandom as mathWeightedRandom} from "./../m
  * @memberOf me.utils.array
  * @name remove
  * @param {Array} arr array from which to remove an object
- * @param {Object} object to be removed
- * @return {Array} the modified Array
+ * @param {object} obj to be removed
+ * @returns {Array} the modified Array
  * var arr = [ "foo", "bar", "baz" ];
  * // remove "foo" from the array
  * me.utils.array.remove(arr, "foo");
@@ -34,7 +34,7 @@ export function remove(arr, obj) {
  * @memberOf me.utils.array
  * @name random
  * @param {Array} arr array to pick a element
- * @return {any} random member of array
+ * @returns {any} random member of array
  * @example
  * // Select a random array element
  * var arr = [ "foo", "bar", "baz" ];
@@ -51,7 +51,7 @@ export function random(arr) {
  * @memberOf me.utils.array
  * @name weightedRandom
  * @param {Array} arr array to pick a element
- * @return {any} random member of array
+ * @returns {any} random member of array
  */
 export function weightedRandom(arr) {
     return arr[mathWeightedRandom(0, arr.length)];

package/src/utils/file.js

@@ -16,8 +16,8 @@ const REMOVE_EXT = /\.[^\.]*$/;
  * @function
  * @memberOf me.utils.file
  * @name getBasename
- * @param  {String} path path containing the filename
- * @return {String} the base name without path information.
+ * @param  {string} path path containing the filename
+ * @returns {string} the base name without path information.
  */
 export function getBasename(path) {
     return path.replace(REMOVE_PATH, "").replace(REMOVE_EXT, "");
@@ -29,8 +29,8 @@ export function getBasename(path) {
  * @function
  * @memberOf me.utils.file
  * @name getExtension
- * @param  {String} path path containing the filename
- * @return {String} filename extension.
+ * @param  {string} path path containing the filename
+ * @returns {string} filename extension.
  */
 export function getExtension(path) {
     return path.substring(path.lastIndexOf(".") + 1, path.length);

package/src/utils/function.js

@@ -4,17 +4,16 @@
  * @memberOf me
  */
 
-
 /**
  * Executes a function as soon as the interpreter is idle (stack empty).
  * @public
  * @function
  * @memberOf me.utils.function
  * @name defer
- * @param {Function} fn The function to be deferred.
- * @param {Object} thisArg The value to be passed as the this parameter to the target function when the deferred function is called
+ * @param {Function} func The function to be deferred.
+ * @param {object} thisArg The value to be passed as the this parameter to the target function when the deferred function is called
  * @param {...*} [args] Optional additional arguments to carry for the function.
- * @return {Number} id that can be used to clear the deferred function using
+ * @returns {number} id that can be used to clear the deferred function using
  * clearTimeout
  * @example
  * // execute myFunc() when the stack is empty,
@@ -33,8 +32,9 @@ export function defer(func, thisArg, ...args) {
  * @memberOf me.utils.function
  * @name throttle
  * @param {Function} fn the function to be throttled.
- * @param {Number} delay The delay in ms
+ * @param {number} delay The delay in ms
  * @param {no_trailing} no_trailing disable the execution on the trailing edge
+ * @returns {Function} the function that will be throttled
  */
 export function throttle(fn, delay, no_trailing) {
     var last = window.performance.now(), deferTimer;

package/src/utils/string.js

@@ -11,8 +11,8 @@
  * @function
  * @memberOf me.utils.string
  * @name capitalize
- * @param {String} string the string to be capitalized
- * @return {string} the capitalized string
+ * @param {string} str the string to be capitalized
+ * @returns {string} the capitalized string
  */
 export function capitalize(str) {
     return str.charAt(0).toUpperCase() + str.slice(1);
@@ -24,8 +24,8 @@ export function capitalize(str) {
  * @function
  * @memberOf me.utils.string
  * @name trimLeft
- * @param {String} string the string to be trimmed
- * @return {string} trimmed string
+ * @param {string} str the string to be trimmed
+ * @returns {string} trimmed string
  */
 export function trimLeft(str) {
     return str.replace(/^\s+/, "");
@@ -37,8 +37,8 @@ export function trimLeft(str) {
  * @function
  * @memberOf me.utils.string
  * @name trimRight
- * @param {String} string the string to be trimmed
- * @return {string} trimmed string
+ * @param {string} str the string to be trimmed
+ * @returns {string} trimmed string
  */
 export function trimRight(str) {
     return str.replace(/\s+$/, "");
@@ -50,8 +50,8 @@ export function trimRight(str) {
  * @function
  * @memberOf me.utils.string
  * @name isNumeric
- * @param {String} string the string to be tested
- * @return {Boolean} true if string contains only digits
+ * @param {string} str the string to be tested
+ * @returns {boolean} true if string contains only digits
  */
 export function isNumeric(str) {
     if (typeof str === "string") {
@@ -66,8 +66,8 @@ export function isNumeric(str) {
  * @function
  * @memberOf me.utils.string
  * @name isBoolean
- * @param {String} string the string to be tested
- * @return {Boolean} true if the string is either true or false
+ * @param {string} str the string to be tested
+ * @returns {boolean} true if the string is either true or false
  */
 export function isBoolean(str) {
     var trimmed = str.trim();
@@ -80,8 +80,8 @@ export function isBoolean(str) {
  * @function
  * @memberOf me.utils.string
  * @name toHex
- * @param {String} string the string to be converted
- * @return {String}
+ * @param {string} str the string to be converted
+ * @returns {string} the converted hexadecimal value
  */
 export function toHex(str) {
     var res = "", c = 0;

package/src/utils/utils.js

@@ -31,20 +31,20 @@ var utils = {
      * @function
      * @memberOf me.utils
      * @name getPixels
-     * @param {Image|Canvas} image Image to read
-     * @return {ImageData} Canvas ImageData object
+     * @param {HTMLImageElement|HTMLCanvasElement} image Image to read
+     * @returns {ImageData} ImageData object
      */
-    getPixels : function (arg) {
-        if (arg instanceof HTMLImageElement) {
+    getPixels : function (image) {
+        if (image instanceof HTMLImageElement) {
             var _context = CanvasRenderer.getContext2d(
-                createCanvas(arg.width, arg.height)
+                createCanvas(image.width, image.height)
             );
-            _context.drawImage(arg, 0, 0);
-            return _context.getImageData(0, 0, arg.width, arg.height);
+            _context.drawImage(image, 0, 0);
+            return _context.getImageData(0, 0, image.width, image.height);
         }
         else {
             // canvas !
-            return arg.getContext("2d").getImageData(0, 0, arg.width, arg.height);
+            return image.getContext("2d").getImageData(0, 0, image.width, image.height);
         }
     },
 
@@ -54,9 +54,9 @@ var utils = {
      * @function
      * @memberOf me.utils
      * @name checkVersion
-     * @param {String} first First version string to compare
-     * @param {String} [second=me.version] Second version string to compare
-     * @return {Number} comparison result <br>&lt; 0 : first &lt; second<br>
+     * @param {string} first First version string to compare
+     * @param {string} [second=me.version] Second version string to compare
+     * @returns {number} comparison result <br>&lt; 0 : first &lt; second<br>
      * 0 : first == second<br>
      * &gt; 0 : first &gt; second
      * @example
@@ -87,14 +87,14 @@ var utils = {
      * @function
      * @memberOf me.utils
      * @name getUriFragment
-     * @param {String} [url=document.location] an optional params string or URL containing fragment (hash) params to be parsed
-     * @return {Object} an object representing the deserialized params string.
-     * @property {Boolean} [hitbox=false] draw the hitbox in the debug panel (if enabled)
-     * @property {Boolean} [velocity=false] draw the entities velocity in the debug panel (if enabled)
-     * @property {Boolean} [quadtree=false] draw the quadtree in the debug panel (if enabled)
-     * @property {Boolean} [webgl=false] force the renderer to WebGL
-     * @property {Boolean} [debug=false] display the debug panel (if preloaded)
-     * @property {String} [debugToggleKey="s"] show/hide the debug panel (if preloaded)
+     * @param {string} [url=document.location] an optional params string or URL containing fragment (hash) params to be parsed
+     * @returns {object} an object representing the deserialized params string.
+     * @property {boolean} [hitbox=false] draw the hitbox in the debug panel (if enabled)
+     * @property {boolean} [velocity=false] draw the entities velocity in the debug panel (if enabled)
+     * @property {boolean} [quadtree=false] draw the quadtree in the debug panel (if enabled)
+     * @property {boolean} [webgl=false] force the renderer to WebGL
+     * @property {boolean} [debug=false] display the debug panel (if preloaded)
+     * @property {string} [debugToggleKey="s"] show/hide the debug panel (if preloaded)
      * @example
      * // http://www.example.com/index.html#debug&hitbox=true&mytag=value
      * var UriFragment = me.utils.getUriFragment();