melonjs 10.2.0 → 10.3.0

package/src/level/tiled/TMXUtils.js

@@ -76,6 +76,9 @@ function setTMXValue(name, type, value) {
     return value;
 }
 
+/**
+ * @ignore
+ */
 function parseAttributes(obj, elt) {
     // do attributes
     if (elt.attributes && elt.attributes.length > 0) {
@@ -97,9 +100,8 @@ function parseAttributes(obj, elt) {
  * @ignore
  * @function
  * @name decompress
- * @param  {Number[]} data Array of bytes
- * @param  {String} format compressed data format ("gzip","zlib")
- * @return {Number[]} Decompressed data
+ * @param  {number[]} data Array of bytes
+ * @param  {string} format compressed data format ("gzip","zlib")
  */
 export function decompress() {
     throw new Error("GZIP/ZLIB compressed TMX Tile Map not supported!");
@@ -110,8 +112,8 @@ export function decompress() {
  * @ignore
  * @function
  * @name decodeCSV
- * @param  {String} input CSV formatted data (only numbers, everything else will be converted to NaN)
- * @return {Number[]} Decoded data
+ * @param  {string} input CSV formatted data (only numbers, everything else will be converted to NaN)
+ * @returns {number[]} Decoded data
  */
 export function decodeCSV(input) {
     var entries = input.replace("\n", "").trim().split(",");
@@ -128,9 +130,9 @@ export function decodeCSV(input) {
  * @ignore
  * @function
  * @name decodeBase64AsArray
- * @param {String} input Base64 encoded data
- * @param {Number} [bytes] number of bytes per array entry
- * @return {Uint32Array} Decoded data
+ * @param {string} input Base64 encoded data
+ * @param {number} [bytes] number of bytes per array entry
+ * @returns {Uint32Array} Decoded data
  */
 export function decodeBase64AsArray(input, bytes) {
     bytes = bytes || 1;
@@ -149,9 +151,9 @@ export function decodeBase64AsArray(input, bytes) {
 };
 
 /**
-* Decode the given data
-* @ignore
-*/
+ * Decode the given data
+ * @ignore
+ */
 export function decode(data, encoding, compression) {
     compression = compression || "none";
     encoding = encoding || "none";

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

@@ -23,9 +23,8 @@ var offsetsStaggerY = [
  * @classdesc
  * an Hexagonal Map Renderder
  * @class TMXHexagonalRenderer
- * @memberOf me
- * @extends me.TMXRenderer
- * @constructor
+ * @memberof me
+ * @augments me.TMXRenderer
  * @param {me.TMXTileMap} map the TMX map
  */
 class TMXHexagonalRenderer extends TMXRenderer {
@@ -85,7 +84,7 @@ class TMXHexagonalRenderer extends TMXRenderer {
      * @public
      * @function
      * @param {me.TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
-     * @return {me.Bounds}
+     * @returns {me.Bounds}
      */
     getBounds(layer) {
         var bounds = layer instanceof TMXLayer ? pool.pull("Bounds") : this.bounds;

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

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

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

@@ -6,9 +6,8 @@ import TMXRenderer from "./TMXRenderer.js";
  * @classdesc
  * an Orthogonal Map Renderder
  * @class TMXOrthogonalRenderer
- * @memberOf me
- * @extends me.TMXRenderer
- * @constructor
+ * @memberof me
+ * @augments me.TMXRenderer
  * @param {me.TMXTileMap} map the TMX map
  */
 class TMXOrthogonalRenderer extends TMXRenderer {

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

@@ -8,12 +8,11 @@ import Bounds from "./../../../physics/Bounds.js";
  * @classdesc
  * The map renderer base class
  * @class TMXRenderer
- * @memberOf me
- * @constructor
- * @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
+ * @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 {
 
@@ -31,7 +30,7 @@ class TMXRenderer {
      * @public
      * @function
      * @param {me.TMXTileMap|me.TMXLayer} component TMX Map or Layer
-     * @return {boolean}
+     * @returns {boolean}
      */
     canRender(component) {
         return (
@@ -52,7 +51,7 @@ class TMXRenderer {
      * @public
      * @function
      * @param {me.TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
-     * @return {me.Bounds}
+     * @returns {me.Bounds}
      */
     getBounds(layer) {
         var bounds = layer instanceof TMXLayer ? pool.pull("Bounds") : this.bounds;
@@ -69,10 +68,10 @@ class TMXRenderer {
      * @name me.TMXRenderer#pixelToTileCoords
      * @public
      * @function
-     * @param {Number} x X coordinate
-     * @param {Number} y Y coordinate
-     * @param {me.Vector2d} [vector] an optional vector object where to put the return values
-     * @return {me.Vector2d}
+     * @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}
      */
     pixelToTileCoords(x, y, v) {
         return v;
@@ -83,12 +82,12 @@ class TMXRenderer {
      * @name me.TMXRenderer#tileToPixelCoords
      * @public
      * @function
-     * @param {Number} col tile horizontal position
-     * @param {Number} row tile vertical position
-     * @param {me.Vector2d} [vector] an optional vector object where to put the return values
-     * @return {me.Vector2d}
+     * @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}
      */
-    tileToPixelCoords(x, y, v) {
+    tileToPixelCoords(col, row, v) {
         return v;
     }
 
@@ -98,8 +97,8 @@ class TMXRenderer {
      * @public
      * @function
      * @param {me.CanvasRenderer|me.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 {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
      */
     drawTile(renderer, x, y, tile) {

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

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

package/src/loader/loader.js

@@ -102,6 +102,9 @@ function preloadFontFace(data, onload, onerror) {
  * @ignore
  */
 function preloadTMX(tmxData, onload, onerror) {
+    /**
+     * @ignore
+     */
     function addToTMXList(data) {
         // set the TMX content
         tmxList[tmxData.name] = data;
@@ -291,7 +294,7 @@ function preloadJavascript(data, onload, onerror) {
 /**
  * a small class to manage loading of stuff and manage resources
  * @namespace loader
- * @memberOf me
+ * @memberof me
  */
 var loader = {
 
@@ -310,7 +313,7 @@ var loader = {
      * @public
      * @function
      * @name onload
-     * @memberOf me.loader
+     * @memberof me.loader
      * @example
      * // set a callback when everything is loaded
      * me.loader.onload = this.loaded.bind(this);
@@ -324,7 +327,7 @@ var loader = {
      * @public
      * @function
      * @name onProgress
-     * @memberOf me.loader
+     * @memberof me.loader
      * @example
      * // set a callback for progress notification
      * me.loader.onProgress = this.updateProgress.bind(this);
@@ -337,10 +340,10 @@ var loader = {
      * The "anonymous" keyword means that there will be no exchange of user credentials via cookies,
      * client-side SSL certificates or HTTP authentication as described in the Terminology section of the CORS specification.<br>
      * @public
-     * @type String
+     * @type {string}
      * @name crossOrigin
      * @default undefined
-     * @memberOf me.loader
+     * @memberof me.loader
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes
      * @example
      *  // allow for cross-origin texture loading in WebGL
@@ -355,10 +358,10 @@ var loader = {
      * indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies,
      * authorization headers or TLS client certificates. Setting withCredentials has no effect on same-site requests.
      * @public
-     * @type Boolean
+     * @type {boolean}
      * @name withCredentials
      * @default false
-     * @memberOf me.loader
+     * @memberof me.loader
      * @see https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials
      * @example
      *  // enable withCredentials
@@ -408,11 +411,11 @@ 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 me.loader
      * @public
      * @function
-     * @param {String} type  "*", "audio", binary", "image", "json", "js", "tmx", "tsx"
-     * @param {String} [url="./"] default base URL
+     * @param {string} type  "*", "audio", binary", "image", "json", "js", "tmx", "tsx"
+     * @param {string} [url="./"] default base URL
      * @example
      * // change the base URL relative address for audio assets
      * me.loader.setBaseURL("audio", "data/audio/");
@@ -439,15 +442,15 @@ var loader = {
     /**
      * set all the specified game resources to be preloaded.
      * @name preload
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
-     * @param {Object[]} resources
-     * @param {String} resources.name internal name of the resource
-     * @param {String} resources.type  "audio", binary", "image", "json","js", "tmx", "tsx", "fontface"
-     * @param {String} resources.src  path and/or file name of the resource (for audio assets only the path is required)
-     * @param {Boolean} [resources.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 {object[]} res
+     * @param {string} res.name internal name of the resource
+     * @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 {boolean} [switchToLoadState=true] automatically switch to the loading screen
      * @example
      * game_resources = [
@@ -504,16 +507,17 @@ 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 me.loader
      * @public
      * @function
-     * @param {Object} resource
-     * @param {String} resource.name internal name of the resource
-     * @param {String} resource.type  "audio", binary", "image", "json", "tmx", "tsx"
-     * @param {String} resource.src  path and/or file name of the resource (for audio assets only the path is required)
-     * @param {Boolean} [resource.stream] Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
+     * @param {object} res
+     * @param {string} res.name internal name of the resource
+     * @param {string} res.type  "audio", binary", "image", "json", "tmx", "tsx"
+     * @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 function to be called when the resource is loaded
      * @param {Function} onerror function to be called in case of error
+     * @returns {number} the amount of corresponding resource to be preloaded
      * @example
      * // load an image asset
      * me.loader.load({name: "avatar",  type:"image",  src: "data/avatar.png"}, this.onload.bind(this), this.onerror.bind(this));
@@ -573,12 +577,14 @@ var loader = {
     /**
      * unload specified resource to free memory
      * @name unload
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
-     * @param {Object} resource
-     * @return {Boolean} true if unloaded
-     * @example me.loader.unload({name: "avatar",  type:"image",  src: "data/avatar.png"});
+     * @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"});
      */
     unload(res) {
         switch (res.type) {
@@ -633,7 +639,7 @@ var loader = {
     /**
      * unload all resources to free memory
      * @name unloadAll
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
      * @example me.loader.unloadAll();
@@ -688,11 +694,11 @@ var loader = {
     /**
      * return the specified TMX/TSX object
      * @name getTMX
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
-     * @param {String} tmx name of the tmx/tsx element ("map1");
-     * @return {XML|Object} requested element or null if not found
+     * @param {string} elt name of the tmx/tsx element ("map1");
+     * @returns {object} requested element or null if not found
      */
     getTMX(elt) {
         // force as string
@@ -706,11 +712,11 @@ var loader = {
     /**
      * return the specified Binary object
      * @name getBinary
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
-     * @param {String} name of the binary object ("ymTrack");
-     * @return {Object} requested element or null if not found
+     * @param {string} elt name of the binary object ("ymTrack");
+     * @returns {object} requested element or null if not found
      */
     getBinary(elt) {
         // force as string
@@ -724,11 +730,11 @@ var loader = {
     /**
      * return the specified Image Object
      * @name getImage
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
-     * @param {String} image name of the Image element ("tileset-platformer");
-     * @return {HTMLImageElement} requested element or null if not found
+     * @param {string} image name of the Image element ("tileset-platformer");
+     * @returns {HTMLImageElement} requested element or null if not found
      */
     getImage(image) {
         // force as string and extract the base name
@@ -743,11 +749,11 @@ var loader = {
     /**
      * return the specified JSON Object
      * @name getJSON
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
-     * @param {String} Name for the json file to load
-     * @return {Object}
+     * @param {string} elt name of the json file to load
+     * @returns {object}
      */
     getJSON(elt) {
         // force as string

package/src/loader/loadingscreen.js

@@ -71,9 +71,10 @@ class IconLogo extends Renderable {
         super(x, y, 100, 85);
 
         this.iconCanvas = createCanvas(
-            nextPowerOfTwo(this.width),
-            nextPowerOfTwo(this.height),
-        false);
+            renderer.WebGLVersion > 1 ? this.width : nextPowerOfTwo(this.width),
+            renderer.WebGLVersion > 1 ? this.height : nextPowerOfTwo(this.height),
+            false
+        );
 
         var context = renderer.getContext2d(this.iconCanvas);
 
@@ -117,9 +118,8 @@ class IconLogo extends Renderable {
 
 /**
  * a default loading screen
- * @memberOf me
+ * @memberof me
  * @ignore
- * @constructor
  */
 class DefaultLoadingScreen extends Stage {
     /**
@@ -156,7 +156,7 @@ class DefaultLoadingScreen extends Stage {
                 textAlign: "left",
                 textBaseline : "top",
                 text: "melon",
-                offScreenCanvas: true
+                offScreenCanvas: renderer.WebGLVersion >= 1
             }
         );
         logo1.anchorPoint.set(0, 0);
@@ -171,7 +171,7 @@ class DefaultLoadingScreen extends Stage {
                 textBaseline : "top",
                 bold: true,
                 text: "JS",
-                offScreenCanvas: true
+                offScreenCanvas: renderer.WebGLVersion >= 1
             }
         );
         logo2.anchorPoint.set(0, 0);