melonjs 10.1.0 → 10.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "melonjs",
-  "version": "10.1.0",
+  "version": "10.2.2",
   "description": "melonJS Game Engine",
   "homepage": "http://www.melonjs.org/",
   "keywords": [
@@ -60,26 +60,26 @@
   "devDependencies": {
     "@rollup/plugin-buble": "^0.21.3",
     "@rollup/plugin-commonjs": "^21.0.1",
-    "@rollup/plugin-node-resolve": "^13.0.6",
+    "@rollup/plugin-node-resolve": "^13.1.1",
     "@rollup/plugin-replace": "^3.0.0",
     "cheerio": "^1.0.0-rc.10",
     "del-cli": "^4.0.1",
-    "eslint": "^8.1.0",
-    "ghpages": "0.0.10",
+    "eslint": "^8.4.1",
+    "eslint-plugin-jsdoc": "^37.2.0",
     "jasmine-core": "^3.10.1",
     "jsdoc": "^3.6.7",
-    "karma": "^6.3.7",
+    "karma": "^6.3.9",
     "karma-chrome-launcher": "^3.1.0",
-    "karma-coverage": "^2.0.3",
+    "karma-coverage": "^2.1.0",
     "karma-html-detailed-reporter": "^2.1.0",
     "karma-jasmine": "^4.0.1",
     "karma-nyan-reporter": "0.2.5",
-    "qs": "^6.10.1",
-    "rollup": "^2.59.0",
+    "qs": "^6.10.2",
+    "rollup": "^2.61.1",
     "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-string": "^3.0.0",
-    "terser": "^5.8.0",
-    "typescript": "^4.4.4"
+    "terser": "^5.10.0",
+    "typescript": "^4.5.4"
   },
   "scripts": {
     "build": "npm run lint && rollup -c --silent",
@@ -88,7 +88,6 @@
     "lint": "eslint --config .eslintrc.json src",
     "test": "npm run build && karma start tests/karma.conf.js",
     "doc": "mkdirp docs && jsdoc -c jsdoc_conf.json",
-    "publishdoc": "npm run doc && ghpages melonjs/melonJS -p docs",
     "release": "npm run dist && npm publish --access public",
     "clean": "del-cli --force build/*.js docs src/**/*.d.ts",
     "makedts": "npx -p typescript tsc dist/melonjs.module.js --declaration --allowJs --emitDeclarationOnly",

package/src/audio/audio.js

@@ -68,7 +68,7 @@ var soundLoadError = function (sound_name, onerror_cb) {
  * if false, melonJS will disable sounds and output a warning message
  * in the console<br>
  * @name stopOnAudioError
- * @type {Boolean}
+ * @type {boolean}
  * @default true
  * @memberOf me.audio
  */
@@ -84,8 +84,8 @@ export let stopOnAudioError = true;
  * It is important to remember that melonJS selects the first compatible sound based on the list of extensions and given order passed here.
  * So if you want webm to be used before mp3, you need to put the audio format in that order.
  * @function me.audio.init
- * @param {String} [format="mp3"] audio format to prioritize
- * @returns {Boolean} Indicates whether audio initialization was successful
+ * @param {string} [format="mp3"] audio format to prioritize
+ * @returns {boolean} Indicates whether audio initialization was successful
  * @example
  * // initialize the "sound engine", giving "webm" as default desired audio format, and "mp3" as a fallback
  * if (!me.audio.init("webm,mp3")) {
@@ -103,8 +103,8 @@ export let stopOnAudioError = true;
 /**
  * check if the given audio format is supported
  * @function me.audio.hasFormat
- * @param {String} format audio format : "mp3", "mpeg", opus", "ogg", "oga", "wav", "aac", "caf", "m4a", "m4b", "mp4", "weba", "webm", "dolby", "flac"
- * @returns {Boolean} return true if the given audio format is supported
+ * @param {string} codec audio format : "mp3", "mpeg", opus", "ogg", "oga", "wav", "aac", "caf", "m4a", "m4b", "mp4", "weba", "webm", "dolby", "flac"
+ * @returns {boolean} return true if the given audio format is supported
  */
 export function hasFormat(codec) {
     return hasAudio() && Howler.codecs(codec);
@@ -113,7 +113,7 @@ export function hasFormat(codec) {
 /**
  * check if audio (HTML5 or WebAudio) is supported
  * @function me.audio.hasAudio
- * @returns {Boolean} return true if audio (HTML5 or WebAudio) is supported
+ * @returns {boolean} return true if audio (HTML5 or WebAudio) is supported
  */
 export function hasAudio() {
     return !Howler.noAudio;
@@ -181,11 +181,11 @@ export function load(sound, html5, onload_cb, onerror_cb) {
 /**
  * play the specified sound
  * @function me.audio.play
- * @param {String} sound_name audio clip name - case sensitive
- * @param {Boolean} [loop=false] loop audio
+ * @param {string} sound_name audio clip name - case sensitive
+ * @param {boolean} [loop=false] loop audio
  * @param {Function} [onend] Function to call when sound instance ends playing.
- * @param {Number} [volume=default] Float specifying volume (0.0 - 1.0 values accepted).
- * @return {Number} the sound instance ID.
+ * @param {number} [volume=default] Float specifying volume (0.0 - 1.0 values accepted).
+ * @returns {number} the sound instance ID.
  * @example
  * // play the "cling" audio clip
  * me.audio.play("cling");
@@ -222,11 +222,11 @@ export function play(sound_name, loop = false, onend, volume) {
 /**
  * Fade a currently playing sound between two volumee.
  * @function me.audio.fade
- * @param {String} sound_name audio clip name - case sensitive
- * @param {Number} from Volume to fade from (0.0 to 1.0).
- * @param {Number} to Volume to fade to (0.0 to 1.0).
- * @param {Number} duration Time in milliseconds to fade.
- * @param {Number} [id] the sound instance ID. If none is passed, all sounds in group will fade.
+ * @param {string} sound_name audio clip name - case sensitive
+ * @param {number} from Volume to fade from (0.0 to 1.0).
+ * @param {number} to Volume to fade to (0.0 to 1.0).
+ * @param {number} duration Time in milliseconds to fade.
+ * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will fade.
  */
 export function fade(sound_name, from, to, duration, id) {
     var sound = audioTracks[sound_name];
@@ -240,10 +240,10 @@ export function fade(sound_name, from, to, duration, id) {
 /**
  * get/set the position of playback for a sound.
  * @function me.audio.seek
- * @param {String} sound_name audio clip name - case sensitive
- * @param {Number} [seek]  The position to move current playback to (in seconds).
- * @param {Number} [id] the sound instance ID. If none is passed, all sounds in group will changed.
- * @return return the current seek position (if no extra parameters were given)
+ * @param {string} sound_name audio clip name - case sensitive
+ * @param {number} [seek]  The position to move current playback to (in seconds).
+ * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will changed.
+ * @returns {number} return the current seek position (if no extra parameters were given)
  * @example
  * // return the current position of the background music
  * var current_pos = me.audio.seek("dst-gameforest");
@@ -262,10 +262,10 @@ export function seek(sound_name, ...args) {
 /**
  * get or set the rate of playback for a sound.
  * @function me.audio.rate
- * @param {String} sound_name audio clip name - case sensitive
- * @param {Number} [rate] playback rate : 0.5 to 4.0, with 1.0 being normal speed.
- * @param {Number} [id] the sound instance ID. If none is passed, all sounds in group will be changed.
- * @return return the current playback rate (if no extra parameters were given)
+ * @param {string} sound_name audio clip name - case sensitive
+ * @param {number} [rate] playback rate : 0.5 to 4.0, with 1.0 being normal speed.
+ * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will be changed.
+ * @returns {number} return the current playback rate (if no extra parameters were given)
  * @example
  * // get the playback rate of the background music
  * var rate = me.audio.rate("dst-gameforest");
@@ -284,8 +284,8 @@ export function rate(sound_name, ...args) {
 /**
  * stop the specified sound on all channels
  * @function me.audio.stop
- * @param {String} [sound_name] audio clip name (case sensitive). If none is passed, all sounds are stopped.
- * @param {Number} [id] the sound instance ID. If none is passed, all sounds in group will stop.
+ * @param {string} [sound_name] audio clip name (case sensitive). If none is passed, all sounds are stopped.
+ * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will stop.
  * @example
  * me.audio.stop("cling");
  */
@@ -308,8 +308,8 @@ export function stop(sound_name, id) {
  * pause the specified sound on all channels<br>
  * this function does not reset the currentTime property
  * @function me.audio.pause
- * @param {String} sound_name audio clip name - case sensitive
- * @param {Number} [id] the sound instance ID. If none is passed, all sounds in group will pause.
+ * @param {string} sound_name audio clip name - case sensitive
+ * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will pause.
  * @example
  * me.audio.pause("cling");
  */
@@ -325,8 +325,8 @@ export function pause(sound_name, id) {
 /**
  * resume the specified sound on all channels<br>
  * @function me.audio.resume
- * @param {String} sound_name audio clip name - case sensitive
- * @param {Number} [id] the sound instance ID. If none is passed, all sounds in group will resume.
+ * @param {string} sound_name audio clip name - case sensitive
+ * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will resume.
  * @example
  * // play a audio clip
  * var id = me.audio.play("myClip");
@@ -351,9 +351,9 @@ export function resume(sound_name, id) {
  * this function automatically set the loop property to true<br>
  * and keep track of the current sound being played.
  * @function me.audio.playTrack
- * @param {String} sound_name audio track name - case sensitive
- * @param {Number} [volume=default] Float specifying volume (0.0 - 1.0 values accepted).
- * @return {Number} the sound instance ID.
+ * @param {string} sound_name audio track name - case sensitive
+ * @param {number} [volume=default] Float specifying volume (0.0 - 1.0 values accepted).
+ * @returns {number} the sound instance ID.
  * @example
  * me.audio.playTrack("awesome_music");
  */
@@ -416,7 +416,7 @@ export function resumeTrack() {
 /**
  * returns the current track Id
  * @function me.audio.getCurrentTrack
- * @return {String} audio track name
+ * @returns {string} audio track name
  */
 export function getCurrentTrack() {
     return current_track_id;
@@ -425,7 +425,7 @@ export function getCurrentTrack() {
 /**
  * set the default global volume
  * @function me.audio.setVolume
- * @param {Number} volume Float specifying volume (0.0 - 1.0 values accepted).
+ * @param {number} volume Float specifying volume (0.0 - 1.0 values accepted).
  */
 export function setVolume(volume) {
     Howler.volume(volume);
@@ -434,7 +434,7 @@ export function setVolume(volume) {
 /**
  * get the default global volume
  * @function me.audio.getVolume
- * @returns {Number} current volume value in Float [0.0 - 1.0] .
+ * @returns {number} current volume value in Float [0.0 - 1.0] .
  */
 export function getVolume() {
     return Howler.volume();
@@ -443,9 +443,9 @@ export function getVolume() {
 /**
  * mute or unmute the specified sound, but does not pause the playback.
  * @function me.audio.mute
- * @param {String} sound_name audio clip name - case sensitive
- * @param {Number} [id] the sound instance ID. If none is passed, all sounds in group will mute.
- * @param {Boolean} [mute=true] True to mute and false to unmute
+ * @param {string} sound_name audio clip name - case sensitive
+ * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will mute.
+ * @param {boolean} [mute=true] True to mute and false to unmute
  * @example
  * // mute the background music
  * me.audio.mute("awesome_music");
@@ -464,8 +464,8 @@ export function mute(sound_name, id, mute) {
 /**
  * unmute the specified sound
  * @function me.audio.unmute
- * @param {String} sound_name audio clip name
- * @param {Number} [id] the sound instance ID. If none is passed, all sounds in group will unmute.
+ * @param {string} sound_name audio clip name
+ * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will unmute.
  */
 export function unmute(sound_name, id) {
     mute(sound_name, id, false);
@@ -490,7 +490,7 @@ export function unmuteAll() {
 /**
  * Returns true if audio is muted globally.
  * @function me.audio.muted
- * @return {Boolean} true if audio is muted globally
+ * @returns {boolean} true if audio is muted globally
  */
 export function muted() {
     return Howler._muted;
@@ -499,8 +499,8 @@ export function muted() {
 /**
  * unload specified audio track to free memory
  * @function me.audio.unload
- * @param {String} sound_name audio track name - case sensitive
- * @return {Boolean} true if unloaded
+ * @param {string} sound_name audio track name - case sensitive
+ * @returns {boolean} true if unloaded
  * @example
  * me.audio.unload("awesome_music");
  */

package/src/camera/camera2d.js

@@ -25,10 +25,10 @@ var targetV = new Vector2d();
  * @extends me.Renderable
  * @memberOf me
  * @constructor
- * @param {Number} minX start x offset
- * @param {Number} minY start y offset
- * @param {Number} maxX end x offset
- * @param {Number} maxY end y offset
+ * @param {number} minX start x offset
+ * @param {number} minY start y offset
+ * @param {number} maxX end x offset
+ * @param {number} maxY end y offset
  */
 class Camera2d extends Renderable {
 
@@ -40,13 +40,13 @@ class Camera2d extends Renderable {
 
         /**
          * Axis definition
-         * @property NONE
-         * @property HORIZONTAL
-         * @property VERTICAL
-         * @property BOTH
+         * @property {number} NONE no axis
+         * @property {number} HORIZONTAL horizontal axis only
+         * @property {number} VERTICAL vertical axis only
+         * @property {number} BOTH both axis
          * @public
          * @constant
-         * @enum {Number}
+         * @enum {number}
          * @name AXIS
          * @memberOf me.Camera2d
          */
@@ -60,7 +60,7 @@ class Camera2d extends Renderable {
         /**
          * Camera bounds
          * @public
-         * @type me.Bounds
+         * @type {me.Bounds}
          * @name bounds
          * @memberOf me.Camera2d
          */
@@ -69,7 +69,7 @@ class Camera2d extends Renderable {
         /**
          * [IMTERNAL] enable or disable damping
          * @private
-         * @type {Boolean}
+         * @type {boolean}
          * @name smoothFollow
          * @see me.Camera2d.damping
          * @default true
@@ -81,7 +81,7 @@ class Camera2d extends Renderable {
          * Camera damping for smooth transition [0 .. 1].
          * 1 being the maximum value and will snap the camera to the target position
          * @public
-         * @type {Number}
+         * @type {number}
          * @name damping
          * @default 1.0
          * @memberOf me.Camera2d
@@ -91,7 +91,7 @@ class Camera2d extends Renderable {
         /**
          * the closest point relative to the camera
          * @public
-         * @type {Number}
+         * @type {number}
          * @name near
          * @default -1000
          * @memberOf me.Camera2d
@@ -101,7 +101,7 @@ class Camera2d extends Renderable {
         /**
          * the furthest point relative to the camera.
          * @public
-         * @type {Number}
+         * @type {number}
          * @name far
          * @default 1000
          * @memberOf me.Camera2d
@@ -218,13 +218,13 @@ class Camera2d extends Renderable {
      * @name reset
      * @memberOf me.Camera2d
      * @function
-     * @param {Number} [x=0]
-     * @param {Number} [y=0]
+     * @param {number} [x=0]
+     * @param {number} [y=0]
      */
-    reset(x, y) {
+    reset(x = 0, y = 0) {
         // reset the initial camera position to 0,0
-        this.pos.x = x || 0;
-        this.pos.y = y || 0;
+        this.pos.x = x;
+        this.pos.y = y;
 
         // reset the target
         this.unfollow();
@@ -249,8 +249,8 @@ class Camera2d extends Renderable {
      * @see me.Camera2d.follow
      * @memberOf me.Camera2d
      * @function
-     * @param {Number} w deadzone width
-     * @param {Number} h deadzone height
+     * @param {number} w deadzone width
+     * @param {number} h deadzone height
      */
     setDeadzone(w, h) {
         if (typeof(this.deadzone) === "undefined") {
@@ -277,10 +277,10 @@ class Camera2d extends Renderable {
      * @name resize
      * @memberOf me.Camera2d
      * @function
-     * @param {Number} w new width of the camera
-     * @param {Number} h new height of the camera
-     * @return {me.Camera2d} this camera
-    */
+     * @param {number} w new width of the camera
+     * @param {number} h new height of the camera
+     * @returns {me.Camera2d} this camera
+     */
     resize(w, h) {
         // parent consctructor, resize camera rect
         super.resize(w, h);
@@ -309,10 +309,10 @@ class Camera2d extends Renderable {
      * @name setBounds
      * @memberOf me.Camera2d
      * @function
-     * @param {Number} x world left limit
-     * @param {Number} y world top limit
-     * @param {Number} w world width limit
-     * @param {Number} h world height limit
+     * @param {number} x world left limit
+     * @param {number} y world top limit
+     * @param {number} w world width limit
+     * @param {number} h world height limit
      */
     setBounds(x, y, w, h) {
         this.smoothFollow = false;
@@ -330,7 +330,7 @@ class Camera2d extends Renderable {
      * @function
      * @param {me.Renderable|me.Vector2d} target renderable or position vector to follow
      * @param {me.Camera2d.AXIS} [axis=this.AXIS.BOTH] Which axis to follow
-     * @param {Number} [damping=1] default damping value
+     * @param {number} [damping=1] default damping value
      * @example
      * // set the camera to follow this renderable on both axis, and enable damping
      * me.game.viewport.follow(this, me.game.viewport.AXIS.BOTH, 0.1);
@@ -382,8 +382,8 @@ class Camera2d extends Renderable {
      * @memberOf me.Camera2d
      * @see me.Camera2d.focusOn
      * @function
-     * @param {Number} x
-     * @param {Number} y
+     * @param {number} x
+     * @param {number} y
      * @example
      * // Move the camera up by four pixels
      * me.game.viewport.move(0, -4);
@@ -398,8 +398,8 @@ class Camera2d extends Renderable {
      * @memberOf me.Camera2d
      * @see me.Camera2d.focusOn
      * @function
-     * @param {Number} x
-     * @param {Number} y
+     * @param {number} x
+     * @param {number} y
      */
     moveTo(x, y) {
         var _x = this.pos.x;
@@ -521,13 +521,13 @@ class Camera2d extends Renderable {
      * @name shake
      * @memberOf me.Camera2d
      * @function
-     * @param {Number} intensity maximum offset that the screen can be moved
+     * @param {number} intensity maximum offset that the screen can be moved
      * while shaking
-     * @param {Number} duration expressed in milliseconds
+     * @param {number} duration expressed in milliseconds
      * @param {me.Camera2d.AXIS} [axis=this.AXIS.BOTH] specify on which axis you
      *   want the shake effect
      * @param {Function} [onComplete] callback once shaking effect is over
-     * @param {Boolean} [force] if true this will override the current effect
+     * @param {boolean} [force] if true this will override the current effect
      * @example
      * // shake it baby !
      * me.game.viewport.shake(10, 500, me.game.viewport.AXIS.BOTH);
@@ -547,8 +547,8 @@ class Camera2d extends Renderable {
      * @name fadeOut
      * @memberOf me.Camera2d
      * @function
-     * @param {me.Color|String} color a CSS color value
-     * @param {Number} [duration=1000] expressed in milliseconds
+     * @param {me.Color|string} color a CSS color value
+     * @param {number} [duration=1000] expressed in milliseconds
      * @param {Function} [onComplete] callback once effect is over
      * @example
      * // fade the camera to white upon dying, reload the level, and then fade out back
@@ -573,8 +573,8 @@ class Camera2d extends Renderable {
      * @name fadeIn
      * @memberOf me.Camera2d
      * @function
-     * @param {me.Color|String} color a CSS color value
-     * @param {Number} [duration=1000] expressed in milliseconds
+     * @param {me.Color|string} color a CSS color value
+     * @param {number} [duration=1000] expressed in milliseconds
      * @param {Function} [onComplete] callback once effect is over
      * @example
      * // flash the camera to white for 75ms
@@ -591,34 +591,12 @@ class Camera2d extends Renderable {
         this._fadeIn.tween.start();
     }
 
-    /**
-     * return the camera width
-     * @name getWidth
-     * @memberOf me.Camera2d
-     * @function
-     * @return {Number}
-     */
-    getWidth() {
-        return this.width;
-    }
-
-    /**
-     * return the camera height
-     * @name getHeight
-     * @memberOf me.Camera2d
-     * @function
-     * @return {Number}
-     */
-    getHeight() {
-        return this.height;
-    }
-
     /**
      * set the camera position around the specified object
      * @name focusOn
      * @memberOf me.Camera2d
      * @function
-     * @param {me.Renderable}
+     * @param {me.Renderable} target the renderable to focus the camera on
      */
     focusOn(target) {
         var bounds = target.getBounds();
@@ -633,9 +611,9 @@ class Camera2d extends Renderable {
      * @name isVisible
      * @memberOf me.Camera2d
      * @function
-     * @param {me.Renderable} object
-     * @param {Boolean} [floating===object.floating] if visibility check should be done against screen coordinates
-     * @return {Boolean}
+     * @param {me.Renderable} obj to be checked against
+     * @param {boolean} [floating = obj.floating] if visibility check should be done against screen coordinates
+     * @returns {boolean}
      */
     isVisible(obj, floating = obj.floating) {
         if (floating === true || obj.floating === true) {
@@ -652,15 +630,15 @@ class Camera2d extends Renderable {
      * @name localToWorld
      * @memberOf me.Camera2d
      * @function
-     * @param {Number} x
-     * @param {Number} y
-     * @param {Number} [v] an optional vector object where to set the
+     * @param {number} x
+     * @param {number} y
+     * @param {number} [v] an optional vector object where to set the
      * converted value
-     * @return {me.Vector2d}
+     * @returns {me.Vector2d}
      */
     localToWorld(x, y, v) {
         // TODO memoization for one set of coords (multitouch)
-        v = v || new Vector2d();
+        v = v || pool.pull("Vector2d");
         v.set(x, y).add(this.pos).sub(world.pos);
         if (!this.currentTransform.isIdentity()) {
             this.invCurrentTransform.apply(v);
@@ -673,15 +651,15 @@ class Camera2d extends Renderable {
      * @name worldToLocal
      * @memberOf me.Camera2d
      * @function
-     * @param {Number} x
-     * @param {Number} y
-     * @param {Number} [v] an optional vector object where to set the
+     * @param {number} x
+     * @param {number} y
+     * @param {number} [v] an optional vector object where to set the
      * converted value
-     * @return {me.Vector2d}
+     * @returns {me.Vector2d}
      */
     worldToLocal(x, y, v) {
         // TODO memoization for one set of coords (multitouch)
-        v = v || new Vector2d();
+        v = v || pool.pull("Vector2d");
         v.set(x, y);
         if (!this.currentTransform.isIdentity()) {
             this.currentTransform.apply(v);

package/src/entity/draggable.js

@@ -4,15 +4,15 @@ import * as event from "./../system/event.js";
 import Entity from "./entity.js";
 
 /**
-* Used to make a game entity draggable
-* @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 draggable
+ * @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 DraggableEntity extends Entity {
 
     /**
@@ -20,9 +20,9 @@ class DraggableEntity extends Entity {
      * @name init
      * @memberOf me.DraggableEntity
      * @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);
@@ -70,8 +70,8 @@ class DraggableEntity extends Entity {
      * @name translatePointerEvent
      * @memberOf me.DraggableEntity
      * @function
-     * @param {Object} e the pointer event you want to translate
-     * @param {String} translation the me.event you want to translate the event to
+     * @param {object} e the pointer event you want to translate
+     * @param {string} translation the me.event you want to translate the event to
      */
     translatePointerEvent(e, translation) {
         event.emit(translation, e);
@@ -82,7 +82,8 @@ class DraggableEntity extends Entity {
      * @name dragStart
      * @memberOf me.DraggableEntity
      * @function
-     * @param {Object} x the pointer event
+     * @param {object} e the pointer event
+     * @returns {boolean} false if the object is being dragged
      */
     dragStart(e) {
         if (this.dragging === false) {
@@ -98,7 +99,7 @@ class DraggableEntity extends Entity {
      * @name dragMove
      * @memberOf me.DraggableEntity
      * @function
-     * @param {Object} x the pointer event
+     * @param {object} e the pointer event
      */
     dragMove(e) {
         if (this.dragging === true) {
@@ -112,7 +113,7 @@ class DraggableEntity extends Entity {
      * @name dragEnd
      * @memberOf me.DraggableEntity
      * @function
-     * @param {Object} x the pointer event
+     * @returns {boolean} false if the object stopped being dragged
      */
     dragEnd() {
         if (this.dragging === true) {