melonjs 10.2.0 → 10.3.0

package/src/lang/deprecated.js

@@ -1,18 +1,16 @@
+import device from "./../system/device.js";
+import { requestPointerLock, exitPointerLock } from "./../input/input.js";
+
 /**
  * placeholder for all deprecated classes and corresponding alias for backward compatibility
- * @namespace deprecated
- * @memberOf me
  */
 
 /**
  * display a deprecation warning in the console
- * @public
- * @function
- * @memberOf me.deprecated
- * @name warning
- * @param {String} deprecated deprecated class,function or property name
- * @param {String} replacement the replacement class, function, or property name
- * @param {String} version the version since when the lass,function or property is deprecated
+ * @ignore
+ * @param {string} deprecated deprecated class,function or property name
+ * @param {string} replacement the replacement class, function, or property name
+ * @param {string} version the version since when the lass,function or property is deprecated
  */
 export function warning(deprecated, replacement, version) {
     var msg = "melonJS: %s is deprecated since version %s, please use %s";
@@ -42,17 +40,30 @@ export function warning(deprecated, replacement, version) {
     if (console.groupCollapsed) {
         console.groupEnd();
     }
-
-
 };
 
+/**
+ * @public
+ * @type {Function}
+ * @name turnOnPointerLock
+ * @memberof me.device
+ * @deprecated since 10.3.0
+ * @see me.input.requestPointerLock
+ */
+device.turnOnPointerLock = function () {
+    warning("me.device.turnOnPointerLock()", "me.input.requestPointerLock()", "10.3.0");
+    return requestPointerLock();
+};
 
 /**
- * Backward compatibility for deprecated method or properties are automatically
- * applied when automatically generating an UMD bundle (which is the default since version 9.0).
- * @memberof me.deprecated
- * @function apply
+ * @public
+ * @type {Function}
+ * @name turnOffPointerLock
+ * @memberof me.device
+ * @deprecated since 10.3.0
+ * @see me.input.exitPointerLock
  */
- export function apply() {
-     ;
- };
+device.turnOffPointerLock = function () {
+    warning("me.device.turnOffPointerLock()", "me.input.exitPointerLock()", "10.3.0");
+    return exitPointerLock();
+};

package/src/level/level.js

@@ -13,6 +13,9 @@ var levelIdx = [];
 // current level index
 var currentLevelIdx = 0;
 
+/**
+ * @ignore
+ */
 function safeLoadLevel(levelId, options, restart) {
     // clean the destination container
     options.container.reset();
@@ -46,10 +49,10 @@ function safeLoadLevel(levelId, options, restart) {
 /**
  * Load a TMX level
  * @name loadTMXLevel
- * @memberOf me.level
+ * @memberof me.level
  * @private
- * @param {String} level level id
- * @param {me.Container} target container
+ * @param {string} levelId level id
+ * @param {me.Container} container target container
  * @param {boolean} [flatten=true] if true, flatten all objects into the given container
  * @param {boolean} [setViewportBounds=false] if true, set the viewport bounds to the map size, this should be set to true especially if adding a level to the game world container.
  * @ignore
@@ -73,7 +76,7 @@ function loadTMXLevel(levelId, container, flatten, setViewportBounds) {
 /**
  * a level manager. once ressources loaded, the level manager contains all references of defined levels.
  * @namespace level
- * @memberOf me
+ * @memberof me
  */
 
 var level = {
@@ -81,13 +84,13 @@ var level = {
     /**
      * add a level into the game manager (usually called by the preloader)
      * @name add
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
-     * @param {String} format level format (only "tmx" supported)
-     * @param {String} levelId the level id (or name)
+     * @param {string} format level format (only "tmx" supported)
+     * @param {string} levelId the level id (or name)
      * @param {Function} [callback] a function to be called once the level is loaded
-     * @return {Boolean} true if the level was loaded
+     * @returns {boolean} true if the level was loaded
      */
     add(format, levelId, callback) {
         switch (format) {
@@ -120,15 +123,16 @@ var level = {
      * load a level into the game manager<br>
      * (will also create all level defined entities, etc..)
      * @name load
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
-     * @param {String} level level id
-     * @param {Object} [options] additional optional parameters
+     * @param {string} levelId level id
+     * @param {object} [options] additional optional parameters
      * @param {me.Container} [options.container=me.game.world] container in which to load the specified level
-     * @param {function} [options.onLoaded=me.game.onLevelLoaded] callback for when the level is fully loaded
+     * @param {Function} [options.onLoaded=me.game.onLevelLoaded] callback for when the level is fully loaded
      * @param {boolean} [options.flatten=me.game.mergeGroup] if true, flatten all objects into the given container
      * @param {boolean} [options.setViewportBounds=true] if true, set the viewport bounds to the map size
+     * @returns {boolean} true if the level was successfully loaded
      * @example
      * // the game assets to be be preloaded
      * // TMX maps
@@ -193,10 +197,10 @@ var level = {
     /**
      * return the current level id<br>
      * @name getCurrentLevelId
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
-     * @return {String}
+     * @returns {string}
      */
     getCurrentLevelId() {
         return levelIdx[currentLevelIdx];
@@ -207,10 +211,10 @@ var level = {
      * for a reference to the live instantiated level,
      * rather use the container in which it was loaded (e.g. me.game.world)
      * @name getCurrentLevel
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
-     * @return {me.TMXTileMap}
+     * @returns {me.TMXTileMap}
      */
     getCurrentLevel() {
         return levels[this.getCurrentLevelId()];
@@ -219,13 +223,14 @@ var level = {
     /**
      * reload the current level
      * @name reload
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
-     * @param {Object} [options] additional optional parameters
+     * @param {object} [options] additional optional parameters
      * @param {me.Container} [options.container=me.game.world] container in which to load the specified level
-     * @param {function} [options.onLoaded=me.game.onLevelLoaded] callback for when the level is fully loaded
+     * @param {Function} [options.onLoaded=me.game.onLevelLoaded] callback for when the level is fully loaded
      * @param {boolean} [options.flatten=me.game.mergeGroup] if true, flatten all objects into the given container
+     * @returns {object} the current level
      */
     reload(options) {
         // reset the level to initial state
@@ -236,13 +241,14 @@ var level = {
     /**
      * load the next level
      * @name next
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
-     * @param {Object} [options] additional optional parameters
+     * @param {object} [options] additional optional parameters
      * @param {me.Container} [options.container=me.game.world] container in which to load the specified level
-     * @param {function} [options.onLoaded=me.game.onLevelLoaded] callback for when the level is fully loaded
+     * @param {Function} [options.onLoaded=me.game.onLevelLoaded] callback for when the level is fully loaded
      * @param {boolean} [options.flatten=me.game.mergeGroup] if true, flatten all objects into the given container
+     * @returns {boolean} true if the next level was successfully loaded
      */
     next(options) {
         //go to the next level
@@ -257,13 +263,14 @@ var level = {
     /**
      * load the previous level<br>
      * @name previous
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
-     * @param {Object} [options] additional optional parameters
+     * @param {object} [options] additional optional parameters
      * @param {me.Container} [options.container=me.game.world] container in which to load the specified level
-     * @param {function} [options.onLoaded=me.game.onLevelLoaded] callback for when the level is fully loaded
+     * @param {Function} [options.onLoaded=me.game.onLevelLoaded] callback for when the level is fully loaded
      * @param {boolean} [options.flatten=me.game.mergeGroup] if true, flatten all objects into the given container
+     * @returns {boolean} true if the previous level was successfully loaded
      */
     previous(options) {
         // go to previous level
@@ -278,9 +285,10 @@ var level = {
     /**
      * return the amount of level preloaded
      * @name levelCount
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
+     * @returns {number} the amount of level preloaded
      */
     levelCount() {
         return levelIdx.length;

package/src/level/tiled/TMXGroup.js

@@ -8,7 +8,6 @@ import { clamp } from "./../../math/math.js";
  * object group definition as defined in Tiled.
  * (group definition is translated into the virtual `me.game.world` using `me.Container`)
  * @class TMXGroup
- * @constructor
  * @ignore
  */
 export default class TMXGroup {
@@ -18,45 +17,45 @@ export default class TMXGroup {
         /**
          * group name
          * @public
-         * @type String
+         * @type {string}
          * @name name
-         * @memberOf me.TMXGroup
+         * @memberof me.TMXGroup
          */
         this.name = data.name;
 
         /**
          * group width
          * @public
-         * @type Number
+         * @type {number}
          * @name width
-         * @memberOf me.TMXGroup
+         * @memberof me.TMXGroup
          */
         this.width = data.width || 0;
 
         /**
          * group height
          * @public
-         * @type Number
+         * @type {number}
          * @name height
-         * @memberOf me.TMXGroup
+         * @memberof me.TMXGroup
          */
         this.height = data.height || 0;
 
         /**
          * tint color
          * @public
-         * @type String
+         * @type {string}
          * @name tintcolor
-         * @memberOf me.TMXGroup
+         * @memberof me.TMXGroup
          */
         this.tintcolor = data.tintcolor;
 
         /**
          * group z order
          * @public
-         * @type Number
+         * @type {number}
          * @name z
-         * @memberOf me.TMXGroup
+         * @memberof me.TMXGroup
          */
         this.z = z;
 
@@ -64,9 +63,9 @@ export default class TMXGroup {
          * group objects list definition
          * @see me.TMXObject
          * @public
-         * @type Array
+         * @type {object[]}
          * @name name
-         * @memberOf me.TMXGroup
+         * @memberof me.TMXGroup
          */
         this.objects = [];
 

package/src/level/tiled/TMXLayer.js

@@ -66,16 +66,15 @@ function preRenderLayer(layer, renderer) {
  * a TMX Tile Layer Object
  * Tiled QT 0.7.x format
  * @class
- * @extends me.Renderable
- * @memberOf me
- * @constructor
- * @param {Object} map layer data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#layer})
- * @param {Object} data layer data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#layer})
- * @param {Number} tilewidth width of each tile in pixels
- * @param {Number} tileheight height of each tile in pixels
- * @param {String} orientation "isometric" or "orthogonal"
+ * @augments me.Renderable
+ * @memberof me
+ * @param {object} map layer data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#layer})
+ * @param {object} data layer data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#layer})
+ * @param {number} tilewidth width of each tile in pixels
+ * @param {number} tileheight height of each tile in pixels
+ * @param {string} orientation "isometric" or "orthogonal"
  * @param {me.TMXTilesetGroup} tilesets tileset as defined in Tiled
- * @param {Number} z z-index position
+ * @param {number} z z-index position
  */
 class TMXLayer extends Renderable {
     /**
@@ -95,7 +94,7 @@ class TMXLayer extends Renderable {
         /**
          * The Layer corresponding Tilesets
          * @public
-         * @type me.TMXTilesetGroup
+         * @type {me.TMXTilesetGroup}
          * @name me.TMXLayer#tilesets
          */
         this.tilesets = tilesets;
@@ -118,7 +117,7 @@ class TMXLayer extends Renderable {
         /**
          * All animated tilesets in this layer
          * @ignore
-         * @type Array
+         * @type {me.TMXTileset[]}
          * @name me.TMXLayer#animatedTilesets
          */
         this.animatedTilesets = [];
@@ -126,7 +125,7 @@ class TMXLayer extends Renderable {
         /**
          * Layer contains tileset animations
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name me.TMXLayer#isAnimated
          */
         this.isAnimated = false;
@@ -135,7 +134,7 @@ class TMXLayer extends Renderable {
          * the order in which tiles on orthogonal tile layers are rendered.
          * (valid values are "left-down", "left-up", "right-down", "right-up")
          * @public
-         * @type {String}
+         * @type {string}
          * @default "right-down"
          * @name me.TMXLayer#renderorder
          */
@@ -243,7 +242,7 @@ class TMXLayer extends Renderable {
     /**
      * Set the TMX renderer for this layer object
      * @name setRenderer
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
      * @param {me.TMXRenderer} renderer
@@ -259,10 +258,10 @@ class TMXLayer extends Renderable {
     /**
      * Return the layer current renderer object
      * @name getRenderer
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
-     * @return {me.TMXRenderer} renderer
+     * @returns {me.TMXRenderer} renderer
      */
     getRenderer() {
         return this.renderer;
@@ -272,12 +271,12 @@ class TMXLayer extends Renderable {
     /**
      * Return the TileId of the Tile at the specified position
      * @name getTileId
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
-     * @param {Number} x X coordinate (in world/pixels coordinates)
-     * @param {Number} y Y coordinate (in world/pixels coordinates)
-     * @return {Number} TileId or null if there is no Tile at the given position
+     * @param {number} x X coordinate (in world/pixels coordinates)
+     * @param {number} y Y coordinate (in world/pixels coordinates)
+     * @returns {number} TileId or null if there is no Tile at the given position
      */
     getTileId(x, y) {
         var tile = this.getTile(x, y);
@@ -287,12 +286,12 @@ class TMXLayer extends Renderable {
     /**
      * Return the Tile object at the specified position
      * @name getTile
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
-     * @param {Number} x X coordinate (in world/pixels coordinates)
-     * @param {Number} y Y coordinate (in world/pixels coordinates)
-     * @return {me.Tile} corresponding tile or null if there is no defined tile at the coordinate or if outside of the layer bounds
+     * @param {number} x X coordinate (in world/pixels coordinates)
+     * @param {number} y Y coordinate (in world/pixels coordinates)
+     * @returns {me.Tile} corresponding tile or null if there is no defined tile at the coordinate or if outside of the layer bounds
      * @example
      * // get the TMX Map Layer called "Front layer"
      * var layer = me.game.world.getChildByName("Front Layer")[0];
@@ -313,13 +312,13 @@ class TMXLayer extends Renderable {
     /**
      * assign the given Tile object to the specified position
      * @name getTile
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
-     * @return {me.Tile} a Tile object
-     * @param {Number} x X coordinate (in world/pixels coordinates)
-     * @param {Number} y Y coordinate (in world/pixels coordinates)
-     * @return {me.Tile} the tile object
+     * @param {me.Tile} tile the tile object to be assigned
+     * @param {number} x x coordinate (in world/pixels coordinates)
+     * @param {number} y y coordinate (in world/pixels coordinates)
+     * @returns {me.Tile} the tile object
      */
     setTile(tile, x, y) {
         this.layerData[x][y] = tile;
@@ -329,13 +328,13 @@ class TMXLayer extends Renderable {
     /**
      * return a new the Tile object corresponding to the given tile id
      * @name setTile
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
-     * @param {Number} tileId tileId
-     * @param {Number} x X coordinate (in world/pixels coordinates)
-     * @param {Number} y Y coordinate (in world/pixels coordinates)
-     * @return {me.Tile} the tile object
+     * @param {number} tileId tileId
+     * @param {number} x X coordinate (in world/pixels coordinates)
+     * @param {number} y Y coordinate (in world/pixels coordinates)
+     * @returns {me.Tile} the tile object
      */
     getTileById(tileId, x, y) {
         if (!this.tileset.contains(tileId)) {
@@ -348,13 +347,13 @@ class TMXLayer extends Renderable {
     /**
      * Return the Tile object at the specified tile coordinates
      * @name cellAt
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
-     * @param {Number} x x position of the tile (in Tile unit)
-     * @param {Number} y x position of the tile (in Tile unit)
-     * @param {Number} [boundsCheck=true] check first if within the layer bounds
-     * @return {me.Tile} corresponding tile or null if there is no defined tile at the position or if outside of the layer bounds
+     * @param {number} x x position of the tile (in Tile unit)
+     * @param {number} y x position of the tile (in Tile unit)
+     * @param {number} [boundsCheck=true] check first if within the layer bounds
+     * @returns {me.Tile} corresponding tile or null if there is no defined tile at the position or if outside of the layer bounds
      * @example
      * // return the first tile at offset 0, 0
      * var tile = layer.cellAt(0, 0);
@@ -375,11 +374,11 @@ class TMXLayer extends Renderable {
     /**
      * clear the tile at the specified position
      * @name clearTile
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
-     * @param {Number} x X coordinate (in map coordinates: row/column)
-     * @param {Number} y Y coordinate (in map coordinates: row/column)
+     * @param {number} x X coordinate (in map coordinates: row/column)
+     * @param {number} y Y coordinate (in map coordinates: row/column)
      * @example
      * me.game.world.getChildByType(me.TMXLayer).forEach(function(layer) {
      *     // clear all tiles at the given x,y coordinates