melonjs 10.1.0 → 10.2.2

package/src/entity/droptarget.js

@@ -2,15 +2,15 @@ import * as event from "./../system/event.js";
 import Entity from "./entity.js";
 
 /**
-* Used to make a game entity a droptarget
-* @class
-* @extends me.Entity
-* @memberOf me
-* @constructor
-* @param {Number} x the x coordinates of the entity object
-* @param {Number} y the y coordinates of the entity object
-* @param {Object} settings Entity properties (see {@link me.Entity})
-*/
+ * Used to make a game entity a droptarget
+ * @class
+ * @extends me.Entity
+ * @memberOf me
+ * @constructor
+ * @param {number} x the x coordinates of the entity object
+ * @param {number} y the y coordinates of the entity object
+ * @param {object} settings Entity properties (see {@link me.Entity})
+ */
 
 class DroptargetEntity extends Entity {
     /**
@@ -18,9 +18,9 @@ class DroptargetEntity extends Entity {
      * @name init
      * @memberOf me.DroptargetEntity
      * @function
-     * @param {Number} x the x postion of the entity
-     * @param {Number} y the y postion of the entity
-     * @param {Object} settings the additional entity settings
+     * @param {number} x the x postion of the entity
+     * @param {number} y the y postion of the entity
+     * @param {object} settings the additional entity settings
      */
     constructor(x, y, settings) {
         super(x, y, settings);
@@ -28,7 +28,7 @@ class DroptargetEntity extends Entity {
          * constant for the overlaps method
          * @public
          * @constant
-         * @type String
+         * @type {string}
          * @name CHECKMETHOD_OVERLAP
          * @memberOf me.DroptargetEntity
          */
@@ -37,7 +37,7 @@ class DroptargetEntity extends Entity {
          * constant for the contains method
          * @public
          * @constant
-         * @type String
+         * @type {string}
          * @name CHECKMETHOD_CONTAINS
          * @memberOf me.DroptargetEntity
          */
@@ -46,7 +46,7 @@ class DroptargetEntity extends Entity {
          * the checkmethod we want to use
          * @public
          * @constant
-         * @type String
+         * @type {string}
          * @name checkMethod
          * @memberOf me.DroptargetEntity
          */
@@ -60,7 +60,7 @@ class DroptargetEntity extends Entity {
      * @name setCheckMethod
      * @memberOf me.DroptargetEntity
      * @function
-     * @param {Constant} checkMethod the checkmethod (defaults to CHECKMETHOD_OVERLAP)
+     * @param {string} checkMethod the checkmethod (defaults to CHECKMETHOD_OVERLAP)
      */
     setCheckMethod(checkMethod) {
         //  We can improve this check,
@@ -75,7 +75,8 @@ class DroptargetEntity extends Entity {
      * @name checkOnMe
      * @memberOf me.DroptargetEntity
      * @function
-     * @param {Object} draggableEntity the draggable entity that is dropped
+     * @param {object} e the triggering event
+     * @param {object} draggableEntity the draggable entity that is dropped
      */
     checkOnMe(e, draggableEntity) {
         if (draggableEntity && this.checkMethod(draggableEntity.getBounds())) {
@@ -89,7 +90,7 @@ class DroptargetEntity extends Entity {
      * @name drop
      * @memberOf me.DroptargetEntity
      * @function
-     * @param {Object} draggableEntity the draggable entity that is dropped
+     * @param {object} draggableEntity the draggable entity that is dropped
      */
     drop() {
 

package/src/entity/entity.js

@@ -12,20 +12,20 @@ import Polygon from "./../shapes/poly.js";
  * @memberOf me
  * @see me.Renderable
  * @constructor
- * @param {Number} x the x coordinates of the entity object
- * @param {Number} y the y coordinates of the entity object
- * @param {Object} settings Entity properties, to be defined through Tiled or when calling the entity constructor
+ * @param {number} x the x coordinates of the entity object
+ * @param {number} y the y coordinates of the entity object
+ * @param {object} settings Entity properties, to be defined through Tiled or when calling the entity constructor
  * <img src="images/object_properties.png"/>
- * @param {Number} settings.width the physical width the entity takes up in game
- * @param {Number} settings.height the physical height the entity takes up in game
- * @param {String} [settings.name] object entity name
- * @param {String} [settings.id] object unique IDs
- * @param {Image|String} [settings.image] resource name of a spritesheet to use for the entity renderable component
+ * @param {number} settings.width the physical width the entity takes up in game
+ * @param {number} settings.height the physical height the entity takes up in game
+ * @param {string} [settings.name] object entity name
+ * @param {string} [settings.id] object unique IDs
+ * @param {Image|string} [settings.image] resource name of a spritesheet to use for the entity renderable component
  * @param {me.Vector2d} [settings.anchorPoint=0.0] Entity anchor point
- * @param {Number} [settings.framewidth=settings.width] width of a single frame in the given spritesheet
- * @param {Number} [settings.frameheight=settings.width] height of a single frame in the given spritesheet
- * @param {String} [settings.type] object type
- * @param {Number} [settings.collisionMask] Mask collision detection for this object
+ * @param {number} [settings.framewidth=settings.width] width of a single frame in the given spritesheet
+ * @param {number} [settings.frameheight=settings.width] height of a single frame in the given spritesheet
+ * @param {string} [settings.type] object type
+ * @param {number} [settings.collisionMask] Mask collision detection for this object
  * @param {me.Rect[]|me.Polygon[]|me.Line[]|me.Ellipse[]} [settings.shapes] the initial list of collision shapes (usually populated through Tiled)
  */
 
@@ -74,7 +74,7 @@ class Entity extends Renderable {
         /**
          * object type (as defined in Tiled)
          * @public
-         * @type String
+         * @type {string}
          * @name type
          * @memberOf me.Entity
          */
@@ -83,7 +83,7 @@ class Entity extends Renderable {
         /**
          * object unique ID (as defined in Tiled)
          * @public
-         * @type Number
+         * @type {number}
          * @name id
          * @memberOf me.Entity
          */
@@ -93,7 +93,7 @@ class Entity extends Renderable {
          * dead/living state of the entity<br>
          * default value : true
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name alive
          * @memberOf me.Entity
          */
@@ -102,7 +102,7 @@ class Entity extends Renderable {
         /**
          * the entity body object
          * @public
-         * @type me.Body
+         * @type {me.Body}
          * @name body
          * @memberOf me.Entity
          */
@@ -134,20 +134,15 @@ class Entity extends Renderable {
     /**
      * The entity renderable component (can be any objects deriving from me.Renderable, like me.Sprite for example)
      * @public
-     * @type me.Renderable
+     * @type {me.Renderable}
      * @name renderable
      * @memberOf me.Entity
      */
 
-    /**
-     * @ignore
-     */
     get renderable() {
         return this.children[0];
     }
-    /**
-     * @ignore
-     */
+
     set renderable(value) {
         if (value instanceof Renderable) {
             this.children[0] = value;
@@ -167,10 +162,11 @@ class Entity extends Renderable {
 
     /**
      * update the bounds position when the body is modified
-     * @private
+     * @ignore
      * @name onBodyUpdate
      * @memberOf me.Entity
      * @function
+     * @param {me.Body} the body whose bounds to update
      */
     onBodyUpdate(body) {
         // update the entity bounds to include the body bounds
@@ -208,8 +204,8 @@ class Entity extends Renderable {
      * @function
      * @protected
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
-     * @param {me.Rect} region to draw
-     **/
+     * @param {me.Rect} rect region to draw
+     */
     draw(renderer, rect) {
         var renderable = this.renderable;
         if (renderable instanceof Renderable) {

package/src/game.js

@@ -130,7 +130,7 @@ export function reset () {
  * Update the renderer framerate using the system config variables.
  * @function me.game.updateFrameRate
  * @see me.timer.maxfps
- * @see me.game.world.fps
+ * @see me.World.fps
  */
 export function updateFrameRate() {
     // reset the frame counter
@@ -151,7 +151,7 @@ export function updateFrameRate() {
  * Returns the parent container of the specified Child in the game world
  * @function me.game.getParentContainer
  * @param {me.Renderable} child
- * @return {me.Container}
+ * @returns {me.Container}
  */
 export function getParentContainer(child) {
     return child.ancestor;
@@ -170,7 +170,7 @@ export function repaint() {
  * update all objects of the game manager
  * @ignore
  * @function me.game.update
- * @param {Number} time current timestamp as provided by the RAF callback
+ * @param {number} time current timestamp as provided by the RAF callback
  * @param {me.Stage} stage the current stage
  */
 export function update(time, stage) {

package/src/index.js

@@ -48,6 +48,7 @@ import BitmapTextData from "./text/bitmaptextdata.js";
 import ColorLayer from "./renderable/colorlayer.js";
 import ImageLayer from "./renderable/imagelayer.js";
 import Sprite from "./renderable/sprite.js";
+import NineSliceSprite from "./renderable/nineslicesprite.js";
 import GUI_Object from "./renderable/GUI.js";
 import Collectable from "./renderable/collectable.js";
 import Trigger from "./renderable/trigger.js";
@@ -78,10 +79,10 @@ import DroptargetEntity from "./entity/droptarget.js";
 import * as deprecated from "./lang/deprecated.js";
 
 /**
-* (<b>m</b>)elonJS (<b>e</b>)ngine : All melonJS functions are defined inside this namespace.
-* You generally should not add new properties to this namespace as it may be overwritten in future versions.
-* @namespace me
-*/
+ * (<b>m</b>)elonJS (<b>e</b>)ngine : All melonJS functions are defined inside this namespace.
+ * You generally should not add new properties to this namespace as it may be overwritten in future versions.
+ * @namespace me
+ */
 
 /**
  * current melonJS version
@@ -145,6 +146,7 @@ export {
     ColorLayer,
     ImageLayer,
     Sprite,
+    NineSliceSprite,
     GUI_Object,
     Collectable,
     Trigger,
@@ -179,17 +181,17 @@ export {
 
 
 /**
-* a flag indicating that melonJS is fully initialized
-* @type {Boolean}
-* @default false
-* @readonly
-* @memberOf me
-*/
+ * a flag indicating that melonJS is fully initialized
+ * @type {boolean}
+ * @default false
+ * @readonly
+ * @memberOf me
+ */
 export var initialized = false;
 
 /**
  * disable melonJS auto-initialization
- * @type {Boolean}
+ * @type {boolean}
  * @default false
  * @see me.boot
  * @memberOf me
@@ -220,6 +222,7 @@ export function boot() {
     pool.register("me.Color", Color, true);
     pool.register("me.Particle", Particle, true);
     pool.register("me.Sprite", Sprite);
+    pool.register("me.NineSliceSprite", NineSliceSprite);
     pool.register("me.Renderable", Renderable);
     pool.register("me.Text", Text, true);
     pool.register("me.BitmapText", BitmapText);
@@ -246,6 +249,7 @@ export function boot() {
     pool.register("Color", Color, true);
     pool.register("Particle", Particle, true);
     pool.register("Sprite", Sprite);
+    pool.register("NineSliceSprite", NineSliceSprite);
     pool.register("Renderable", Renderable);
     pool.register("Text", Text, true);
     pool.register("BitmapText", BitmapText);

package/src/input/gamepad.js

@@ -296,7 +296,7 @@ export var GAMEPAD = {
      * </ul>
      * @public
      * @name AXES
-     * @enum {Number}
+     * @enum {number}
      * @memberOf me.input.GAMEPAD
      * @see https://w3c.github.io/gamepad/#remapping
      */
@@ -323,7 +323,7 @@ export var GAMEPAD = {
      * </ul>
      * @public
      * @name BUTTONS
-     * @enum {Number}
+     * @enum {number}
      * @memberOf me.input.GAMEPAD
      * @see https://w3c.github.io/gamepad/#remapping
      */
@@ -360,11 +360,11 @@ export var GAMEPAD = {
  * @memberOf me.input
  * @public
  * @function
- * @param {Number} index Gamepad index
- * @param {Object} button Button/Axis definition
- * @param {String} button.type "buttons" or "axes"
+ * @param {number} index Gamepad index
+ * @param {object} button Button/Axis definition
+ * @param {string} button.type "buttons" or "axes"
  * @param {me.input.GAMEPAD.BUTTONS|me.input.GAMEPAD.AXES} button.code button or axis code id
- * @param {Number} [button.threshold=1] value indicating when the axis should trigger the keycode (e.g. -0.5 or 0.5)
+ * @param {number} [button.threshold=1] value indicating when the axis should trigger the keycode (e.g. -0.5 or 0.5)
  * @param {me.input.KEY} keyCode
  * @example
  * // enable the keyboard
@@ -435,7 +435,7 @@ export function bindGamepad(index, button, keyCode) {
  * @memberOf me.input
  * @public
  * @function
- * @param {Number} index Gamepad index
+ * @param {number} index Gamepad index
  * @param {me.input.GAMEPAD.BUTTONS} button
  * @example
  * me.input.unbindGamepad(0, me.input.GAMEPAD.BUTTONS.FACE_1);
@@ -454,7 +454,7 @@ export function unbindGamepad(index, button) {
  * @memberOf me.input
  * @public
  * @function
- * @param {Number} value Deadzone value
+ * @param {number} value Deadzone value
  */
 export function setGamepadDeadzone(value) {
     deadzone = value;
@@ -468,11 +468,11 @@ export function setGamepadDeadzone(value) {
  * @memberOf me.input
  * @public
  * @function
- * @param {String} id Gamepad id string
- * @param {Object} mapping A hash table
- * @param {Number[]} mapping.axes Standard analog control stick axis locations
- * @param {Number[]} mapping.buttons Standard digital button locations
- * @param {Number[]} [mapping.analog] Analog axis locations for buttons
+ * @param {string} id Gamepad id string
+ * @param {object} mapping A hash table
+ * @param {number[]} mapping.axes Standard analog control stick axis locations
+ * @param {number[]} mapping.buttons Standard digital button locations
+ * @param {number[]} [mapping.analog] Analog axis locations for buttons
  * @param {Function} [mapping.normalize_fn] a function that returns a normalized value in range [-1.0..1.0] for the given value, axis and button
  * @example
  * // A weird controller that has its axis mappings reversed

package/src/input/input.js

@@ -6,7 +6,7 @@
 /**
  * specify if melonJS should prevent all default browser action on registered events.
  * @public
- * @type Boolean
+ * @type {boolean}
  * @default true
  * @name preventDefault
  * @memberOf me.input

package/src/input/keyboard.js

@@ -98,7 +98,7 @@ var keyUpEvent = function (e, keyCode, mouseButton) {
  /**
   * the default target element for keyboard events (usually the window element in which the game is running)
   * @public
-  * @type EventTarget
+  * @type {EventTarget}
   * @name keyBoardEventTarget
   * @memberOf me.input
   */
@@ -331,18 +331,15 @@ export function initKeyboardEvent() {
  * @memberOf me.input
  * @public
  * @function
- * @param {String} action user defined corresponding action
- * @return {Boolean} true if pressed
+ * @param {string} action user defined corresponding action
+ * @returns {boolean} true if pressed
  * @example
- * if (me.input.isKeyPressed('left'))
- * {
+ * if (me.input.isKeyPressed('left')) {
  *    //do something
  * }
- * else if (me.input.isKeyPressed('right'))
- * {
+ * else if (me.input.isKeyPressed('right')) {
  *    //do something else...
  * }
- *
  */
 export function isKeyPressed(action) {
     if (_keyStatus[action] && !_keyLocked[action]) {
@@ -360,8 +357,8 @@ export function isKeyPressed(action) {
  * @memberOf me.input
  * @public
  * @function
- * @param {String} action user defined corresponding action
- * @return {Boolean} down (true) or up(false)
+ * @param {string} action user defined corresponding action
+ * @returns {boolean} down (true) or up(false)
  */
 export function keyStatus(action) {
     return (_keyStatus[action] > 0);
@@ -375,7 +372,8 @@ export function keyStatus(action) {
  * @public
  * @function
  * @param {me.input.KEY} keycode
- * @param {Boolean} [status=false] true to trigger a key down event, or false for key up event
+ * @param {boolean} [status=false] true to trigger a key down event, or false for key up event
+ * @param {number} [mouseButton] the mouse button to trigger
  * @example
  * // trigger a key press
  * me.input.triggerKeyEvent(me.input.KEY.LEFT, true);
@@ -397,9 +395,9 @@ export function triggerKeyEvent(keycode, status, mouseButton) {
  * @public
  * @function
  * @param {me.input.KEY} keycode
- * @param {String} action user defined corresponding action
- * @param {Boolean} [lock=false] cancel the keypress event once read
- * @param {Boolean} [preventDefault=me.input.preventDefault] prevent default browser action
+ * @param {string} action user defined corresponding action
+ * @param {boolean} [lock=false] cancel the keypress event once read
+ * @param {boolean} [preventDefault=me.input.preventDefault] prevent default browser action
  * @example
  * // enable the keyboard
  * me.input.bindKey(me.input.KEY.LEFT,  "left");
@@ -424,7 +422,7 @@ export function bindKey(keycode, action, lock, preventDefault = preventDefaultAc
  * @public
  * @function
  * @param {me.input.KEY} keycode
- * @return {String} user defined associated action
+ * @returns {string} user defined associated action
  */
 export function getBindingKey(keycode) {
     return _keyBindings[keycode];
@@ -436,7 +434,7 @@ export function getBindingKey(keycode) {
  * @memberOf me.input
  * @public
  * @function
- * @param {String} action user defined corresponding action
+ * @param {string} action user defined corresponding action
  * @example
  * // Unlock jump when touching the ground
  * if (!this.falling && !this.jumping) {