melonjs 10.3.0 → 10.5.1

package/src/input/pointer.js

@@ -16,8 +16,7 @@ var tmpVec = new Vector2d();
  * @classdesc
  * a pointer object, representing a single finger on a touch enabled device.
  * @class Pointer
- * @augments me.Bounds
- * @memberof me
+ * @augments Bounds
  */
 class Pointer extends Bounds {
 
@@ -37,7 +36,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name LEFT
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.LEFT = 0;
 
@@ -46,7 +45,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name MIDDLE
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.MIDDLE = 1;
 
@@ -55,7 +54,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name RIGHT
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.RIGHT = 2;
 
@@ -67,7 +66,7 @@ class Pointer extends Bounds {
          * @see https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent
          * @see https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.event = undefined;
 
@@ -77,7 +76,7 @@ class Pointer extends Bounds {
          * @type {string}
          * @name type
          * @see https://developer.mozilla.org/en-US/docs/Web/API/Event/type
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.type = undefined;
 
@@ -88,7 +87,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name button
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.button = 0;
 
@@ -98,7 +97,7 @@ class Pointer extends Bounds {
          * @type {boolean}
          * @name isPrimary
          * @see https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/isPrimary
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.isPrimary = false;
 
@@ -108,7 +107,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name pageX
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/pageX
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.pageX = 0;
 
@@ -118,7 +117,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name pageY
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/pageY
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.pageY = 0;
 
@@ -128,7 +127,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name clientX
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/clientX
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.clientX = 0;
 
@@ -138,7 +137,7 @@ class Pointer extends Bounds {
         * @type {number}
         * @name clientY
         * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/clientY
-        * @memberof me.Pointer
+        * @memberof Pointer
         */
         this.clientY = 0;
 
@@ -148,7 +147,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name movementX
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/movementX
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.movementX = 0;
 
@@ -158,7 +157,7 @@ class Pointer extends Bounds {
         * @type {number}
         * @name movementY
         * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/movementY
-        * @memberof me.Pointer
+        * @memberof Pointer
         */
         this.movementY = 0;
 
@@ -168,7 +167,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name deltaMode
          * @see https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaMode
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.deltaMode = 0;
 
@@ -178,7 +177,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name deltaX
          * @see https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaX
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.deltaX = 0;
 
@@ -188,7 +187,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name deltaY
          * @see https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaY
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.deltaY = 0;
 
@@ -198,7 +197,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name deltaZ
          * @see https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaZ
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.deltaZ = 0;
 
@@ -208,7 +207,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameX
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.gameX = 0;
 
@@ -218,7 +217,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameY
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.gameY = 0;
 
@@ -227,7 +226,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameScreenX
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.gameScreenX = 0;
 
@@ -236,7 +235,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameScreenY
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.gameScreenY = 0;
 
@@ -245,7 +244,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameWorldX
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.gameWorldX = 0;
 
@@ -254,7 +253,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameWorldY
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.gameWorldY = 0;
 
@@ -263,7 +262,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameLocalX
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.gameLocalX = 0;
 
@@ -272,7 +271,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameLocalY
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.gameLocalY = 0;
 
@@ -281,7 +280,7 @@ class Pointer extends Bounds {
         * @public
         * @type {number}
         * @name pointerId
-        * @memberof me.Pointer
+        * @memberof Pointer
         * @see https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/pointerId
         */
         this.pointerId = undefined;
@@ -291,7 +290,7 @@ class Pointer extends Bounds {
          * @public
          * @type {boolean}
          * @name isNormalized
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.isNormalized = false;
 
@@ -300,7 +299,7 @@ class Pointer extends Bounds {
          * @public
          * @type {boolean}
          * @name locked
-         * @memberof me.Pointer
+         * @memberof Pointer
          */
         this.locked = false;
 
@@ -310,7 +309,7 @@ class Pointer extends Bounds {
 
     /**
      * initialize the Pointer object using the given Event Object
-     * @name me.Pointer#set
+     * @name Pointer#set
      * @private
      * @function
      * @param {Event} event the original Event object

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,8 @@
 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";
+import { Draggable, DropTarget } from "./../renderable/dragndrop.js";
 
 /**
  * placeholder for all deprecated classes and corresponding alias for backward compatibility
@@ -46,12 +49,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 +62,67 @@ 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;
+    }
+});
+
+
+/**
+ * @classdesc
+ * Used to make a game entity draggable
+ * @augments Entity
+ * @deprecated since 10.5.0
+ * @see Draggable
+ */
+export class DraggableEntity extends Draggable {
+    /**
+     * @param {number} x the x coordinates of the draggable object
+     * @param {number} y the y coordinates of the draggable object
+     * @param {object} settings Entity properties (see {@link Entity})
+     */
+    constructor(x, y, settings) {
+        warning("DraggableEntity", "Draggable", "10.5.0");
+        super(x, y, settings.width, settings.height);
+    }
+}
+
+/**
+ * @classdesc
+ * Used to make a game entity a droptarget
+ * @augments Entity
+ * @deprecated since 10.5.0
+ * @see DropTarget
+ */
+export class DroptargetEntity extends DropTarget {
+    /**
+     * @param {number} x the x coordinates of the draggable object
+     * @param {number} y the y coordinates of the draggable object
+     * @param {object} settings Entity properties (see {@link Entity})
+     */
+    constructor(x, y, settings) {
+        warning("DroptargetEntity", "DropTarget", "10.5.0");
+        super(x, y, settings.width, settings.height);
+    }
+}

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