melonjs 10.3.0 → 10.4.0

package/src/input/pointerevent.js

@@ -14,7 +14,7 @@ import { world, viewport } from "./../game.js";
 
 /**
  * A pool of `Pointer` objects to cache pointer/touch event coordinates.
- * @type {Array.<me.Vector2d>}
+ * @type {Array.<Vector2d>}
  * @ignore
  */
 var T_POINTERS = [];
@@ -503,16 +503,16 @@ function onPointerEvent(e) {
   * @public
   * @type {EventTarget}
   * @name pointerEventTarget
-  * @memberof me.input
+  * @memberof input
   */
  export var pointerEventTarget = null;
 
 /**
  * Pointer information (current position and size)
  * @public
- * @type {me.Rect}
+ * @type {Rect}
  * @name pointer
- * @memberof me.input
+ * @memberof input
  */
 export var pointer = new Pointer(0, 0, 1, 1);
 
@@ -522,7 +522,7 @@ export var pointer = new Pointer(0, 0, 1, 1);
  * @public
  * @type {boolean}
  * @name locked
- * @memberof me.input
+ * @memberof input
  */
 export var locked = false;
 
@@ -533,7 +533,7 @@ export var locked = false;
  * @public
  * @type {number}
  * @name throttlingInterval
- * @memberof me.input
+ * @memberof input
  */
 export var throttlingInterval;
 
@@ -541,13 +541,13 @@ export var throttlingInterval;
  * Translate the specified x and y values from the global (absolute)
  * coordinate to local (viewport) relative coordinate.
  * @name globalToLocal
- * @memberof me.input
+ * @memberof input
  * @public
  * @function
  * @param {number} x the global x coordinate to be translated.
  * @param {number} y the global y coordinate to be translated.
- * @param {me.Vector2d} [v] an optional vector object where to set the translated coordinates
- * @returns {me.Vector2d} A vector object with the corresponding translated coordinates
+ * @param {Vector2d} [v] an optional vector object where to set the translated coordinates
+ * @returns {Vector2d} A vector object with the corresponding translated coordinates
  * @example
  * onMouseEvent : function (pointer) {
  *    // convert the given into local (viewport) relative coordinates
@@ -573,7 +573,7 @@ export function globalToLocal(x, y, v) {
  * enable/disable all gestures on the given element.<br>
  * by default melonJS will disable browser handling of all panning and zooming gestures.
  * @name setTouchAction
- * @memberof me.input
+ * @memberof input
  * @see https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action
  * @public
  * @function
@@ -590,11 +590,11 @@ export function setTouchAction(element, value) {
  * Middle button – 1
  * Right button – 2
  * @name bindPointer
- * @memberof me.input
+ * @memberof input
  * @public
  * @function
- * @param {number} [button=me.input.pointer.LEFT] (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
- * @param {me.input.KEY} keyCode
+ * @param {number} [button=input.pointer.LEFT] (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
+ * @param {input.KEY} keyCode
  * @example
  * // enable the keyboard
  * me.input.bindKey(me.input.KEY.X, "shoot");
@@ -621,10 +621,10 @@ export function bindPointer() {
 /**
  * unbind the defined keycode
  * @name unbindPointer
- * @memberof me.input
+ * @memberof input
  * @public
  * @function
- * @param {number} [button=me.input.pointer.LEFT] (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
+ * @param {number} [button=input.pointer.LEFT] (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
  * @example
  * me.input.unbindPointer(me.input.pointer.LEFT);
  */
@@ -640,10 +640,10 @@ export function unbindPointer(button) {
 /**
  * allows registration of event listeners on the object target. <br>
  * melonJS will pass a me.Pointer object to the defined callback.
- * @see me.Pointer
+ * @see Pointer
  * @see {@link http://www.w3.org/TR/pointerevents/#list-of-pointer-events|W3C Pointer Event list}
  * @name registerPointerEvent
- * @memberof me.input
+ * @memberof input
  * @public
  * @function
  * @param {string} eventType The event type for which the object is registering <br>
@@ -658,7 +658,7 @@ export function unbindPointer(button) {
  *   <li><code>"pointercancel"</code></li>
  *   <li><code>"wheel"</code></li>
  * </ul>
- * @param {me.Rect|me.Polygon|me.Line|me.Ellipse} region a shape representing the region to register on
+ * @param {Rect|Polygon|Line|Ellipse} region a shape representing the region to register on
  * @param {Function} callback methods to be called when the event occurs.
  * Returning `false` from the defined callback will prevent the event to be propagated to other objects
  * @example
@@ -715,11 +715,11 @@ export function registerPointerEvent(eventType, region, callback) {
  * allows the removal of event listeners from the object target.
  * @see {@link http://www.w3.org/TR/pointerevents/#list-of-pointer-events|W3C Pointer Event list}
  * @name releasePointerEvent
- * @memberof me.input
+ * @memberof input
  * @public
  * @function
- * @param {string} eventType The event type for which the object was registered. See {@link me.input.registerPointerEvent}
- * @param {me.Rect|me.Polygon|me.Line|me.Ellipse} region the registered region to release for this event
+ * @param {string} eventType The event type for which the object was registered. See {@link input.registerPointerEvent}
+ * @param {Rect|Polygon|Line|Ellipse} region the registered region to release for this event
  * @param {Function} [callback="all"] if specified unregister the event only for the specific callback
  * @example
  * // release the registered region on the 'pointerdown' event
@@ -760,10 +760,10 @@ export function releasePointerEvent(eventType, region, callback) {
 /**
  * allows the removal of all registered event listeners from the object target.
  * @name releaseAllPointerEvents
- * @memberof me.input
+ * @memberof input
  * @public
  * @function
- * @param {me.Rect|me.Polygon|me.Line|me.Ellipse} region the registered region to release event from
+ * @param {Rect|Polygon|Line|Ellipse} region the registered region to release event from
  * @example
  * // release all registered event on the
  * me.input.releaseAllPointerEvents(this);
@@ -771,7 +771,7 @@ export function releasePointerEvent(eventType, region, callback) {
 export function releaseAllPointerEvents(region) {
     if (eventHandlers.has(region)) {
         for (var i = 0; i < pointerEventList.length; i++) {
-            this.releasePointerEvent(pointerEventList[i], region);
+            releasePointerEvent(pointerEventList[i], region);
         }
     };
 };
@@ -780,7 +780,7 @@ export function releaseAllPointerEvents(region) {
  * request for the pointer to be locked on the parent DOM element.
  * (Must be called in a click event or an event that requires user interaction)
  * @name requestPointerLock
- * @memberof me.input
+ * @memberof input
  * @public
  * @function
  * @param {Function} [success] callback if the request is successful
@@ -805,7 +805,7 @@ export function requestPointerLock() {
 /**
  * Initiates an exit from pointer lock state
  * @name exitPointerLock
- * @memberof me.input
+ * @memberof input
  * @public
  * @function
  * @returns {boolean} return true if the request was successfully submitted

package/src/lang/deprecated.js

@@ -1,5 +1,7 @@
 import device from "./../system/device.js";
 import { requestPointerLock, exitPointerLock } from "./../input/input.js";
+import { TextureAtlas } from "./../video/texture.js";
+import Renderer from "./../video/renderer.js";
 
 /**
  * placeholder for all deprecated classes and corresponding alias for backward compatibility
@@ -46,12 +48,12 @@ export function warning(deprecated, replacement, version) {
  * @public
  * @type {Function}
  * @name turnOnPointerLock
- * @memberof me.device
+ * @memberof device
  * @deprecated since 10.3.0
- * @see me.input.requestPointerLock
+ * @see input.requestPointerLock
  */
 device.turnOnPointerLock = function () {
-    warning("me.device.turnOnPointerLock()", "me.input.requestPointerLock()", "10.3.0");
+    warning("device.turnOnPointerLock()", "input.requestPointerLock()", "10.3.0");
     return requestPointerLock();
 };
 
@@ -59,11 +61,28 @@ device.turnOnPointerLock = function () {
  * @public
  * @type {Function}
  * @name turnOffPointerLock
- * @memberof me.device
+ * @memberof device
  * @deprecated since 10.3.0
- * @see me.input.exitPointerLock
+ * @see input.exitPointerLock
  */
 device.turnOffPointerLock = function () {
-    warning("me.device.turnOffPointerLock()", "me.input.exitPointerLock()", "10.3.0");
+    warning("device.turnOffPointerLock()", "input.exitPointerLock()", "10.3.0");
     return exitPointerLock();
 };
+
+/**
+ * @public
+ * @name Texture
+ * @memberof Renderer
+ * @deprecated since 10.4.0
+ * @see TextureAtlas
+ */
+Object.defineProperty(Renderer.prototype, "Texture", {
+    /**
+     * @ignore
+     */
+    get : function () {
+        warning("me.video.renderer.Texture", "me.TextureAtlas", "10.4.0");
+        return TextureAtlas;
+    }
+});

package/src/level/level.js

@@ -49,10 +49,10 @@ function safeLoadLevel(levelId, options, restart) {
 /**
  * Load a TMX level
  * @name loadTMXLevel
- * @memberof me.level
+ * @memberof level
  * @private
  * @param {string} levelId level id
- * @param {me.Container} container target container
+ * @param {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
@@ -76,7 +76,6 @@ 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
  */
 
 var level = {
@@ -84,7 +83,7 @@ var level = {
     /**
      * add a level into the game manager (usually called by the preloader)
      * @name add
-     * @memberof me.level
+     * @memberof level
      * @public
      * @function
      * @param {string} format level format (only "tmx" supported)
@@ -123,14 +122,14 @@ var level = {
      * load a level into the game manager<br>
      * (will also create all level defined entities, etc..)
      * @name load
-     * @memberof me.level
+     * @memberof level
      * @public
      * @function
      * @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 {boolean} [options.flatten=me.game.mergeGroup] if true, flatten all objects into the given container
+     * @param {Container} [options.container=game.world] container in which to load the specified level
+     * @param {Function} [options.onLoaded=ame.onLevelLoaded] callback for when the level is fully loaded
+     * @param {boolean} [options.flatten=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
@@ -197,7 +196,7 @@ var level = {
     /**
      * return the current level id<br>
      * @name getCurrentLevelId
-     * @memberof me.level
+     * @memberof level
      * @public
      * @function
      * @returns {string}
@@ -211,10 +210,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 level
      * @public
      * @function
-     * @returns {me.TMXTileMap}
+     * @returns {TMXTileMap}
      */
     getCurrentLevel() {
         return levels[this.getCurrentLevelId()];
@@ -223,13 +222,13 @@ var level = {
     /**
      * reload the current level
      * @name reload
-     * @memberof me.level
+     * @memberof level
      * @public
      * @function
      * @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 {boolean} [options.flatten=me.game.mergeGroup] if true, flatten all objects into the given container
+     * @param {Container} [options.container=game.world] container in which to load the specified level
+     * @param {Function} [options.onLoaded=game.onLevelLoaded] callback for when the level is fully loaded
+     * @param {boolean} [options.flatten=game.mergeGroup] if true, flatten all objects into the given container
      * @returns {object} the current level
      */
     reload(options) {
@@ -241,13 +240,13 @@ var level = {
     /**
      * load the next level
      * @name next
-     * @memberof me.level
+     * @memberof level
      * @public
      * @function
      * @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 {boolean} [options.flatten=me.game.mergeGroup] if true, flatten all objects into the given container
+     * @param {Container} [options.container=game.world] container in which to load the specified level
+     * @param {Function} [options.onLoaded=game.onLevelLoaded] callback for when the level is fully loaded
+     * @param {boolean} [options.flatten=game.mergeGroup] if true, flatten all objects into the given container
      * @returns {boolean} true if the next level was successfully loaded
      */
     next(options) {
@@ -263,13 +262,13 @@ var level = {
     /**
      * load the previous level<br>
      * @name previous
-     * @memberof me.level
+     * @memberof level
      * @public
      * @function
      * @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 {boolean} [options.flatten=me.game.mergeGroup] if true, flatten all objects into the given container
+     * @param {Container} [options.container=game.world] container in which to load the specified level
+     * @param {Function} [options.onLoaded=game.onLevelLoaded] callback for when the level is fully loaded
+     * @param {boolean} [options.flatten=game.mergeGroup] if true, flatten all objects into the given container
      * @returns {boolean} true if the previous level was successfully loaded
      */
     previous(options) {
@@ -285,7 +284,7 @@ var level = {
     /**
      * return the amount of level preloaded
      * @name levelCount
-     * @memberof me.level
+     * @memberof level
      * @public
      * @function
      * @returns {number} the amount of level preloaded

package/src/level/tiled/TMXGroup.js

@@ -7,7 +7,6 @@ import { clamp } from "./../../math/math.js";
  * @classdesc
  * object group definition as defined in Tiled.
  * (group definition is translated into the virtual `me.game.world` using `me.Container`)
- * @class TMXGroup
  * @ignore
  */
 export default class TMXGroup {
@@ -19,7 +18,7 @@ export default class TMXGroup {
          * @public
          * @type {string}
          * @name name
-         * @memberof me.TMXGroup
+         * @memberof TMXGroup
          */
         this.name = data.name;
 
@@ -28,7 +27,7 @@ export default class TMXGroup {
          * @public
          * @type {number}
          * @name width
-         * @memberof me.TMXGroup
+         * @memberof TMXGroup
          */
         this.width = data.width || 0;
 
@@ -37,7 +36,7 @@ export default class TMXGroup {
          * @public
          * @type {number}
          * @name height
-         * @memberof me.TMXGroup
+         * @memberof TMXGroup
          */
         this.height = data.height || 0;
 
@@ -46,7 +45,7 @@ export default class TMXGroup {
          * @public
          * @type {string}
          * @name tintcolor
-         * @memberof me.TMXGroup
+         * @memberof TMXGroup
          */
         this.tintcolor = data.tintcolor;
 
@@ -55,17 +54,17 @@ export default class TMXGroup {
          * @public
          * @type {number}
          * @name z
-         * @memberof me.TMXGroup
+         * @memberof TMXGroup
          */
         this.z = z;
 
         /**
          * group objects list definition
-         * @see me.TMXObject
+         * @see TMXObject
          * @public
          * @type {object[]}
          * @name name
-         * @memberof me.TMXGroup
+         * @memberof TMXGroup
          */
         this.objects = [];
 

package/src/level/tiled/TMXLayer.js

@@ -63,22 +63,20 @@ function preRenderLayer(layer, renderer) {
 }
 
 /**
+ * @classdesc
  * a TMX Tile Layer Object
  * Tiled QT 0.7.x format
- * @class
- * @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
+ * @augments Renderable
  */
 class TMXLayer extends Renderable {
     /**
-     * @ignore
+     * @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 {TMXTilesetGroup} tilesets tileset as defined in Tiled
+     * @param {number} z z-index position
      */
     constructor(map, data, tilewidth, tileheight, orientation, tilesets, z) {
         // super constructor
@@ -94,8 +92,8 @@ class TMXLayer extends Renderable {
         /**
          * The Layer corresponding Tilesets
          * @public
-         * @type {me.TMXTilesetGroup}
-         * @name me.TMXLayer#tilesets
+         * @type {TMXTilesetGroup}
+         * @name TMXLayer#tilesets
          */
         this.tilesets = tilesets;
 
@@ -117,8 +115,8 @@ class TMXLayer extends Renderable {
         /**
          * All animated tilesets in this layer
          * @ignore
-         * @type {me.TMXTileset[]}
-         * @name me.TMXLayer#animatedTilesets
+         * @type {TMXTileset[]}
+         * @name TMXLayer#animatedTilesets
          */
         this.animatedTilesets = [];
 
@@ -126,7 +124,7 @@ class TMXLayer extends Renderable {
          * Layer contains tileset animations
          * @public
          * @type {boolean}
-         * @name me.TMXLayer#isAnimated
+         * @name TMXLayer#isAnimated
          */
         this.isAnimated = false;
 
@@ -136,7 +134,7 @@ class TMXLayer extends Renderable {
          * @public
          * @type {string}
          * @default "right-down"
-         * @name me.TMXLayer#renderorder
+         * @name TMXLayer#renderorder
          */
         this.renderorder = data.renderorder || "right-down";
 
@@ -242,10 +240,10 @@ class TMXLayer extends Renderable {
     /**
      * Set the TMX renderer for this layer object
      * @name setRenderer
-     * @memberof me.TMXLayer
+     * @memberof TMXLayer
      * @public
      * @function
-     * @param {me.TMXRenderer} renderer
+     * @param {TMXRenderer} renderer
      * @example
      * // use the parent map default renderer
      * var layer = new me.TMXLayer(...);
@@ -258,10 +256,10 @@ class TMXLayer extends Renderable {
     /**
      * Return the layer current renderer object
      * @name getRenderer
-     * @memberof me.TMXLayer
+     * @memberof TMXLayer
      * @public
      * @function
-     * @returns {me.TMXRenderer} renderer
+     * @returns {TMXRenderer} renderer
      */
     getRenderer() {
         return this.renderer;
@@ -271,7 +269,7 @@ class TMXLayer extends Renderable {
     /**
      * Return the TileId of the Tile at the specified position
      * @name getTileId
-     * @memberof me.TMXLayer
+     * @memberof TMXLayer
      * @public
      * @function
      * @param {number} x X coordinate (in world/pixels coordinates)
@@ -286,12 +284,12 @@ class TMXLayer extends Renderable {
     /**
      * Return the Tile object at the specified position
      * @name getTile
-     * @memberof me.TMXLayer
+     * @memberof TMXLayer
      * @public
      * @function
      * @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
+     * @returns {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];
@@ -312,13 +310,13 @@ class TMXLayer extends Renderable {
     /**
      * assign the given Tile object to the specified position
      * @name getTile
-     * @memberof me.TMXLayer
+     * @memberof TMXLayer
      * @public
      * @function
-     * @param {me.Tile} tile the tile object to be assigned
+     * @param {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
+     * @returns {Tile} the tile object
      */
     setTile(tile, x, y) {
         this.layerData[x][y] = tile;
@@ -328,13 +326,13 @@ class TMXLayer extends Renderable {
     /**
      * return a new the Tile object corresponding to the given tile id
      * @name setTile
-     * @memberof me.TMXLayer
+     * @memberof 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)
-     * @returns {me.Tile} the tile object
+     * @returns {Tile} the tile object
      */
     getTileById(tileId, x, y) {
         if (!this.tileset.contains(tileId)) {
@@ -347,13 +345,13 @@ class TMXLayer extends Renderable {
     /**
      * Return the Tile object at the specified tile coordinates
      * @name cellAt
-     * @memberof me.TMXLayer
+     * @memberof 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
-     * @returns {me.Tile} corresponding tile or null if there is no defined tile at the position or if outside of the layer bounds
+     * @returns {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);
@@ -374,7 +372,7 @@ class TMXLayer extends Renderable {
     /**
      * clear the tile at the specified position
      * @name clearTile
-     * @memberof me.TMXLayer
+     * @memberof TMXLayer
      * @public
      * @function
      * @param {number} x X coordinate (in map coordinates: row/column)