melonjs 14.0.2 → 14.1.0

package/src/text/text.js

@@ -38,21 +38,21 @@ var getContext2d = function (renderer, text) {
  */
 class Text extends Renderable {
     /**
-     * @param {number} x position of the text object
-     * @param {number} y position of the text object
-     * @param {object} settings the text configuration
-     * @param {string} settings.font a CSS family font name
-     * @param {number|string} settings.size size, or size + suffix (px, em, pt)
-     * @param {Color|string} [settings.fillStyle="#000000"] a CSS color value
-     * @param {Color|string} [settings.strokeStyle="#000000"] a CSS color value
-     * @param {number} [settings.lineWidth=1] line width, in pixels, when drawing stroke
-     * @param {string} [settings.textAlign="left"] horizontal text alignment
-     * @param {string} [settings.textBaseline="top"] the text baseline
-     * @param {number} [settings.lineHeight=1.0] line spacing height
-     * @param {Vector2d} [settings.anchorPoint={x:0.0, y:0.0}] anchor point to draw the text at
-     * @param {boolean} [settings.offScreenCanvas=false] whether to draw the font to an individual "cache" texture first
-     * @param {number} [settings.wordWrapWidth] the maximum length in CSS pixel for a single segment of text
-     * @param {(string|string[])} [settings.text=""] a string, or an array of strings
+     * @param {number} x - position of the text object
+     * @param {number} y - position of the text object
+     * @param {object} settings - the text configuration
+     * @param {string} settings.font - a CSS family font name
+     * @param {number|string} settings.size - size, or size + suffix (px, em, pt)
+     * @param {Color|string} [settings.fillStyle="#000000"] - a CSS color value
+     * @param {Color|string} [settings.strokeStyle="#000000"] - a CSS color value
+     * @param {number} [settings.lineWidth=1] - line width, in pixels, when drawing stroke
+     * @param {string} [settings.textAlign="left"] - horizontal text alignment
+     * @param {string} [settings.textBaseline="top"] - the text baseline
+     * @param {number} [settings.lineHeight=1.0] - line spacing height
+     * @param {Vector2d} [settings.anchorPoint={x:0.0, y:0.0}] - anchor point to draw the text at
+     * @param {boolean} [settings.offScreenCanvas=false] - whether to draw the font to an individual "cache" texture first
+     * @param {number} [settings.wordWrapWidth] - the maximum length in CSS pixel for a single segment of text
+     * @param {(string|string[])} [settings.text=""] - a string, or an array of strings
      * @example
      * var font = new me.Text(0, 0, {font: "Arial", size: 8, fillStyle: this.color});
      */
@@ -226,8 +226,8 @@ class Text extends Renderable {
 
     /**
      * set the font family and size
-     * @param {string} font a CSS font name
-     * @param {number|string} [size=10] size in px, or size + suffix (px, em, pt)
+     * @param {string} font - a CSS font name
+     * @param {number|string} [size=10] - size in px, or size + suffix (px, em, pt)
      * @returns {Text} this object for chaining
      * @example
      * font.setFont("Arial", 20);
@@ -267,7 +267,7 @@ class Text extends Renderable {
 
     /**
      * change the text to be displayed
-     * @param {number|string|string[]} value a string, or an array of strings
+     * @param {number|string|string[]} value - a string, or an array of strings
      * @returns {Text} this object for chaining
      */
     setText(value = "") {
@@ -323,8 +323,8 @@ class Text extends Renderable {
 
     /**
      * measure the given text size in pixels
-     * @param {CanvasRenderer|WebGLRenderer} renderer reference to the active renderer
-     * @param {string} [text] the text to be measured
+     * @param {CanvasRenderer|WebGLRenderer} renderer - reference to the active renderer
+     * @param {string} [text] - the text to be measured
      * @returns {TextMetrics} a TextMetrics object defining the dimensions of the given piece of text
      */
     measureText(renderer, text = this._text) {
@@ -334,11 +334,11 @@ class Text extends Renderable {
 
     /**
      * draw a text at the specified coord
-     * @param {CanvasRenderer|WebGLRenderer} renderer Reference to the destination renderer instance
+     * @param {CanvasRenderer|WebGLRenderer} renderer - Reference to the destination renderer instance
      * @param {string} [text]
      * @param {number} [x]
      * @param {number} [y]
-     * @param {boolean} [stroke=false] draw stroke the the text if true
+     * @param {boolean} [stroke=false] - draw stroke the the text if true
      */
     draw(renderer, text, x = this.pos.x, y = this.pos.y, stroke = false) {
         // "hacky patch" for backward compatibilty
@@ -394,7 +394,7 @@ class Text extends Renderable {
      * draw a stroke text at the specified coord, as defined <br>
      * by the `lineWidth` and `fillStroke` properties. <br>
      * Note : using drawStroke is not recommended for performance reasons
-     * @param {CanvasRenderer|WebGLRenderer} renderer Reference to the destination renderer instance
+     * @param {CanvasRenderer|WebGLRenderer} renderer - Reference to the destination renderer instance
      * @param {string} text
      * @param {number} x
      * @param {number} y

package/src/text/textmetrics.js

@@ -10,7 +10,7 @@ import setContextStyle from "./textstyle.js";
 class TextMetrics extends Bounds {
 
     /**
-     * @param {Text|BitmapText} ancestor the parent object that contains this TextMetrics object
+     * @param {Text|BitmapText} ancestor - the parent object that contains this TextMetrics object
      */
     constructor(ancestor) {
 
@@ -42,8 +42,8 @@ class TextMetrics extends Bounds {
 
     /**
      * Returns the width of the given segment of inline text in CSS pixels.
-     * @param {string} text the text to be measured
-     * @param {CanvasRenderingContext2D} [context] reference to an active 2d context for canvas rendering
+     * @param {string} text - the text to be measured
+     * @param {CanvasRenderingContext2D} [context] - reference to an active 2d context for canvas rendering
      * @returns {number} the width of the given segment of inline text in CSS pixels.
      */
     lineWidth(text, context) {
@@ -68,8 +68,8 @@ class TextMetrics extends Bounds {
 
     /**
      * measure the given text size in CSS pixels
-     * @param {string} text the text to be measured
-     * @param {CanvasRenderingContext2D} [context] reference to an active 2d context for canvas rendering
+     * @param {string} text - the text to be measured
+     * @param {CanvasRenderingContext2D} [context] - reference to an active 2d context for canvas rendering
      * @returns {TextMetrics} this
      */
     measureText(text, context) {
@@ -117,9 +117,9 @@ class TextMetrics extends Bounds {
 
     /**
      * wrap the given text based on the given width
-     * @param {string|string[]} text the text to be wrapped
-     * @param {number} width maximum width of one segment of text in css pixel
-     * @param {CanvasRenderingContext2D} [context] reference to an active 2d context for canvas rendering
+     * @param {string|string[]} text - the text to be wrapped
+     * @param {number} width - maximum width of one segment of text in css pixel
+     * @param {CanvasRenderingContext2D} [context] - reference to an active 2d context for canvas rendering
      * @returns {string[]} an array of string representing wrapped text
      */
     wordWrap(text, width, context) {

package/src/tweens/tween.js

@@ -26,7 +26,7 @@ import { Interpolation } from "./interpolation.js";
 class Tween {
 
     /**
-     * @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({
@@ -121,15 +121,15 @@ class Tween {
      * @name to
      * @memberof Tween
      * @public
-     * @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 {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 {Tween.Interpolation} [options.interpolation] interpolation function
-     * @param {boolean} [options.autoStart] allow this tween to start automatically. Otherwise call me.Tween.start().
+     * @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 {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 {Tween.Interpolation} [options.interpolation] - interpolation function
+     * @param {boolean} [options.autoStart] - allow this tween to start automatically. Otherwise call me.Tween.start().
      * @returns {Tween} this instance for object chaining
      */
     to( properties, options ) {
@@ -162,7 +162,7 @@ class Tween {
      * @name start
      * @memberof Tween
      * @public
-     * @param {number} [time] the current time when the tween was started
+     * @param {number} [time] - the current time when the tween was started
      * @returns {Tween} this instance for object chaining
      */
     start( time = timer.getTime() ) {
@@ -221,7 +221,7 @@ class Tween {
      * @name delay
      * @memberof Tween
      * @public
-     * @param {number} amount delay amount expressed in milliseconds
+     * @param {number} amount - delay amount expressed in milliseconds
      * @returns {Tween} this instance for object chaining
      */
     delay( amount ) {
@@ -236,7 +236,7 @@ class Tween {
      * @name repeat
      * @memberof Tween
      * @public
-     * @param {number} times amount of times the tween should be repeated
+     * @param {number} times - amount of times the tween should be repeated
      * @returns {Tween} this instance for object chaining
      */
     repeat( times ) {
@@ -268,7 +268,7 @@ class Tween {
      * @name easing
      * @memberof Tween
      * @public
-     * @param {Tween.Easing} easing easing function
+     * @param {Tween.Easing} easing - easing function
      * @returns {Tween} this instance for object chaining
      */
     easing( easing ) {
@@ -284,7 +284,7 @@ class Tween {
      * @name interpolation
      * @memberof Tween
      * @public
-     * @param {Tween.Interpolation} interpolation interpolation function
+     * @param {Tween.Interpolation} interpolation - interpolation function
      * @returns {Tween} this instance for object chaining
      */
     interpolation( interpolation ) {
@@ -297,7 +297,7 @@ class Tween {
      * @name chain
      * @memberof Tween
      * @public
-     * @param {...Tween} chainedTween Tween(s) to be chained
+     * @param {...Tween} chainedTween - Tween(s) to be chained
      * @returns {Tween} this instance for object chaining
      */
     chain() {
@@ -310,7 +310,7 @@ class Tween {
      * @name onStart
      * @memberof Tween
      * @public
-     * @param {Function} onStartCallback callback
+     * @param {Function} onStartCallback - callback
      * @returns {Tween} this instance for object chaining
      */
     onStart( onStartCallback ) {
@@ -323,7 +323,7 @@ class Tween {
      * @name onUpdate
      * @memberof Tween
      * @public
-     * @param {Function} onUpdateCallback callback
+     * @param {Function} onUpdateCallback - callback
      * @returns {Tween} this instance for object chaining
      */
     onUpdate( onUpdateCallback ) {
@@ -336,7 +336,7 @@ class Tween {
      * @name onComplete
      * @memberof Tween
      * @public
-     * @param {Function} onCompleteCallback callback
+     * @param {Function} onCompleteCallback - callback
      * @returns {Tween} this instance for object chaining
      */
     onComplete( onCompleteCallback ) {

package/src/utils/agent.js

@@ -15,8 +15,8 @@ const vendors = [ "ms", "MS", "moz", "webkit", "o" ];
  * Get a vendor-prefixed property
  * @public
  * @name prefixed
- * @param {string} name Property name
- * @param {object} [obj=globalThis] Object or element reference to access
+ * @param {string} name - Property name
+ * @param {object} [obj=globalThis] - Object or element reference to access
  * @returns {string} Value of property
  * @memberof utils.agent
  */
@@ -40,9 +40,9 @@ export function prefixed(name, obj) {
  * Set a vendor-prefixed property
  * @public
  * @name setPrefixed
- * @param {string} name Property name
- * @param {string} value Property value
- * @param {object} [obj=globalThis] Object or element reference to access
+ * @param {string} name - Property name
+ * @param {string} value - Property value
+ * @param {object} [obj=globalThis] - Object or element reference to access
  * @returns {boolean} true if one of the vendor-prefixed property was found
  * @memberof utils.agent
  */

package/src/utils/array.js

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

package/src/utils/file.js

@@ -14,7 +14,7 @@ const REMOVE_EXT = /\.[^\.]*$/;
  * @public
  * @memberof utils.file
  * @name getBasename
- * @param  {string} path path containing the filename
+ * @param  {string} path- -  path containing the filename
  * @returns {string} the base name without path information.
  */
 export function getBasename(path) {
@@ -26,7 +26,7 @@ export function getBasename(path) {
  * @public
  * @memberof utils.file
  * @name getExtension
- * @param  {string} path path containing the filename
+ * @param  {string} path- -  path containing the filename
  * @returns {string} filename extension.
  */
 export function getExtension(path) {

package/src/utils/function.js

@@ -8,9 +8,9 @@
  * @public
  * @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 {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.
  * @returns {number} id that can be used to clear the deferred function using
  * clearTimeout
  * @example
@@ -28,9 +28,9 @@ export function defer(func, thisArg, ...args) {
  * @public
  * @memberof utils.function
  * @name throttle
- * @param {Function} fn the function to be throttled.
- * @param {number} delay The delay in ms
- * @param {no_trailing} no_trailing disable the execution on the trailing edge
+ * @param {Function} fn - the function to be throttled.
+ * @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) {

package/src/utils/string.js

@@ -8,7 +8,7 @@
  * @public
  * @memberof utils.string
  * @name capitalize
- * @param {string} str the string to be capitalized
+ * @param {string} str - the string to be capitalized
  * @returns {string} the capitalized string
  */
 export function capitalize(str) {
@@ -20,7 +20,7 @@ export function capitalize(str) {
  * @public
  * @memberof utils.string
  * @name isNumeric
- * @param {string} str the string to be tested
+ * @param {string} str - the string to be tested
  * @returns {boolean} true if string contains only digits
  */
 export function isNumeric(str) {
@@ -35,7 +35,7 @@ export function isNumeric(str) {
  * @public
  * @memberof utils.string
  * @name isBoolean
- * @param {string} str the string to be tested
+ * @param {string} str - the string to be tested
  * @returns {boolean} true if the string is either true or false
  */
 export function isBoolean(str) {
@@ -48,7 +48,7 @@ export function isBoolean(str) {
  * @public
  * @memberof utils.string
  * @name toHex
- * @param {string} str the string to be converted
+ * @param {string} str - the string to be converted
  * @returns {string} the converted hexadecimal value
  */
 export function toHex(str) {
@@ -65,7 +65,7 @@ export function toHex(str) {
  * @public
  * @memberof utils.string
  * @name isDataUrl
- * @param {string} str the string (url) to be tested
+ * @param {string} str - the string (url) to be tested
  * @returns {boolean} true if the string is a data url
  */
 export function isDataUrl(str) {

package/src/utils/utils.js

@@ -29,7 +29,7 @@ var utils = {
      * @public
      * @memberof utils
      * @name getPixels
-     * @param {HTMLImageElement|HTMLCanvasElement} image Image to read
+     * @param {HTMLImageElement|HTMLCanvasElement} image - Image to read
      * @returns {ImageData} ImageData object
      */
     getPixels : function (image) {
@@ -51,8 +51,8 @@ var utils = {
      * @public
      * @memberof utils
      * @name checkVersion
-     * @param {string} first First version string to compare
-     * @param {string} [second=version] Second version string to compare
+     * @param {string} first - First 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
@@ -83,7 +83,7 @@ var utils = {
      * @public
      * @memberof utils
      * @name getUriFragment
-     * @param {string} [url=document.location] an optional params string or URL containing fragment (hash) params to be parsed
+     * @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)