melonjs 10.3.0 → 10.4.0

package/src/tweens/tween.js

@@ -22,23 +22,22 @@ import { Interpolation } from "./interpolation.js";
  * author Paul Lewis / http://www.aerotwist.com/<br>
  * author lechecacharro<br>
  * author Josh Faul / http://jocafa.com/
- * @class Tween
- * @memberof me
- * @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({
- *       x: 200,
- *       y: 200,
- *    }, {
- *       duration: 3000,
- *       easing: me.Tween.Easing.Bounce.Out,
- *       autoStart : true
- * }).onComplete(myFunc);
  */
 class Tween {
 
-    // constructor
+    /**
+     * @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({
+     *       x: 200,
+     *       y: 200,
+     *    }, {
+     *       duration: 3000,
+     *       easing: me.Tween.Easing.Bounce.Out,
+     *       autoStart : true
+     * }).onComplete(myFunc);
+     */
     constructor ( object ) {
         this.setProperties(object);
     }
@@ -120,19 +119,19 @@ class Tween {
     /**
      * object properties to be updated and duration
      * @name to
-     * @memberof me.Tween
+     * @memberof 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 {me.Tween.Easing} [options.easing] easing function
+     * @param {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 {me.Tween.Interpolation} [options.interpolation] interpolation function
+     * @param {Tween.Interpolation} [options.interpolation] interpolation function
      * @param {boolean} [options.autoStart] allow this tween to start automatically. Otherwise call me.Tween.start().
-     * @returns {me.Tween} this instance for object chaining
+     * @returns {Tween} this instance for object chaining
      */
     to( properties, options ) {
 
@@ -162,11 +161,11 @@ class Tween {
     /**
      * start the tween
      * @name start
-     * @memberof me.Tween
+     * @memberof Tween
      * @public
      * @function
      * @param {number} [time] the current time when the tween was started
-     * @returns {me.Tween} this instance for object chaining
+     * @returns {Tween} this instance for object chaining
      */
     start( time = timer.getTime() ) {
 
@@ -209,10 +208,10 @@ class Tween {
     /**
      * stop the tween
      * @name stop
-     * @memberof me.Tween
+     * @memberof Tween
      * @public
      * @function
-     * @returns {me.Tween} this instance for object chaining
+     * @returns {Tween} this instance for object chaining
      */
     stop() {
         // remove the tween from the world container
@@ -223,11 +222,11 @@ class Tween {
     /**
      * delay the tween
      * @name delay
-     * @memberof me.Tween
+     * @memberof Tween
      * @public
      * @function
      * @param {number} amount delay amount expressed in milliseconds
-     * @returns {me.Tween} this instance for object chaining
+     * @returns {Tween} this instance for object chaining
      */
     delay( amount ) {
 
@@ -239,11 +238,11 @@ class Tween {
     /**
      * Repeat the tween
      * @name repeat
-     * @memberof me.Tween
+     * @memberof Tween
      * @public
      * @function
      * @param {number} times amount of times the tween should be repeated
-     * @returns {me.Tween} this instance for object chaining
+     * @returns {Tween} this instance for object chaining
      */
     repeat( times ) {
 
@@ -256,12 +255,12 @@ class Tween {
      * Allows the tween to bounce back to their original value when finished.
      * To be used together with repeat to create endless loops.
      * @name yoyo
-     * @memberof me.Tween
+     * @memberof Tween
      * @public
      * @function
-     * @see me.Tween#repeat
+     * @see Tween#repeat
      * @param {boolean} yoyo
-     * @returns {me.Tween} this instance for object chaining
+     * @returns {Tween} this instance for object chaining
      */
     yoyo( yoyo ) {
 
@@ -273,11 +272,11 @@ class Tween {
     /**
      * set the easing function
      * @name easing
-     * @memberof me.Tween
+     * @memberof Tween
      * @public
      * @function
-     * @param {me.Tween.Easing} easing easing function
-     * @returns {me.Tween} this instance for object chaining
+     * @param {Tween.Easing} easing easing function
+     * @returns {Tween} this instance for object chaining
      */
     easing( easing ) {
         if (typeof easing !== "function") {
@@ -290,11 +289,11 @@ class Tween {
     /**
      * set the interpolation function
      * @name interpolation
-     * @memberof me.Tween
+     * @memberof Tween
      * @public
      * @function
-     * @param {me.Tween.Interpolation} interpolation interpolation function
-     * @returns {me.Tween} this instance for object chaining
+     * @param {Tween.Interpolation} interpolation interpolation function
+     * @returns {Tween} this instance for object chaining
      */
     interpolation( interpolation ) {
         this._interpolationFunction = interpolation;
@@ -304,11 +303,11 @@ class Tween {
     /**
      * chain the tween
      * @name chain
-     * @memberof me.Tween
+     * @memberof Tween
      * @public
      * @function
-     * @param {...me.Tween} chainedTween Tween(s) to be chained
-     * @returns {me.Tween} this instance for object chaining
+     * @param {...Tween} chainedTween Tween(s) to be chained
+     * @returns {Tween} this instance for object chaining
      */
     chain() {
         this._chainedTweens = arguments;
@@ -318,11 +317,11 @@ class Tween {
     /**
      * onStart callback
      * @name onStart
-     * @memberof me.Tween
+     * @memberof Tween
      * @public
      * @function
      * @param {Function} onStartCallback callback
-     * @returns {me.Tween} this instance for object chaining
+     * @returns {Tween} this instance for object chaining
      */
     onStart( onStartCallback ) {
         this._onStartCallback = onStartCallback;
@@ -332,11 +331,11 @@ class Tween {
     /**
      * onUpdate callback
      * @name onUpdate
-     * @memberof me.Tween
+     * @memberof Tween
      * @public
      * @function
      * @param {Function} onUpdateCallback callback
-     * @returns {me.Tween} this instance for object chaining
+     * @returns {Tween} this instance for object chaining
      */
     onUpdate( onUpdateCallback ) {
         this._onUpdateCallback = onUpdateCallback;
@@ -346,11 +345,11 @@ class Tween {
     /**
      * onComplete callback
      * @name onComplete
-     * @memberof me.Tween
+     * @memberof Tween
      * @public
      * @function
      * @param {Function} onCompleteCallback callback
-     * @returns {me.Tween} this instance for object chaining
+     * @returns {Tween} this instance for object chaining
      */
     onComplete( onCompleteCallback ) {
         this._onCompleteCallback = onCompleteCallback;

package/src/utils/agent.js

@@ -2,8 +2,7 @@ import { capitalize } from "./string.js";
 
 /**
  * a collection of utility functons to ease porting between different user agents.
- * @namespace me.utils.agent
- * @memberof me
+ * @namespace utils.agent
  */
 
 /**
@@ -20,7 +19,7 @@ var vendors = [ "ms", "MS", "moz", "webkit", "o" ];
  * @param {string} name Property name
  * @param {object} [obj=window] Object or element reference to access
  * @returns {string} Value of property
- * @memberof me.utils.agent
+ * @memberof utils.agent
  */
 export function prefixed(name, obj) {
     obj = obj || window;
@@ -47,7 +46,7 @@ export function prefixed(name, obj) {
  * @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
+ * @memberof utils.agent
  */
 export function setPrefixed(name, value, obj) {
     obj = obj || window;

package/src/utils/array.js

@@ -2,15 +2,14 @@ import {random as mathRandom, weightedRandom as mathWeightedRandom} from "./../m
 
 /**
  * a collection of array utility functions
- * @namespace me.utils.array
- * @memberof me
+ * @namespace utils.array
  */
 
 /**
  * Remove the specified object from the given Array
  * @public
  * @function
- * @memberof me.utils.array
+ * @memberof utils.array
  * @name remove
  * @param {Array} arr array from which to remove an object
  * @param {object} obj to be removed
@@ -31,7 +30,7 @@ export function remove(arr, obj) {
  * return a random array element
  * @public
  * @function
- * @memberof me.utils.array
+ * @memberof utils.array
  * @name random
  * @param {Array} arr array to pick a element
  * @returns {any} random member of array
@@ -48,7 +47,7 @@ export function random(arr) {
  * return a weighted random array element, favoring the earlier entries
  * @public
  * @function
- * @memberof me.utils.array
+ * @memberof utils.array
  * @name weightedRandom
  * @param {Array} arr array to pick a element
  * @returns {any} random member of array

package/src/utils/file.js

@@ -1,8 +1,7 @@
 
 /**
  * a collection of file utility functions
- * @namespace me.utils.file
- * @memberof me
+ * @namespace utils.file
  */
 
 // regexp to deal with file name & path
@@ -14,7 +13,7 @@ const REMOVE_EXT = /\.[^\.]*$/;
  * return the base name of the file without path info
  * @public
  * @function
- * @memberof me.utils.file
+ * @memberof utils.file
  * @name getBasename
  * @param  {string} path path containing the filename
  * @returns {string} the base name without path information.
@@ -27,7 +26,7 @@ export function getBasename(path) {
  * return the extension of the file in the given path
  * @public
  * @function
- * @memberof me.utils.file
+ * @memberof utils.file
  * @name getExtension
  * @param  {string} path path containing the filename
  * @returns {string} filename extension.

package/src/utils/function.js

@@ -1,18 +1,17 @@
 /**
  * a collection of utility functions
- * @namespace me.utils.function
- * @memberof me
+ * @namespace utils.function
  */
 
 /**
  * Executes a function as soon as the interpreter is idle (stack empty).
  * @public
  * @function
- * @memberof me.utils.function
+ * @memberof utils.function
  * @name defer
  * @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.
+ * @param {...*} args Optional additional arguments to carry for the function.
  * @returns {number} id that can be used to clear the deferred function using
  * clearTimeout
  * @example
@@ -29,7 +28,7 @@ export function defer(func, thisArg, ...args) {
  * once during a given window of time
  * @public
  * @function
- * @memberof me.utils.function
+ * @memberof utils.function
  * @name throttle
  * @param {Function} fn the function to be throttled.
  * @param {number} delay The delay in ms

package/src/utils/string.js

@@ -1,15 +1,13 @@
 /**
  * a collection of string utility functions
- * @namespace me.utils.string
- * @memberof me
+ * @namespace utils.string
  */
 
-
 /**
  * converts the first character of the given string to uppercase
  * @public
  * @function
- * @memberof me.utils.string
+ * @memberof utils.string
  * @name capitalize
  * @param {string} str the string to be capitalized
  * @returns {string} the capitalized string
@@ -22,7 +20,7 @@ export function capitalize(str) {
  * returns the string stripped of whitespace from the left.
  * @public
  * @function
- * @memberof me.utils.string
+ * @memberof utils.string
  * @name trimLeft
  * @param {string} str the string to be trimmed
  * @returns {string} trimmed string
@@ -35,7 +33,7 @@ export function trimLeft(str) {
  * returns the string stripped of whitespace from the right.
  * @public
  * @function
- * @memberof me.utils.string
+ * @memberof utils.string
  * @name trimRight
  * @param {string} str the string to be trimmed
  * @returns {string} trimmed string
@@ -48,7 +46,7 @@ export function trimRight(str) {
  * returns true if the given string contains a numeric integer or float value
  * @public
  * @function
- * @memberof me.utils.string
+ * @memberof utils.string
  * @name isNumeric
  * @param {string} str the string to be tested
  * @returns {boolean} true if string contains only digits
@@ -64,7 +62,7 @@ export function isNumeric(str) {
  * returns true if the given string contains a true or false
  * @public
  * @function
- * @memberof me.utils.string
+ * @memberof utils.string
  * @name isBoolean
  * @param {string} str the string to be tested
  * @returns {boolean} true if the string is either true or false
@@ -78,7 +76,7 @@ export function isBoolean(str) {
  * convert a string to the corresponding hexadecimal value
  * @public
  * @function
- * @memberof me.utils.string
+ * @memberof utils.string
  * @name toHex
  * @param {string} str the string to be converted
  * @returns {string} the converted hexadecimal value

package/src/utils/utils.js

@@ -10,7 +10,6 @@ import { version } from "./../index.js";
 /**
  * a collection of utility functions
  * @namespace utils
- * @memberof me
  */
 
 // guid default value
@@ -29,7 +28,7 @@ var utils = {
      * Get image pixels
      * @public
      * @function
-     * @memberof me.utils
+     * @memberof utils
      * @name getPixels
      * @param {HTMLImageElement|HTMLCanvasElement} image Image to read
      * @returns {ImageData} ImageData object
@@ -52,10 +51,10 @@ var utils = {
      * Compare two version strings
      * @public
      * @function
-     * @memberof me.utils
+     * @memberof utils
      * @name checkVersion
      * @param {string} first First version string to compare
-     * @param {string} [second=me.version] Second version string to compare
+     * @param {string} [second=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
@@ -85,7 +84,7 @@ var utils = {
      * parse the fragment (hash) from a URL and returns them into
      * @public
      * @function
-     * @memberof me.utils
+     * @memberof utils
      * @name getUriFragment
      * @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.