melonjs 10.1.0 → 10.2.2

package/src/physics/body.js

@@ -11,18 +11,12 @@ import { world } from "./../game.js";
 
 
 /**
- * a Generic Body Object with some physic properties and behavior functionality<br>
- The body object is attached as a member of a Renderable.  The Body object can handle movements of the parent with
- the body.update call.  It is important to know that when body.update is called there are several things that happen related to
- the movement and positioning of the parent renderable object.  1) The force/gravity/friction parameters are used
- to calculate a new velocity and 2) the parent position is updated by adding this to the parent.pos (position me.Vector2d)
- value. Thus Affecting the movement of the parent.  Look at the source code for /src/physics/body.js:update (me.Body.update) for
- a better understanding.
+ * a Generic Physic Body Object with some physic properties and behavior functionality, to as a member of a Renderable.
  * @class Body
  * @memberOf me
  * @constructor
  * @param {me.Renderable} ancestor the parent object this body is attached to
- * @param {me.Rect|me.Rect[]|me.Polygon|me.Polygon[]|me.Line|me.Line[]|me.Ellipse|me.Ellipse[]|me.Bounds|me.Bounds[]|Object} [shapes] a initial shape, list of shapes, or JSON object defining the body
+ * @param {me.Rect|me.Rect[]|me.Polygon|me.Polygon[]|me.Line|me.Line[]|me.Ellipse|me.Ellipse[]|me.Bounds|me.Bounds[]|object} [shapes] a initial shape, list of shapes, or JSON object defining the body
  * @param {Function} [onBodyUpdate] callback for when the body is updated (e.g. add/remove shapes)
  */
 class Body {
@@ -33,7 +27,7 @@ class Body {
          * a reference to the parent object that contains this body,
          * or undefined if it has not been added to one.
          * @public
-         * @type me.Renderable
+         * @type {me.Renderable}
          * @default undefined
          * @name me.Body#ancestor
          */
@@ -65,7 +59,7 @@ class Body {
          * The body collision mask, that defines what should collide with what.<br>
          * (by default will collide with all entities)
          * @ignore
-         * @type Number
+         * @type {number}
          * @default me.collision.types.ALL_OBJECT
          * @name collisionMask
          * @see me.collision.types
@@ -76,7 +70,7 @@ class Body {
         /**
          * define the collision type of the body for collision filtering
          * @public
-         * @type Number
+         * @type {number}
          * @default me.collision.types.ENEMY_OBJECT
          * @name collisionType
          * @see me.collision.types
@@ -90,7 +84,7 @@ class Body {
         /**
          * body velocity
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <0,0>
          * @name vel
          * @memberOf me.Body
@@ -104,7 +98,7 @@ class Body {
          * body force or acceleration (automatically) applied to the body.
          * when defining a force, user should also define a max velocity
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <0,0>
          * @name force
          * @see me.Body.setMaxVelocity
@@ -135,7 +129,7 @@ class Body {
         /**
          * body friction
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <0,0>
          * @name friction
          * @memberOf me.Body
@@ -149,7 +143,7 @@ class Body {
          * the body bouciness level when colliding with other solid bodies :
          * a value of 0 will not bounce, a value of 1 will fully rebound.
          * @public
-         * @type {Number}
+         * @type {number}
          * @default 0
          * @name bounce
          * @memberOf me.Body
@@ -159,7 +153,7 @@ class Body {
         /**
          * the body mass
          * @public
-         * @type {Number}
+         * @type {number}
          * @default 1
          * @name mass
          * @memberOf me.Body
@@ -169,7 +163,7 @@ class Body {
         /**
          * max velocity (to limit body velocity)
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <490,490>
          * @name maxVel
          * @memberOf me.Body
@@ -185,7 +179,7 @@ class Body {
          * either this body is a static body or not
          * @readonly
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name isStatic
          * @memberOf me.Body
@@ -197,7 +191,7 @@ class Body {
          * The degree to which this body is affected by the world gravity
          * @public
          * @see me.World.gravity
-         * @type Number
+         * @type {number}
          * @default 1.0
          * @name gravityScale
          * @memberOf me.Body
@@ -208,7 +202,7 @@ class Body {
          * If true this body won't be affected by the world gravity
          * @public
          * @see me.World.gravity
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name ignoreGravity
          * @memberOf me.Body
@@ -221,7 +215,7 @@ class Body {
          * false if the object is standing on something<br>
          * @readonly
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name falling
          * @memberOf me.Body
@@ -233,7 +227,7 @@ class Body {
          * equal true if the body is jumping<br>
          * @readonly
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name jumping
          * @memberOf me.Body
@@ -269,7 +263,7 @@ class Body {
      * @memberOf me.Body
      * @public
      * @function
-     * @param {Boolean} [isStatic=true]
+     * @param {boolean} [isStatic=true]
      */
     setStatic(isStatic = true) {
         this.isStatic = isStatic === true;
@@ -282,8 +276,8 @@ class Body {
      * @memberOf me.Body
      * @public
      * @function
-     * @param {me.Rect|me.Polygon|me.Line|me.Ellipse|me.Bounds|Object} shape a shape or JSON object
-     * @return {Number} the shape array length
+     * @param {me.Rect|me.Polygon|me.Line|me.Ellipse|me.Bounds|object} shape a shape or JSON object
+     * @returns {number} the shape array length
      * @example
      * // add a rectangle shape
      * this.body.addShape(new me.Rect(0, 0, image.width, image.height));
@@ -337,7 +331,7 @@ class Body {
      * @public
      * @function
      * @param {me.Vector2d[]} vertices an array of me.Vector2d points defining a convex hull
-     * @param {Number} [index=0] the shape object for which to set the vertices
+     * @param {number} [index=0] the shape object for which to set the vertices
      * @param {boolean} [clear=true] either to reset the body definition before adding the new vertices
      */
     setVertices(vertices, index = 0, clear = true) {
@@ -364,7 +358,7 @@ class Body {
      * @public
      * @function
      * @param {me.Vector2d[]} vertices an array of me.Vector2d points defining a convex hull
-     * @param {Number} [index=0] the shape object for which to set the vertices
+     * @param {number} [index=0] the shape object for which to set the vertices
      */
     addVertices(vertices, index = 0) {
         this.setVertices(vertices, index, false);
@@ -377,10 +371,10 @@ class Body {
      * @memberOf me.Body
      * @public
      * @function
-     * @param {Object} json a JSON object as exported from a Physics Editor tool
-     * @param {String} [id] an optional shape identifier within the given the json object
+     * @param {object} json a JSON object as exported from a Physics Editor tool
+     * @param {string} [id] an optional shape identifier within the given the json object
      * @see https://www.codeandweb.com/physicseditor
-     * @return {Number} how many shapes were added to the body
+     * @returns {number} how many shapes were added to the body
      * @example
      * // define the body based on the banana shape
      * this.body.fromJSON(me.loader.getJSON("shapesdef").banana);
@@ -421,8 +415,8 @@ class Body {
      * @memberOf me.Body
      * @public
      * @function
-     * @param {Number} [index=0] the shape object at the specified index
-     * @return {me.Polygon|me.Line|me.Ellipse} shape a shape object if defined
+     * @param {number} [index=0] the shape object at the specified index
+     * @returns {me.Polygon|me.Line|me.Ellipse} shape a shape object if defined
      */
     getShape(index) {
         return this.shapes[index || 0];
@@ -433,7 +427,7 @@ class Body {
      * @name getBounds
      * @memberOf me.Body
      * @function
-     * @return {me.Bounds} bounding box Rectangle object
+     * @returns {me.Bounds} bounding box Rectangle object
      */
     getBounds() {
         return this.bounds;
@@ -446,7 +440,7 @@ class Body {
      * @public
      * @function
      * @param {me.Polygon|me.Line|me.Ellipse} shape a shape object
-     * @return {Number} the shape array length
+     * @returns {number} the shape array length
      */
     removeShape(shape) {
         // clear the current bounds
@@ -467,8 +461,8 @@ class Body {
      * @memberOf me.Body
      * @public
      * @function
-     * @param {Number} index the shape object at the specified index
-     * @return {Number} the shape array length
+     * @param {number} index the shape object at the specified index
+     * @returns {number} the shape array length
      */
     removeShapeAt(index) {
         return this.removeShape(this.getShape(index));
@@ -483,7 +477,7 @@ class Body {
      * @public
      * @function
      * @see me.collision.types
-     * @param {Number} [bitmask = me.collision.types.ALL_OBJECT] the collision mask
+     * @param {number} [bitmask = me.collision.types.ALL_OBJECT] the collision mask
      * @example
      * // filter collision detection with collision shapes, enemies and collectables
      * myEntity.body.setCollisionMask(me.collision.types.WORLD_SHAPE | me.collision.types.ENEMY_OBJECT | me.collision.types.COLLECTABLE_OBJECT);
@@ -502,7 +496,7 @@ class Body {
      * @public
      * @function
      * @see me.collision.types
-     * @param {Number} type the collision type
+     * @param {number} type the collision type
      * @example
      * // set the body collision type
      * myEntity.body.collisionType = me.collision.types.PLAYER_OBJECT;
@@ -564,7 +558,7 @@ class Body {
      * @memberOf me.Body.prototype
      * @function
      * @param {Function} callback fnction to execute on each element
-     * @param {Object} [thisArg] value to use as this(i.e reference Object) when executing callback.
+     * @param {object} [thisArg] value to use as this(i.e reference Object) when executing callback.
      * @example
      * // iterate through all shapes of the physic body
      * mySprite.body.forEach((shape) => {
@@ -601,7 +595,7 @@ class Body {
      * @memberOf me.Body
      * @function
      * @param  {me.Vector2d} point
-     * @return {boolean} true if contains
+     * @returns {boolean} true if contains
      */
 
     /**
@@ -609,9 +603,9 @@ class Body {
      * @name contains
      * @memberOf me.Body
      * @function
-     * @param  {Number} x x coordinate
-     * @param  {Number} y y coordinate
-     * @return {boolean} true if contains
+     * @param  {number} x x coordinate
+     * @param  {number} y y coordinate
+     * @returns {boolean} true if contains
      */
     contains() {
         var _x, _y;
@@ -643,9 +637,9 @@ class Body {
      * @name rotate
      * @memberOf me.Body
      * @function
-     * @param {Number} angle The angle to rotate (in radians)
+     * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v=me.Body.getBounds().center] an optional point to rotate around
-     * @return {me.Body} Reference to this object for method chaining
+     * @returns {me.Body} Reference to this object for method chaining
      */
     rotate(angle, v = this.getBounds().center) {
         this.bounds.clear();
@@ -670,8 +664,8 @@ class Body {
      * @name setMaxVelocity
      * @memberOf me.Body
      * @function
-     * @param {Number} x max velocity on x axis
-     * @param {Number} y max velocity on y axis
+     * @param {number} x max velocity on x axis
+     * @param {number} y max velocity on y axis
      * @protected
      */
     setMaxVelocity(x, y) {
@@ -684,8 +678,8 @@ class Body {
      * @name setFriction
      * @memberOf me.Body
      * @function
-     * @param {Number} x horizontal friction
-     * @param {Number} y vertical friction
+     * @param {number} x horizontal friction
+     * @param {number} y vertical friction
      * @protected
      */
     setFriction(x = 0, y = 0) {
@@ -771,8 +765,8 @@ class Body {
      * @ignore
      * @memberOf me.Body
      * @function
-     * @return {boolean} true if resulting velocity is different than 0
-     * @see source code for me.Body.computeVelocity (private member)
+     * @param {number} dt time since the last update in milliseconds.
+     * @returns {boolean} true if resulting velocity is different than 0
      */
     update(dt) {
         // update the velocity

package/src/physics/bounds.js

@@ -9,7 +9,7 @@ import Polygon from "./../shapes/poly.js";
  * @constructor
  * @memberOf me
  * @param {me.Vector2d[]} [vertices] an array of me.Vector2d points
- * @return {me.Bounds} A new bounds object
+ * @returns {me.Bounds} A new bounds object
  */
 
 class Bounds {
@@ -49,10 +49,10 @@ class Bounds {
      * @name setMinMax
      * @memberOf me.Bounds
      * @function
-     * @param {Number} minX
-     * @param {Number} minY
-     * @param {Number} maxX
-     * @param {Number} maxY
+     * @param {number} minX
+     * @param {number} minY
+     * @param {number} maxX
+     * @param {number} maxY
      */
     setMinMax(minX, minY, maxX, maxY) {
         this.min.x = minX;
@@ -65,7 +65,7 @@ class Bounds {
     /**
      * x position of the bound
      * @public
-     * @type {Number}
+     * @type {number}
      * @name x
      * @memberOf me.Bounds
      */
@@ -82,7 +82,7 @@ class Bounds {
     /**
      * y position of the bounds
      * @public
-     * @type {Number}
+     * @type {number}
      * @name y
      * @memberOf me.Bounds
      */
@@ -100,7 +100,7 @@ class Bounds {
     /**
      * width of the bounds
      * @public
-     * @type {Number}
+     * @type {number}
      * @name width
      * @memberOf me.Bounds
      */
@@ -115,7 +115,7 @@ class Bounds {
     /**
      * width of the bounds
      * @public
-     * @type {Number}
+     * @type {number}
      * @name width
      * @memberOf me.Bounds
      */
@@ -130,7 +130,7 @@ class Bounds {
     /**
      * left coordinate of the bound
      * @public
-     * @type {Number}
+     * @type {number}
      * @name left
      * @memberOf me.Bounds
      */
@@ -141,7 +141,7 @@ class Bounds {
     /**
      * right coordinate of the bound
      * @public
-     * @type {Number}
+     * @type {number}
      * @name right
      * @memberOf me.Bounds
      */
@@ -152,7 +152,7 @@ class Bounds {
     /**
      * top coordinate of the bound
      * @public
-     * @type {Number}
+     * @type {number}
      * @name top
      * @memberOf me.Bounds
      */
@@ -163,7 +163,7 @@ class Bounds {
     /**
      * bottom coordinate of the bound
      * @public
-     * @type {Number}
+     * @type {number}
      * @name bottom
      * @memberOf me.Bounds
      */
@@ -174,7 +174,7 @@ class Bounds {
     /**
      * center position of the bound on the x axis
      * @public
-     * @type {Number}
+     * @type {number}
      * @name centerX
      * @memberOf me.Bounds
      */
@@ -185,7 +185,7 @@ class Bounds {
     /**
      * center position of the bound on the y axis
      * @public
-     * @type {Number}
+     * @type {number}
      * @name centerY
      * @memberOf me.Bounds
      */
@@ -260,8 +260,8 @@ class Bounds {
      * @name addPoint
      * @memberOf me.Bounds
      * @function
-     * @param {me.Vector2d} vector
-     * @param {me.Matrix2d} [matrix] an optional transform to apply to the given point
+     * @param {me.Vector2d} v
+     * @param {me.Matrix2d} [m] an optional transform to apply to the given point
      */
     addPoint(v, m) {
         if (typeof m !== "undefined") {
@@ -278,11 +278,11 @@ class Bounds {
      * @name addFrame
      * @memberOf me.Bounds
      * @function
-     * @param {Number} x0 - left X coordinates of the quad
-     * @param {Number} y0 - top Y coordinates of the quad
-     * @param {Number} x1 - right X coordinates of the quad
-     * @param {Number} y1 - bottom y coordinates of the quad
-     * @param {me.Matrix2d} [matrix] an optional transform to apply to the given frame coordinates
+     * @param {number} x0 - left X coordinates of the quad
+     * @param {number} y0 - top Y coordinates of the quad
+     * @param {number} x1 - right X coordinates of the quad
+     * @param {number} y1 - bottom y coordinates of the quad
+     * @param {me.Matrix2d} [m] an optional transform to apply to the given frame coordinates
      */
     addFrame(x0, y0, x1, y1, m) {
         var v = me.pool.pull("Vector2d");
@@ -302,16 +302,16 @@ class Bounds {
      * @memberOf me.Bounds
      * @function
      * @param {me.Vector2d} point
-     * @return {boolean} True if the bounds contain the point, otherwise false
+     * @returns {boolean} True if the bounds contain the point, otherwise false
      */
     /**
      * Returns true if the bounds contains the given point.
      * @name contains
      * @memberOf me.Bounds
      * @function
-     * @param {Number} x
-     * @param {Number} y
-     * @return {boolean} True if the bounds contain the point, otherwise false
+     * @param {number} x
+     * @param {number} y
+     * @returns {boolean} True if the bounds contain the point, otherwise false
      */
     contains() {
         var arg0 = arguments[0];
@@ -344,11 +344,11 @@ class Bounds {
      * @memberOf me.Bounds
      * @function
      * @param {me.Bounds|me.Rect} bounds
-     * @return {boolean} True if the bounds overlap, otherwise false
+     * @returns {boolean} True if the bounds overlap, otherwise false
      */
     overlaps(bounds) {
-        return (this.left <= bounds.right && this.right >= bounds.left
-            && this.bottom >= bounds.top && this.top <= bounds.bottom);
+        return !(this.right < bounds.left || this.left > bounds.right ||
+                 this.bottom < bounds.top || this.top > bounds.bottom);
     }
 
     /**
@@ -356,7 +356,7 @@ class Bounds {
      * @name isFinite
      * @memberOf me.Bounds
      * @function
-     * @return {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
+     * @returns {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
      */
     isFinite() {
         return (isFinite(this.min.x) && isFinite(this.max.x) && isFinite(this.min.y) && isFinite(this.max.y));
@@ -374,8 +374,8 @@ class Bounds {
      * @name translate
      * @memberOf me.Bounds
      * @function
-     * @param {Number} x
-     * @param {Number} y
+     * @param {number} x
+     * @param {number} y
      */
     translate() {
         var _x, _y;
@@ -406,8 +406,8 @@ class Bounds {
      * @name shift
      * @memberOf me.Bounds
      * @function
-     * @param {Number} x
-     * @param {Number} y
+     * @param {number} x
+     * @param {number} y
      */
     shift() {
         var _x, _y;
@@ -436,7 +436,7 @@ class Bounds {
      * @name clone
      * @memberOf me.Bounds
      * @function
-     * @return {me.Bounds}
+     * @returns {me.Bounds}
      */
     clone() {
         var bounds = new Bounds();
@@ -449,7 +449,7 @@ class Bounds {
      * @name toPolygon
      * @memberOf me.Bounds
      * @function
-     * @return {me.Polygon} a new Polygon that represents this bounds.
+     * @returns {me.Polygon} a new Polygon that represents this bounds.
      */
     toPolygon () {
         return new Polygon(this.x, this.y, [

package/src/physics/collision.js

@@ -14,7 +14,7 @@ var collision = {
       * @name maxChildren
       * @memberOf me.collision
       * @public
-      * @type {Number}
+      * @type {number}
       * @default 8
       * @see me.game.world.broadphase
       */
@@ -25,27 +25,26 @@ var collision = {
       * @name maxDepth
       * @memberOf me.collision
       * @public
-      * @type {Number}
+      * @type {number}
       * @default 4
       * @see me.game.world.broadphase
-      *
       */
      maxDepth : 4,
 
     /**
      * Enum for collision type values.
-     * @property NO_OBJECT to disable collision check
-     * @property PLAYER_OBJECT
-     * @property NPC_OBJECT
-     * @property ENEMY_OBJECT
-     * @property COLLECTABLE_OBJECT
-     * @property ACTION_OBJECT e.g. doors
-     * @property PROJECTILE_OBJECT e.g. missiles
-     * @property WORLD_SHAPE e.g. walls; for map collision shapes
-     * @property USER user-defined collision types (see example)
-     * @property ALL_OBJECT all of the above (including user-defined types)
+     * @property {number} NO_OBJECT to disable collision check
+     * @property {number} PLAYER_OBJECT playbable characters
+     * @property {number} NPC_OBJECT non playable characters
+     * @property {number} ENEMY_OBJECT enemies objects
+     * @property {number} COLLECTABLE_OBJECT collectable objects
+     * @property {number} ACTION_OBJECT e.g. doors
+     * @property {number} PROJECTILE_OBJECT e.g. missiles
+     * @property {number} WORLD_SHAPE e.g. walls; for map collision shapes
+     * @property {number} USER user-defined collision types (see example)
+     * @property {number} ALL_OBJECT all of the above (including user-defined types)
      * @readonly
-     * @enum {Number}
+     * @enum {number}
      * @name types
      * @memberOf me.collision
      * @see me.body.setCollisionMask
@@ -112,7 +111,7 @@ var collision = {
      * @function
      * @param {me.Line} line line to be tested for collision
      * @param {Array.<me.Renderable>} [result] a user defined array that will be populated with intersecting physic objects.
-     * @return {Array.<me.Renderable>} an array of intersecting physic objects
+     * @returns {Array.<me.Renderable>} an array of intersecting physic objects
      * @example
      *    // define a line accross the viewport
      *    var ray = new me.Line(
@@ -131,7 +130,7 @@ var collision = {
      *        // ...
      *    }
      */
-    rayCast(line, resultArray) { return rayCast(line, resultArray); }
+    rayCast(line, result) { return rayCast(line, result); }
 };
 
 export default collision;

package/src/physics/detector.js

@@ -22,7 +22,7 @@ var dummyObj = {
  * @function
  * @param {me.Renderable} a a reference to the object A.
  * @param {me.Renderable} b a reference to the object B.
- * @return {Boolean} true if they should collide, false otherwise
+ * @returns {boolean} true if they should collide, false otherwise
  */
 function shouldCollide(a, b) {
     return (
@@ -38,17 +38,16 @@ function shouldCollide(a, b) {
  * An object representing the result of an intersection.
  * @property {me.Renderable} a The first object participating in the intersection
  * @property {me.Renderable} b The second object participating in the intersection
- * @property {Number} overlap Magnitude of the overlap on the shortest colliding axis
+ * @property {number} overlap Magnitude of the overlap on the shortest colliding axis
  * @property {me.Vector2d} overlapV The overlap vector (i.e. `overlapN.scale(overlap, overlap)`). If this vector is subtracted from the position of a, a and b will no longer be colliding
  * @property {me.Vector2d} overlapN The shortest colliding axis (unit-vector)
- * @property {Boolean} aInB Whether the first object is entirely inside the second
- * @property {Boolean} bInA Whether the second object is entirely inside the first
- * @property {Number} indexShapeA The index of the colliding shape for the object a body
- * @property {Number} indexShapeB The index of the colliding shape for the object b body
+ * @property {boolean} aInB Whether the first object is entirely inside the second
+ * @property {boolean} bInA Whether the second object is entirely inside the first
+ * @property {number} indexShapeA The index of the colliding shape for the object a body
+ * @property {number} indexShapeB The index of the colliding shape for the object b body
  * @name ResponseObject
  * @memberOf me.collision
  * @public
- * @see me.collision.check
  */
 class ResponseObject {
     constructor() {
@@ -61,7 +60,6 @@ class ResponseObject {
         this.indexShapeA = -1;
         this.indexShapeB = -1;
         this.overlap = Number.MAX_VALUE;
-        return this;
     }
 
     /**
@@ -73,6 +71,7 @@ class ResponseObject {
      * @memberOf me.collision.ResponseObject
      * @public
      * @function
+     * @returns {object} this object for chaining
      */
     clear () {
         this.aInB = true;
@@ -92,9 +91,9 @@ export var globalResponse = new ResponseObject();
  * @name collisionCheck
  * @ignore
  * @function
- * @param {me.Renderable} obj object to be tested for collision
+ * @param {me.Renderable} objA object to be tested for collision
  * @param {me.collision.ResponseObject} [response=me.collision.response] a user defined response object that will be populated if they intersect.
- * @return {Boolean} in case of collision, false otherwise
+ * @returns {boolean} in case of collision, false otherwise
  */
 export function collisionCheck(objA, response = globalResponse) {
     var collisionCounter = 0;
@@ -166,7 +165,7 @@ export function collisionCheck(objA, response = globalResponse) {
  * @function
  * @param {me.Line} line line to be tested for collision
  * @param {Array.<me.Renderable>} [result] a user defined array that will be populated with intersecting physic objects.
- * @return {Array.<me.Renderable>} an array of intersecting physic objects
+ * @returns {Array.<me.Renderable>} an array of intersecting physic objects
  * @example
  *    // define a line accross the viewport
  *    var ray = new me.Line(