melonjs 15.3.0 → 15.4.0

package/dist/melonjs.mjs/_virtual/_commonjsHelpers.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license

package/dist/melonjs.mjs/_virtual/earcut.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license

package/dist/melonjs.mjs/_virtual/howler.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license

package/dist/melonjs.mjs/_virtual/index.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license

package/dist/melonjs.mjs/application/application.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -8,7 +8,7 @@
 import { autoDetectRenderer } from '../video/utils/autodetect.js';
 import CanvasRenderer from '../video/canvas/canvas_renderer.js';
 import { getElement, platform, enableSwipe } from '../system/device.js';
-import { on, emit, STATE_CHANGE, STATE_RESTART, STATE_RESUME, STAGE_RESET, GAME_AFTER_UPDATE, GAME_BEFORE_DRAW, GAME_AFTER_DRAW, WINDOW_ONRESIZE, WINDOW_ONORIENTATION_CHANGE, GAME_INIT, TICK, GAME_RESET, GAME_BEFORE_UPDATE, GAME_UPDATE } from '../system/event.js';
+import { on, emit, STATE_CHANGE, STATE_RESTART, STATE_RESUME, STAGE_RESET, GAME_AFTER_UPDATE, GAME_BEFORE_DRAW, GAME_AFTER_DRAW, WINDOW_ONRESIZE, WINDOW_ONORIENTATION_CHANGE, GAME_INIT, TICK, BLUR, FOCUS, GAME_RESET, GAME_BEFORE_UPDATE, GAME_UPDATE } from '../system/event.js';
 import { getUriFragment } from '../utils/utils.js';
 import timer from '../system/timer.js';
 import state from '../state/state.js';
@@ -24,7 +24,7 @@ import { WEBGL, CANVAS, AUTO } from '../const.js';
  * An Application is responsible for updating (each frame) all the related object status and draw them.
  * @see game
  */
- class Application {
+class Application {
     /**
      * @param {number} width - The width of the canvas viewport
      * @param {number} height - The height of the canvas viewport
@@ -88,10 +88,34 @@ import { WEBGL, CANVAS, AUTO } from '../const.js';
 
         /**
          * the given settings used when creating this application
-         * @type {Object}
+         * @type {object}
          */
         this.settings = undefined;
 
+        /**
+         * Specify whether to pause this app when losing focus
+         * @type {boolean}
+         * @default true
+         * @example
+         *  // keep the default game instance running even when loosing focus
+         *  me.game.pauseOnBlur = false;
+         */
+        this.pauseOnBlur = true;
+
+        /**
+         * Specify whether to unpause this app when gaining back focus
+         * @type {boolean}
+         * @default true
+         */
+        this.resumeOnFocus = true;
+
+        /**
+         * Specify whether to stop this app when losing focus
+         * @type {boolean}
+         * @default false
+         */
+        this.stopOnBlur = false;
+
         // to know when we have to refresh the display
         this.isDirty = true;
 
@@ -123,6 +147,9 @@ import { WEBGL, CANVAS, AUTO } from '../const.js';
 
     /**
      * init the game instance (create a physic world, update starting time, etc..)
+     * @param {number} width - The width of the canvas viewport
+     * @param {number} height - The height of the canvas viewport
+     * @param {Application.Settings} [options] - The optional parameters for the application and default renderer
      */
     init(width, height, options) {
 
@@ -238,6 +265,27 @@ import { WEBGL, CANVAS, AUTO } from '../const.js';
             // render all game objects
             this.draw();
         }, this);
+
+
+        // on blur event, pause the current
+        on(BLUR, () => {
+            if (this.stopOnBlur === true) {
+                state.stop(true);
+            }
+            if (this.pauseOnBlur === true) {
+                state.pause(true);
+            }
+        });
+
+        // on focus event, restart or resume the current
+        on(FOCUS, () => {
+            if (this.stopOnBlur === true) {
+                state.restart(true);
+            }
+            if (this.resumeOnFocus === true) {
+                state.resume(true);
+            }
+        });
     }
 
     /**
@@ -302,7 +350,7 @@ import { WEBGL, CANVAS, AUTO } from '../const.js';
 
     /**
      * Returns the parent HTML Element holding the main canvas of this application
-     * @returns {HTMLElement}
+     * @returns {HTMLElement} the parent HTML element
      */
     getParentElement() {
         return this.parentElement;

package/dist/melonjs.mjs/application/header.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -9,7 +9,7 @@ import { devicePixelRatio, platform, getScreenOrientation, language, hasWebAudio
 
 /**
  * display information
- * @param {Application} game - the game application instance calling this function
+ * @param {Application} app - the game application instance calling this function
  */
 function consoleHeader(app) {
     let renderType = app.renderer.type;

package/dist/melonjs.mjs/application/resize.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -49,7 +49,7 @@ function scale(game, x, y) {
 function onresize(game) {
     let renderer = game.renderer;
     let settings = renderer.settings;
-    let scaleX = 1, scaleY = 1;
+    let scaleX = settings.scale, scaleY = settings.scale;
     let nodeBounds;
 
     if (settings.autoScale) {
@@ -115,13 +115,9 @@ function onresize(game) {
                 scaleX = scaleY = _max_height / settings.height;
             }
         }
-
-        // adjust scaling ratio based on the new scaling ratio
-        scale(game, scaleX, scaleY);
-    } else {
-        // adjust scaling ratio based on the given settings
-        scale(game, settings.scale, settings.scale);
     }
+    // adjust scaling ratio
+    scale(game, scaleX, scaleY);
 }
 
 export { onresize };

package/dist/melonjs.mjs/application/settings.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -28,11 +28,11 @@ const defaultSettings = {
 
 /**
  * Application & Renderer Settings definition.
- * @typedef {Object} Settings
+ * @typedef {object} Settings
  * @property {string|HTMLElement} [parent=document.body] - the DOM parent element to hold the canvas in the HTML file
  * @property {number|Renderer} [renderer=AUTO] - renderer to use (CANVAS, WEBGL, AUTO), or a custom renderer class
  * @property {number|string} [scale=1.0] - enable scaling of the canvas ('auto' for automatic scaling)
- * @property {string} [scaleMethod="fit"] - screen scaling modes ('fit','fill-min','fill-max','flex','flex-width','flex-height','stretch') : <br>
+ * @property {"fit"|"fill-min"|"fill-max"|"flex"|"flex-width"|"flex-height"|"stretch"} [scaleMethod="fit"] - screen scaling modes : <br>
  *  - <i><b>`fit`</b></i> : Letterboxed; content is scaled to design aspect ratio <br>
  * <center><img src="images/scale-fit.png"/></center><br>
  *  - <i><b>`fill-min`</b></i> : Canvas is resized to fit minimum design resolution; content is scaled to design aspect ratio <br>
@@ -49,8 +49,8 @@ const defaultSettings = {
  * <center><img src="images/scale-stretch.png"/></center>
  * @property {string|HTMLElement} [scaleTarget] - the HTML Element to be used as the reference target when using automatic scaling (by default melonJS will use the parent container of the div element containing the canvas)
  * @property {boolean} [preferWebGL1=false] - if true the renderer will only use WebGL 1
- * @property {boolean} [depthTest="sorting"] - ~Experimental~ the default method to sort object on the z axis in WebGL ("sorting", "z-buffer")
- * @property {string} [powerPreference="default"] - a hint to the user agent indicating what configuration of GPU is suitable for the WebGL context ("default", "high-performance", "low-power"). To be noted that Safari and Chrome (since version 80) both default to "low-power" to save battery life and improve the user experience on these dual-GPU machines.
+ * @property {"sorting"|"z-buffer"} [depthTest="sorting"] - ~Experimental~ the default method to sort object on the z axis in WebGL
+ * @property {("default"|"high-performance"|"low-power")} [powerPreference="default"] - a hint to the user agent indicating what configuration of GPU is suitable for the WebGL context. To be noted that Safari and Chrome (since version 80) both default to "low-power" to save battery life and improve the user experience on these dual-GPU machines.
  * @property {boolean} [transparent=false] - whether to allow transparent pixels in the front buffer (screen).
  * @property {boolean} [antiAlias=false] - whether to enable or not video scaling interpolation
  * @property {boolean} [consoleHeader=true] - whether to display melonJS version and basic device information in the console

package/dist/melonjs.mjs/audio/audio.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -75,15 +75,13 @@ let stopOnAudioError = true;
 
 /**
  * Initialize and configure the audio support.<br>
- * melonJS supports a wide array of audio codecs that have varying browser support :
- * <i> ("mp3", "mpeg", opus", "ogg", "oga", "wav", "aac", "caf", "m4a", "m4b", "mp4", "weba", "webm", "dolby", "flac")</i>.<br>
  * For a maximum browser coverage the recommendation is to use at least two of them,
  * typically default to webm and then fallback to mp3 for the best balance of small filesize and high quality,
  * webm has nearly full browser coverage with a great combination of compression and quality, and mp3 will fallback gracefully for other browsers.
  * 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 audio.init
- * @param {string} [format="mp3"] - audio format to prioritize
+ * @param {"mp3"|"mpeg"|"opus"|"ogg"|"oga"|"wav"|"aac"|"caf"|"m4a"|"m4b"|"mp4"|"weba"|"webm"|"dolby"|"flac"} [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
@@ -92,7 +90,7 @@ let stopOnAudioError = true;
  *     return;
  * }
  */
- function init(format = "mp3") {
+function init(format = "mp3") {
     // convert it into an array
     audioExts = format.split(",");
 
@@ -102,7 +100,7 @@ let stopOnAudioError = true;
 /**
  * check if the given audio format is supported
  * @function audio.hasFormat
- * @param {string} codec - audio format : "mp3", "mpeg", opus", "ogg", "oga", "wav", "aac", "caf", "m4a", "m4b", "mp4", "weba", "webm", "dolby", "flac"
+ * @param {"mp3"|"mpeg"|"opus"|"ogg"|"oga"|"wav"|"aac"|"caf"|"m4a"|"m4b"|"mp4"|"weba"|"webm"|"dolby"|"flac"} codec - the audio format to check for support
  * @returns {boolean} return true if the given audio format is supported
  */
 function hasFormat(codec) {

package/dist/melonjs.mjs/camera/camera2d.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -29,7 +29,7 @@ let targetV = new Vector2d();
  * a 2D orthographic camera
  * @augments Renderable
  */
- class Camera2d extends Renderable {
+class Camera2d extends Renderable {
     /**
      * @param {number} minX - start x offset
      * @param {number} minY - start y offset
@@ -213,8 +213,8 @@ let targetV = new Vector2d();
      * reset the camera position to specified coordinates
      * @name reset
      * @memberof Camera2d
-     * @param {number} [x=0]
-     * @param {number} [y=0]
+     * @param {number} [x=0] - initial position of the camera on the x axis
+     * @param {number} [y=0] - initial position of the camera on the y axis
      */
     reset(x = 0, y = 0) {
         // reset the initial camera position to 0,0
@@ -371,8 +371,8 @@ let targetV = new Vector2d();
      * @name move
      * @memberof Camera2d
      * @see Camera2d.focusOn
-     * @param {number} x
-     * @param {number} y
+     * @param {number} x - horizontal offset
+     * @param {number} y - vertical offset
      * @example
      * // Move the camera up by four pixels
      * me.game.viewport.move(0, -4);
@@ -593,7 +593,7 @@ let targetV = new Vector2d();
      * @memberof Camera2d
      * @param {Renderable|Entity|Sprite|NineSliceSprite} obj - to be checked against
      * @param {boolean} [floating = obj.floating] - if visibility check should be done against screen coordinates
-     * @returns {boolean}
+     * @returns {boolean} true if within the viewport
      */
     isVisible(obj, floating = obj.floating) {
         if (floating === true || obj.floating === true) {
@@ -609,10 +609,9 @@ let targetV = new Vector2d();
      * convert the given "local" (screen) coordinates into world coordinates
      * @name localToWorld
      * @memberof Camera2d
-     * @param {number} x
-     * @param {number} y
-     * @param {number} [v] - an optional vector object where to set the
-     * converted value
+     * @param {number} x - the x coordinate of the local point to be converted
+     * @param {number} y - the y coordinate of the local point to be converted
+     * @param {number} [v] - an optional vector object where to set the converted value
      * @returns {Vector2d}
      */
     localToWorld(x, y, v) {
@@ -631,9 +630,8 @@ let targetV = new Vector2d();
      * @memberof Camera2d
      * @param {number} x
      * @param {number} y
-     * @param {number} [v] - an optional vector object where to set the
-     * converted value
-     * @returns {Vector2d}
+     * @param {number} [v] - an optional vector object where to set the converted value
+     * @returns {Vector2d} a vector with the converted local coordinates
      */
     worldToLocal(x, y, v) {
         // TODO memoization for one set of coords (multitouch)

package/dist/melonjs.mjs/const.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license

package/dist/melonjs.mjs/entity/entity.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -16,7 +16,7 @@ import Body from '../physics/body.js';
  * @augments Renderable
  * @see Renderable
  */
- class Entity extends Renderable {
+class Entity extends Renderable {
     /**
      * @param {number} x - the x coordinates of the entity object
      * @param {number} y - the y coordinates of the entity object
@@ -186,7 +186,7 @@ import Body from '../physics/body.js';
         }
 
         if (absolute === true) {
-            var absPos = this.getAbsolutePosition();
+            let absPos = this.getAbsolutePosition();
             bounds.centerOn(absPos.x + bounds.x + bounds.width / 2,  absPos.y + bounds.y + bounds.height / 2);
         }
 
@@ -198,7 +198,6 @@ import Body from '../physics/body.js';
      * @ignore
      * @name onBodyUpdate
      * @memberof Entity
-     * @param {Body} body - the body whose bounds to update
      */
     onBodyUpdate() {
         this.updateBounds();

package/dist/melonjs.mjs/geometries/ellipse.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -11,7 +11,7 @@ import pool from '../system/pooling.js';
  * @classdesc
  * an ellipse Object
  */
- class Ellipse {
+class Ellipse {
     /**
      * @param {number} x - the center x coordinate of the ellipse
      * @param {number} y - the center y coordinate of the ellipse
@@ -23,8 +23,6 @@ import pool from '../system/pooling.js';
          * the center coordinates of the ellipse
          * @public
          * @type {Vector2d}
-         * @name pos
-         * @memberof Ellipse
          */
         this.pos = pool.pull("Vector2d");
 
@@ -38,8 +36,6 @@ import pool from '../system/pooling.js';
          * Maximum radius of the ellipse
          * @public
          * @type {number}
-         * @name radius
-         * @memberof Ellipse
          */
         this.radius = NaN;
 
@@ -47,8 +43,6 @@ import pool from '../system/pooling.js';
          * Pre-scaled radius vector for ellipse
          * @public
          * @type {Vector2d}
-         * @name radiusV
-         * @memberof Ellipse
          */
         this.radiusV = pool.pull("Vector2d");
 
@@ -56,8 +50,6 @@ import pool from '../system/pooling.js';
          * Radius squared, for pythagorean theorom
          * @public
          * @type {Vector2d}
-         * @name radiusSq
-         * @memberof Ellipse
          */
         this.radiusSq = pool.pull("Vector2d");
 
@@ -65,8 +57,6 @@ import pool from '../system/pooling.js';
          * x/y scaling ratio for ellipse
          * @public
          * @type {Vector2d}
-         * @name ratio
-         * @memberof Ellipse
          */
         this.ratio = pool.pull("Vector2d");
 
@@ -82,8 +72,6 @@ import pool from '../system/pooling.js';
 
     /**
      * set new value to the Ellipse shape
-     * @name setShape
-     * @memberof Ellipse
      * @param {number} x - the center x coordinate of the ellipse
      * @param {number} y - the center y coordinate of the ellipse
      * @param {number} w - width (diameter) of the ellipse
@@ -111,8 +99,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Rotate this Ellipse (counter-clockwise) by the specified angle (in radians).
-     * @name rotate
-     * @memberof Ellipse
      * @param {number} angle - The angle to rotate (in radians)
      * @param {Vector2d|ObservableVector2d} [v] - an optional point to rotate around
      * @returns {Ellipse} Reference to this object for method chaining
@@ -127,10 +113,8 @@ import pool from '../system/pooling.js';
 
     /**
      * Scale this Ellipse by the specified scalar.
-     * @name scale
-     * @memberof Ellipse
-     * @param {number} x
-     * @param {number} [y=x]
+     * @param {number} x - the scale factor along the x-axis
+     * @param {number} [y=x] - the scale factor along the y-axis
      * @returns {Ellipse} Reference to this object for method chaining
      */
     scale(x, y = x) {
@@ -144,8 +128,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Scale this Ellipse by the specified vector.
-     * @name scale
-     * @memberof Ellipse
      * @param {Vector2d} v
      * @returns {Ellipse} Reference to this object for method chaining
      */
@@ -155,8 +137,6 @@ import pool from '../system/pooling.js';
 
     /**
      * apply the given transformation matrix to this ellipse
-     * @name transform
-     * @memberof Ellipse
      * @param {Matrix2d} matrix - the transformation matrix
      * @returns {Polygon} Reference to this object for method chaining
      */
@@ -167,19 +147,13 @@ import pool from '../system/pooling.js';
 
     /**
      * translate the circle/ellipse by the specified offset
-     * @name translate
-     * @memberof Ellipse
-     * @method
-     * @param {number} x - x offset
-     * @param {number} y - y offset
-     * @returns {Ellipse} this ellipse
-     */
-    /**
-     * translate the circle/ellipse by the specified vector
-     * @name translate
-     * @memberof Ellipse
-     * @param {Vector2d} v - vector offset
+     * @param {number|Vector2d} x -  x coordinate or a vector point to translate by
+     * @param {number} [y] - y offset
      * @returns {Ellipse} this ellipse
+     * @example
+     * ellipse.translate(10, 10);
+     * // or
+     * ellipse.translate(myVector2d);
      */
     translate() {
         let _x, _y;
@@ -203,32 +177,29 @@ import pool from '../system/pooling.js';
 
     /**
      * check if this circle/ellipse contains the specified point
-     * @name contains
-     * @method
-     * @memberof Ellipse
-     * @param {Vector2d} point
-     * @returns {boolean} true if contains
-     */
-
-    /**
-     * check if this circle/ellipse contains the specified point
-     * @name contains
-     * @memberof Ellipse
-     * @param  {number} x -  x coordinate
-     * @param  {number} y -  y coordinate
+     * @param {number|Vector2d} x -  x coordinate or a vector point to check
+     * @param {number} [y] -  y coordinate
      * @returns {boolean} true if contains
+     * @example
+     * if (circle.contains(10, 10)) {
+     *   // do something
+     * }
+     * // or
+     * if (circle.contains(myVector2d)) {
+     *  // do something
+     * }
      */
     contains() {
         let _x, _y;
 
         if (arguments.length === 2) {
-          // x, y
-          _x = arguments[0];
-          _y = arguments[1];
+            // x, y
+            _x = arguments[0];
+            _y = arguments[1];
         } else {
-          // vector
-          _x = arguments[0].x;
-          _y = arguments[0].y;
+            // vector
+            _x = arguments[0].x;
+            _y = arguments[0].y;
         }
 
         // Make position relative to object center point.
@@ -243,8 +214,6 @@ import pool from '../system/pooling.js';
 
     /**
      * returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
-     * @name getBounds
-     * @memberof Ellipse
      * @returns {Bounds} this shape bounding box Rectangle object
      */
     getBounds() {
@@ -256,8 +225,6 @@ import pool from '../system/pooling.js';
 
     /**
      * clone this Ellipse
-     * @name clone
-     * @memberof Ellipse
      * @returns {Ellipse} new Ellipse
      */
     clone() {

package/dist/melonjs.mjs/geometries/line.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.3.0
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -17,36 +17,33 @@ import Polygon from './poly.js';
  * @param {Vector2d[]} points - array of vectors defining the Line
  */
 
- class Line extends Polygon {
+class Line extends Polygon {
 
     /**
      * Returns true if the Line contains the given point
-     * @name contains
-     * @memberof Line
-     * @method
-     * @param {Vector2d} point
-     * @returns {boolean} true if contains
-     */
-
-    /**
-     * Returns true if the Line contains the given point
-     * @name contains
-     * @memberof Line
-     * @param  {number} x -  x coordinate
-     * @param  {number} y -  y coordinate
+     * @param {number|Vector2d} x -  x coordinate or a vector point to check
+     * @param {number} [y] -  y coordinate
      * @returns {boolean} true if contains
+     * @example
+     * if (line.contains(10, 10)) {
+     *   // do something
+     * }
+     * // or
+     * if (line.contains(myVector2d)) {
+     *   // do something
+     * }
      */
     contains() {
         let _x, _y;
 
         if (arguments.length === 2) {
-          // x, y
-          _x = arguments[0];
-          _y = arguments[1];
+            // x, y
+            _x = arguments[0];
+            _y = arguments[1];
         } else {
-          // vector
-          _x = arguments[0].x;
-          _y = arguments[0].y;
+            // vector
+            _x = arguments[0].x;
+            _y = arguments[0].y;
         }
 
         // translate the given coordinates,
@@ -63,8 +60,6 @@ import Polygon from './poly.js';
     /**
      * Computes the calculated collision edges and normals.
      * This **must** be called if the `points` array, `angle`, or `offset` is modified manually.
-     * @name recalc
-     * @memberof Line
      * @returns {Line} this instance for objecf chaining
      */
     recalc() {
@@ -98,8 +93,6 @@ import Polygon from './poly.js';
 
     /**
      * clone this line segment
-     * @name clone
-     * @memberof Line
      * @returns {Line} new Line
      */
     clone() {