melonjs 10.3.0 → 10.4.0

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

@@ -7,13 +7,12 @@ import TMXLayer from "./../TMXLayer.js";
 /**
  * @classdesc
  * an Isometric Map Renderder
- * @class TMXIsometricRenderer
- * @memberof me
- * @augments me.TMXRenderer
- * @param {me.TMXTileMap} map the TMX map
+ * @augments TMXRenderer
  */
 class TMXIsometricRenderer extends TMXRenderer {
-    // constructor
+    /**
+     * @param {TMXTileMap} map the TMX map
+     */
     constructor(map) {
         super(
             map.cols,
@@ -40,11 +39,11 @@ class TMXIsometricRenderer extends TMXRenderer {
 
     /**
      * return the bounding rect for this map renderer
-     * @name me.TMXIsometricRenderer#getBounds
+     * @name TMXIsometricRenderer#getBounds
      * @public
      * @function
-     * @param {me.TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
-     * @returns {me.Bounds}
+     * @param {TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
+     * @returns {Bounds}
      */
     getBounds(layer) {
         var bounds = layer instanceof TMXLayer ? pool.pull("Bounds") : this.bounds;

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

@@ -5,13 +5,12 @@ import TMXRenderer from "./TMXRenderer.js";
 /**
  * @classdesc
  * an Orthogonal Map Renderder
- * @class TMXOrthogonalRenderer
- * @memberof me
- * @augments me.TMXRenderer
- * @param {me.TMXTileMap} map the TMX map
+ * @augments TMXRenderer
  */
 class TMXOrthogonalRenderer extends TMXRenderer {
-    // constructor
+    /**
+     * @param {TMXTileMap} map the TMX map
+     */
     constructor(map) {
         super(
             map.cols,

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

@@ -7,15 +7,14 @@ import Bounds from "./../../../physics/Bounds.js";
 /**
  * @classdesc
  * The map renderer base class
- * @class TMXRenderer
- * @memberof me
- * @param {number} cols width of the tilemap in tiles
- * @param {number} rows height of the tilemap in tiles
- * @param {number} tilewidth width of each tile in pixels
- * @param {number} tileheight height of each tile in pixels
  */
 class TMXRenderer {
-
+    /**
+     * @param {number} cols width of the tilemap in tiles
+     * @param {number} rows height of the tilemap in tiles
+     * @param {number} tilewidth width of each tile in pixels
+     * @param {number} tileheight height of each tile in pixels
+     */
     constructor(cols, rows, tilewidth, tileheight) {
         this.cols = cols;
         this.rows = rows;
@@ -26,10 +25,10 @@ class TMXRenderer {
 
     /**
      * return true if the renderer can render the specified map or layer
-     * @name me.TMXRenderer#canRender
+     * @name TMXRenderer#canRender
      * @public
      * @function
-     * @param {me.TMXTileMap|me.TMXLayer} component TMX Map or Layer
+     * @param {TMXTileMap|TMXLayer} component TMX Map or Layer
      * @returns {boolean}
      */
     canRender(component) {
@@ -47,11 +46,11 @@ class TMXRenderer {
 
     /**
      * return the bounding rect for this map renderer
-     * @name me.TMXRenderer#getBounds
+     * @name TMXRenderer#getBounds
      * @public
      * @function
-     * @param {me.TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
-     * @returns {me.Bounds}
+     * @param {TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
+     * @returns {Bounds}
      */
     getBounds(layer) {
         var bounds = layer instanceof TMXLayer ? pool.pull("Bounds") : this.bounds;
@@ -65,13 +64,13 @@ class TMXRenderer {
 
     /**
      * return the tile position corresponding to the specified pixel
-     * @name me.TMXRenderer#pixelToTileCoords
+     * @name TMXRenderer#pixelToTileCoords
      * @public
      * @function
      * @param {number} x X coordinate
      * @param {number} y Y coordinate
-     * @param {me.Vector2d} [v] an optional vector object where to put the return values
-     * @returns {me.Vector2d}
+     * @param {Vector2d} [v] an optional vector object where to put the return values
+     * @returns {Vector2d}
      */
     pixelToTileCoords(x, y, v) {
         return v;
@@ -79,13 +78,13 @@ class TMXRenderer {
 
     /**
      * return the pixel position corresponding of the specified tile
-     * @name me.TMXRenderer#tileToPixelCoords
+     * @name TMXRenderer#tileToPixelCoords
      * @public
      * @function
      * @param {number} col tile horizontal position
      * @param {number} row tile vertical position
-     * @param {me.Vector2d} [v] an optional vector object where to put the return values
-     * @returns {me.Vector2d}
+     * @param {Vector2d} [v] an optional vector object where to put the return values
+     * @returns {Vector2d}
      */
     tileToPixelCoords(col, row, v) {
         return v;
@@ -93,25 +92,25 @@ class TMXRenderer {
 
     /**
      * draw the given tile at the specified layer
-     * @name me.TMXRenderer#drawTile
+     * @name TMXRenderer#drawTile
      * @public
      * @function
-     * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
      * @param {number} x X coordinate where to draw the tile
      * @param {number} y Y coordinate where to draw the tile
-     * @param {me.Tile} tile the tile object to draw
+     * @param {Tile} tile the tile object to draw
      */
     drawTile(renderer, x, y, tile) {
     }
 
     /**
      * draw the given TMX Layer for the given area
-     * @name me.TMXRenderer#drawTileLayer
+     * @name TMXRenderer#drawTileLayer
      * @public
      * @function
-     * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
-     * @param {me.TMXLayer} layer a TMX Layer object
-     * @param {me.Rect} rect the area of the layer to draw
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
+     * @param {TMXLayer} layer a TMX Layer object
+     * @param {Rect} rect the area of the layer to draw
      */
     drawTileLayer(renderer, layer, rect) {
     }

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

@@ -7,10 +7,7 @@ import { degToRad } from "./../../../math/math.js";
 /**
  * @classdesc
  * a Staggered Map Renderder
- * @class TMXStaggeredRenderer
- * @memberof me
- * @augments me.TMXHexagonalRenderer
- * @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,7 +576,7 @@ var loader = {
     /**
      * unload specified resource to free memory
      * @name unload
-     * @memberof me.loader
+     * @memberof loader
      * @public
      * @function
      * @param {object} res
@@ -639,7 +638,7 @@ var loader = {
     /**
      * unload all resources to free memory
      * @name unloadAll
-     * @memberof me.loader
+     * @memberof loader
      * @public
      * @function
      * @example me.loader.unloadAll();
@@ -694,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");
@@ -712,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");
@@ -730,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");
@@ -749,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,7 +117,6 @@ class IconLogo extends Renderable {
 
 /**
  * a default loading screen
- * @memberof me
  * @ignore
  */
 class DefaultLoadingScreen extends Stage {
@@ -129,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,17 +172,16 @@ var cssToRGB = new Map();
 /**
  * @classdesc
  * A color manipulation object.
- * @class Color
- * @memberof me
- * @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);
     }
 
     /**
@@ -203,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);
     }
@@ -220,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);
     }
@@ -237,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;
     }
@@ -253,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];
     }
@@ -270,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;
@@ -294,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) {
@@ -322,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);
@@ -339,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);
@@ -356,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);
@@ -374,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);
@@ -391,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) {
@@ -417,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) {
@@ -435,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
@@ -453,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
@@ -473,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
@@ -533,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;
@@ -550,7 +531,7 @@ class Color {
     /**
      * return an array representation of this object
      * @name toArray
-     * @memberof me.Color
+     * @memberof Color
      * @function
      * @returns {Float32Array}
      */
@@ -562,7 +543,7 @@ class Color {
     /**
      * Get the color in "#RRGGBB" format
      * @name toHex
-     * @memberof me.Color
+     * @memberof Color
      * @function
      * @returns {string}
      */
@@ -576,7 +557,7 @@ class Color {
     /**
      * Get the color in "#RRGGBBAA" format
      * @name toHex8
-     * @memberof me.Color
+     * @memberof Color
      * @function
      * @returns {string}
      */
@@ -590,7 +571,7 @@ class Color {
     /**
      * Get the color in "rgb(R,G,B)" format
      * @name toRGB
-     * @memberof me.Color
+     * @memberof Color
      * @function
      * @returns {string}
      */
@@ -608,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}
      */