melonjs 10.2.3 → 10.5.0

package/src/level/tiled/renderer/TMXStaggeredRenderer.js

@@ -7,11 +7,7 @@ import { degToRad } from "./../../../math/math.js";
 /**
  * @classdesc
  * a Staggered Map Renderder
- * @class TMXStaggeredRenderer
- * @memberOf me
- * @extends me.TMXHexagonalRenderer
- * @constructor
- * @param {me.TMXTileMap} map the TMX map
+ * @augments TMXHexagonalRenderer
  */
 class TMXStaggeredRenderer extends TMXHexagonalRenderer {
 

package/src/loader/loader.js

@@ -294,7 +294,6 @@ function preloadJavascript(data, onload, onerror) {
 /**
  * a small class to manage loading of stuff and manage resources
  * @namespace loader
- * @memberOf me
  */
 var loader = {
 
@@ -313,7 +312,7 @@ var loader = {
      * @public
      * @function
      * @name onload
-     * @memberOf me.loader
+     * @memberof loader
      * @example
      * // set a callback when everything is loaded
      * me.loader.onload = this.loaded.bind(this);
@@ -327,7 +326,7 @@ var loader = {
      * @public
      * @function
      * @name onProgress
-     * @memberOf me.loader
+     * @memberof loader
      * @example
      * // set a callback for progress notification
      * me.loader.onProgress = this.updateProgress.bind(this);
@@ -343,7 +342,7 @@ var loader = {
      * @type {string}
      * @name crossOrigin
      * @default undefined
-     * @memberOf me.loader
+     * @memberof loader
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes
      * @example
      *  // allow for cross-origin texture loading in WebGL
@@ -361,7 +360,7 @@ var loader = {
      * @type {boolean}
      * @name withCredentials
      * @default false
-     * @memberOf me.loader
+     * @memberof loader
      * @see https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials
      * @example
      *  // enable withCredentials
@@ -411,7 +410,7 @@ var loader = {
      * change the default baseURL for the given asset type.<br>
      * (this will prepend the asset URL and must finish with a '/')
      * @name setBaseURL
-     * @memberOf me.loader
+     * @memberof loader
      * @public
      * @function
      * @param {string} type  "*", "audio", binary", "image", "json", "js", "tmx", "tsx"
@@ -442,7 +441,7 @@ var loader = {
     /**
      * set all the specified game resources to be preloaded.
      * @name preload
-     * @memberOf me.loader
+     * @memberof loader
      * @public
      * @function
      * @param {object[]} res
@@ -450,7 +449,7 @@ var loader = {
      * @param {string} res.type  "audio", binary", "image", "json","js", "tmx", "tsx", "fontface"
      * @param {string} res.src  path and/or file name of the resource (for audio assets only the path is required)
      * @param {boolean} [res.stream] Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
-     * @param {Function} [onload=me.loader.onload] function to be called when all resources are loaded
+     * @param {Function} [onload=loader.onload] function to be called when all resources are loaded
      * @param {boolean} [switchToLoadState=true] automatically switch to the loading screen
      * @example
      * game_resources = [
@@ -507,7 +506,7 @@ var loader = {
     /**
      * Load a single resource (to be used if you need to load additional resource during the game)
      * @name load
-     * @memberOf me.loader
+     * @memberof loader
      * @public
      * @function
      * @param {object} res
@@ -577,12 +576,14 @@ var loader = {
     /**
      * unload specified resource to free memory
      * @name unload
-     * @memberOf me.loader
+     * @memberof loader
      * @public
      * @function
      * @param {object} res
+     * @param {string} res.name internal name of the resource
+     * @param {string} res.type  "audio", binary", "image", "json", "tmx", "tsx"
      * @returns {boolean} true if unloaded
-     * @example me.loader.unload({name: "avatar",  type:"image",  src: "data/avatar.png"});
+     * @example me.loader.unload({name: "avatar",  type:"image"});
      */
     unload(res) {
         switch (res.type) {
@@ -637,7 +638,7 @@ var loader = {
     /**
      * unload all resources to free memory
      * @name unloadAll
-     * @memberOf me.loader
+     * @memberof loader
      * @public
      * @function
      * @example me.loader.unloadAll();
@@ -692,7 +693,7 @@ var loader = {
     /**
      * return the specified TMX/TSX object
      * @name getTMX
-     * @memberOf me.loader
+     * @memberof loader
      * @public
      * @function
      * @param {string} elt name of the tmx/tsx element ("map1");
@@ -710,7 +711,7 @@ var loader = {
     /**
      * return the specified Binary object
      * @name getBinary
-     * @memberOf me.loader
+     * @memberof loader
      * @public
      * @function
      * @param {string} elt name of the binary object ("ymTrack");
@@ -728,7 +729,7 @@ var loader = {
     /**
      * return the specified Image Object
      * @name getImage
-     * @memberOf me.loader
+     * @memberof loader
      * @public
      * @function
      * @param {string} image name of the Image element ("tileset-platformer");
@@ -747,7 +748,7 @@ var loader = {
     /**
      * return the specified JSON Object
      * @name getJSON
-     * @memberOf me.loader
+     * @memberof loader
      * @public
      * @function
      * @param {string} elt name of the json file to load

package/src/loader/loadingscreen.js

@@ -4,7 +4,6 @@ import * as event from "./../system/event.js";
 import {nextPowerOfTwo} from "./../math/math.js";
 import pool from "./../system/pooling.js";
 import Renderable from "./../renderable/renderable.js";
-import ColorLayer from "./../renderable/colorlayer.js";
 import Stage from "./../state/stage.js";
 
 
@@ -118,9 +117,7 @@ class IconLogo extends Renderable {
 
 /**
  * a default loading screen
- * @memberOf me
  * @ignore
- * @constructor
  */
 class DefaultLoadingScreen extends Stage {
     /**
@@ -130,8 +127,8 @@ class DefaultLoadingScreen extends Stage {
     onResetEvent() {
         var barHeight = 8;
 
-        // clear the background
-        world.addChild(new ColorLayer("background", "#202020"), 0);
+        // set a background color
+        world.backgroundColor.parseCSS("#202020");
 
         // progress bar
         world.addChild(new ProgressBar(

package/src/math/color.js

@@ -172,18 +172,16 @@ var cssToRGB = new Map();
 /**
  * @classdesc
  * A color manipulation object.
- * @class Color
- * @memberOf me
- * @constructor
- * @param {number|Float32Array} [r=0] red component or array of color components
- * @param {number} [g=0] green component
- * @param {number} [b=0] blue component
- * @param {number} [alpha=1.0] alpha value
  */
 class Color {
-
-    constructor(...args) {
-        this.onResetEvent(...args);
+    /**
+     * @param {number} [r=0] red component or array of color components
+     * @param {number} [g=0] green component
+     * @param {number} [b=0] blue component
+     * @param {number} [alpha=1.0] alpha value
+     */
+    constructor(r = 0, g = 0, b = 0, alpha = 1.0) {
+        this.onResetEvent(r, g, b, alpha);
     }
 
     /**
@@ -204,11 +202,8 @@ class Color {
     /**
      * Color Red Component [0 .. 255]
      * @type {number}
-     * @name r
-     * @readonly
-     * @memberOf me.Color
+     * @memberof Color
      */
-
     get r() {
         return ~~(this.glArray[0] * 255);
     }
@@ -221,11 +216,8 @@ class Color {
     /**
      * Color Green Component [0 .. 255]
      * @type {number}
-     * @name g
-     * @readonly
-     * @memberOf me.Color
+     * @memberof Color
      */
-
     get g() {
         return ~~(this.glArray[1] * 255);
     }
@@ -238,15 +230,11 @@ class Color {
     /**
      * Color Blue Component [0 .. 255]
      * @type {number}
-     * @name b
-     * @readonly
-     * @memberOf me.Color
+     * @memberof Color
      */
-
     get b() {
         return ~~(this.glArray[2] * 255);
     }
-
     set b(value) {
         this.glArray[2] = clamp(~~value || 0, 0, 255) / 255.0;
     }
@@ -254,11 +242,8 @@ class Color {
     /**
      * Color Alpha Component [0.0 .. 1.0]
      * @type {number}
-     * @name alpha
-     * @readonly
-     * @memberOf me.Color
+     * @memberof Color
      */
-
     get alpha() {
         return this.glArray[3];
     }
@@ -271,20 +256,15 @@ class Color {
     /**
      * Set this color to the specified value.
      * @name setColor
-     * @memberOf me.Color
+     * @memberof Color
      * @function
      * @param {number} r red component [0 .. 255]
      * @param {number} g green component [0 .. 255]
      * @param {number} b blue component [0 .. 255]
      * @param {number} [alpha=1.0] alpha value [0.0 .. 1.0]
-     * @returns {me.Color} Reference to this object for method chaining
+     * @returns {Color} Reference to this object for method chaining
      */
     setColor(r, g, b, alpha = 1.0) {
-        // Private initialization: copy Color value directly
-        if (r instanceof Color) {
-            this.glArray.set(r.glArray);
-            return r;
-        }
         this.r = r;
         this.g = g;
         this.b = b;
@@ -295,21 +275,21 @@ class Color {
     /**
      * Create a new copy of this color object.
      * @name clone
-     * @memberOf me.Color
+     * @memberof Color
      * @function
-     * @returns {me.Color} Reference to the newly cloned object
+     * @returns {Color} Reference to the newly cloned object
      */
     clone() {
-        return pool.pull("Color", this);
+        return pool.pull("Color").copy(this);
     }
 
     /**
      * Copy a color object or CSS color into this one.
      * @name copy
-     * @memberOf me.Color
+     * @memberof Color
      * @function
-     * @param {me.Color|string} color
-     * @returns {me.Color} Reference to this object for method chaining
+     * @param {Color|string} color
+     * @returns {Color} Reference to this object for method chaining
      */
     copy(color) {
         if (color instanceof Color) {
@@ -323,10 +303,10 @@ class Color {
     /**
      * Blend this color with the given one using addition.
      * @name add
-     * @memberOf me.Color
+     * @memberof Color
      * @function
-     * @param {me.Color} color
-     * @returns {me.Color} Reference to this object for method chaining
+     * @param {Color} color
+     * @returns {Color} Reference to this object for method chaining
      */
     add(color) {
         this.glArray[0] = clamp(this.glArray[0] + color.glArray[0], 0, 1);
@@ -340,10 +320,10 @@ class Color {
     /**
      * Darken this color value by 0..1
      * @name darken
-     * @memberOf me.Color
+     * @memberof Color
      * @function
      * @param {number} scale
-     * @returns {me.Color} Reference to this object for method chaining
+     * @returns {Color} Reference to this object for method chaining
      */
     darken(scale) {
         scale = clamp(scale, 0, 1);
@@ -357,11 +337,11 @@ class Color {
     /**
      * Linearly interpolate between this color and the given one.
      * @name lerp
-     * @memberOf me.Color
+     * @memberof Color
      * @function
-     * @param {me.Color} color
+     * @param {Color} color
      * @param {number} alpha with alpha = 0 being this color, and alpha = 1 being the given one.
-     * @returns {me.Color} Reference to this object for method chaining
+     * @returns {Color} Reference to this object for method chaining
      */
     lerp(color, alpha) {
         alpha = clamp(alpha, 0, 1);
@@ -375,10 +355,10 @@ class Color {
     /**
      * Lighten this color value by 0..1
      * @name lighten
-     * @memberOf me.Color
+     * @memberof Color
      * @function
      * @param {number} scale
-     * @returns {me.Color} Reference to this object for method chaining
+     * @returns {Color} Reference to this object for method chaining
      */
     lighten(scale) {
         scale = clamp(scale, 0, 1);
@@ -392,11 +372,11 @@ class Color {
     /**
      * Generate random r,g,b values for this color object
      * @name random
-     * @memberOf me.Color
+     * @memberof Color
      * @function
      * @param {number} [min=0] minimum value for the random range
      * @param {number} [max=255] maxmium value for the random range
-     * @returns {me.Color} Reference to this object for method chaining
+     * @returns {Color} Reference to this object for method chaining
      */
     random(min = 0, max = 255) {
         if (min < 0) {
@@ -418,9 +398,9 @@ class Color {
      * Return true if the r,g,b,a values of this color are equal with the
      * given one.
      * @name equals
-     * @memberOf me.Color
+     * @memberof Color
      * @function
-     * @param {me.Color} color
+     * @param {Color} color
      * @returns {boolean}
      */
     equals(color) {
@@ -436,10 +416,10 @@ class Color {
      * Parse a CSS color string and set this color to the corresponding
      * r,g,b values
      * @name parseCSS
-     * @memberOf me.Color
+     * @memberof Color
      * @function
      * @param {string} cssColor
-     * @returns {me.Color} Reference to this object for method chaining
+     * @returns {Color} Reference to this object for method chaining
      */
     parseCSS(cssColor) {
         // TODO : Memoize this function by caching its input
@@ -454,10 +434,10 @@ class Color {
     /**
      * Parse an RGB or RGBA CSS color string
      * @name parseRGB
-     * @memberOf me.Color
+     * @memberof Color
      * @function
      * @param {string} rgbColor
-     * @returns {me.Color} Reference to this object for method chaining
+     * @returns {Color} Reference to this object for method chaining
      */
     parseRGB(rgbColor) {
         // TODO : Memoize this function by caching its input
@@ -474,11 +454,11 @@ class Color {
      * Parse a Hex color ("#RGB", "#RGBA" or "#RRGGBB", "#RRGGBBAA" format) and set this color to
      * the corresponding r,g,b,a values
      * @name parseHex
-     * @memberOf me.Color
+     * @memberof Color
      * @function
      * @param {string} hexColor
      * @param {boolean} [argb = false] true if format is #ARGB, or #AARRGGBB (as opposed to #RGBA or #RGGBBAA)
-     * @returns {me.Color} Reference to this object for method chaining
+     * @returns {Color} Reference to this object for method chaining
      */
     parseHex(hexColor, argb = false) {
         // TODO : Memoize this function by caching its input
@@ -534,10 +514,10 @@ class Color {
     /**
      * Pack this color into a Uint32 ARGB representation
      * @name toUint32
-     * @memberOf me.Color
+     * @memberof Color
      * @function
      * @param {number} [alpha=1.0] alpha value [0.0 .. 1.0]
-     * @returns {Uint32}
+     * @returns {number}
      */
     toUint32(alpha = this.alpha) {
         var ur = this.r & 0xff;
@@ -551,7 +531,7 @@ class Color {
     /**
      * return an array representation of this object
      * @name toArray
-     * @memberOf me.Color
+     * @memberof Color
      * @function
      * @returns {Float32Array}
      */
@@ -563,7 +543,7 @@ class Color {
     /**
      * Get the color in "#RRGGBB" format
      * @name toHex
-     * @memberOf me.Color
+     * @memberof Color
      * @function
      * @returns {string}
      */
@@ -577,7 +557,7 @@ class Color {
     /**
      * Get the color in "#RRGGBBAA" format
      * @name toHex8
-     * @memberOf me.Color
+     * @memberof Color
      * @function
      * @returns {string}
      */
@@ -591,7 +571,7 @@ class Color {
     /**
      * Get the color in "rgb(R,G,B)" format
      * @name toRGB
-     * @memberOf me.Color
+     * @memberof Color
      * @function
      * @returns {string}
      */
@@ -609,7 +589,7 @@ class Color {
     /**
      * Get the color in "rgba(R,G,B,A)" format
      * @name toRGBA
-     * @memberOf me.Color
+     * @memberof Color
      * @function
      * @returns {string}
      */

package/src/math/math.js

@@ -1,7 +1,6 @@
 /**
  * a collection of math utility functions
  * @namespace Math
- * @memberOf me
  */
 
 /**
@@ -9,7 +8,7 @@
  * @public
  * @type {number}
  * @name DEG_TO_RAD
- * @memberOf me.Math
+ * @memberof Math
  */
 export const DEG_TO_RAD = Math.PI / 180.0;
 
@@ -18,7 +17,7 @@ export const DEG_TO_RAD = Math.PI / 180.0;
  * @public
  * @type {number}
  * @name RAD_TO_DEG
- * @memberOf me.Math
+ * @memberof Math
  */
 export const RAD_TO_DEG = 180.0 / Math.PI;
 
@@ -27,7 +26,7 @@ export const RAD_TO_DEG = 180.0 / Math.PI;
  * @public
  * @type {number}
  * @name TAU
- * @memberOf me.Math
+ * @memberof Math
  */
 export const TAU = Math.PI * 2;
 
@@ -36,7 +35,7 @@ export const TAU = Math.PI * 2;
  * @public
  * @type {number}
  * @name ETA
- * @memberOf me.Math
+ * @memberof Math
  */
 export const ETA = Math.PI * 0.5;
 
@@ -45,7 +44,7 @@ export const ETA = Math.PI * 0.5;
  * @public
  * @type {number}
  * @name EPSILON
- * @memberOf me.Math
+ * @memberof Math
  */
 export const EPSILON = 0.000001;
 
@@ -53,7 +52,7 @@ export const EPSILON = 0.000001;
  * returns true if the given value is a power of two
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof Math
  * @name isPowerOfTwo
  * @param {number} val
  * @returns {boolean}
@@ -66,7 +65,7 @@ export function isPowerOfTwo(val) {
  * returns the next power of two for the given value
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof Math
  * @name nextPowerOfTwo
  * @param {number} val
  * @returns {boolean}
@@ -86,7 +85,7 @@ export function nextPowerOfTwo(val) {
  * Converts an angle in degrees to an angle in radians
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof Math
  * @name degToRad
  * @param {number} angle angle in degrees
  * @returns {number} corresponding angle in radians
@@ -102,7 +101,7 @@ export function degToRad(angle) {
  * Converts an angle in radians to an angle in degrees.
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof Math
  * @name radToDeg
  * @param {number} radians angle in radians
  * @returns {number} corresponding angle in degrees
@@ -118,7 +117,7 @@ export function radToDeg(radians) {
  * clamp the given value
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof Math
  * @name clamp
  * @param {number} val the value to clamp
  * @param {number} low lower limit
@@ -133,7 +132,7 @@ export function clamp(val, low, high) {
  * return a random integer between min (included) and max (excluded)
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof Math
  * @name random
  * @param {number} min minimum value.
  * @param {number} max maximum value.
@@ -150,7 +149,7 @@ export function random(min, max) {
  * return a random float between min, max (exclusive)
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof Math
  * @name randomFloat
  * @param {number} min minimum value.
  * @param {number} max maximum value.
@@ -167,7 +166,7 @@ export function randomFloat(min, max) {
  * return a weighted random between min, max (exclusive)
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof Math
  * @name weightedRandom
  * @param {number} min minimum value.
  * @param {number} max maximum value.
@@ -184,7 +183,7 @@ export function weightedRandom(min, max) {
  * round a value to the specified number of digit
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof Math
  * @name round
  * @param {number} num value to be rounded.
  * @param {number} [dec=0] number of decimal digit to be rounded to.
@@ -203,7 +202,7 @@ export function round(num, dec = 0) {
  * check if the given value is close to the expected one
  * @public
  * @function
- * @memberOf me.Math
+ * @memberof Math
  * @name toBeCloseTo
  * @param {number} expected value to be compared with.
  * @param {number} actual actual value to compare