Fixed JSDocs

This commit is contained in:
Richard Davey 2020-01-13 13:28:24 +00:00
parent 1928480913
commit 9c0b77db92
3 changed files with 6 additions and 6 deletions

View file

@ -1,4 +1,4 @@
/** /**
* @typedef {(MatterJS.Body|Phaser.Physics.Matter.MatterGameObject|Phaser.Physics.Matter.Image|Phaser.Physics.Matter.Sprite|Phaser.Physics.Matter.TileBody)} Phaser.Types.Physics.Matter.MatterBody * @typedef {(MatterJS.Body|Phaser.GameObjects.GameObject|Phaser.Physics.Matter.Image|Phaser.Physics.Matter.Sprite|Phaser.Physics.Matter.TileBody)} Phaser.Types.Physics.Matter.MatterBody
* @since 3.22.0 * @since 3.22.0
*/ */

View file

@ -10,10 +10,10 @@
* @property {number} depth - The depth of the collision on the minimum overlap. * @property {number} depth - The depth of the collision on the minimum overlap.
* @property {MatterJS.Body} parentA - A reference to the parent of Body A, or to Body A itself if it has no parent. * @property {MatterJS.Body} parentA - A reference to the parent of Body A, or to Body A itself if it has no parent.
* @property {MatterJS.Body} parentB - A reference to the parent of Body B, or to Body B itself if it has no parent. * @property {MatterJS.Body} parentB - A reference to the parent of Body B, or to Body B itself if it has no parent.
* @property {vector} normal - The collision normal, facing away from Body A. * @property {MatterJS.Vector} normal - The collision normal, facing away from Body A.
* @property {vector} tangent - The tangent of the collision normal. * @property {MatterJS.Vector} tangent - The tangent of the collision normal.
* @property {vector} penetration - The penetration distances between the two bodies. * @property {MatterJS.Vector} penetration - The penetration distances between the two bodies.
* @property {vector[]} supports - An array of support points, either exactly one or two points. * @property {MatterJS.Vector[]} supports - An array of support points, either exactly one or two points.
* @property {number} inverseMass - The resulting inverse mass from the collision. * @property {number} inverseMass - The resulting inverse mass from the collision.
* @property {number} friction - The resulting friction from the collision. * @property {number} friction - The resulting friction from the collision.
* @property {number} frictionStatic - The resulting static friction from the collision. * @property {number} frictionStatic - The resulting static friction from the collision.

View file

@ -5,7 +5,7 @@
* @property {string} id - The unique auto-generated collision pair id. A combination of the body A and B IDs. * @property {string} id - The unique auto-generated collision pair id. A combination of the body A and B IDs.
* @property {MatterJS.Body} bodyA - A reference to the first body involved in the collision. * @property {MatterJS.Body} bodyA - A reference to the first body involved in the collision.
* @property {MatterJS.Body} bodyB - A reference to the second body involved in the collision. * @property {MatterJS.Body} bodyB - A reference to the second body involved in the collision.
* @property {array} activeContacts - An array containing all of the active contacts between bodies A and B. * @property {MatterJS.Vector[]} activeContacts - An array containing all of the active contacts between bodies A and B.
* @property {number} separation - The amount of separation that occured between bodies A and B. * @property {number} separation - The amount of separation that occured between bodies A and B.
* @property {boolean} isActive - Is the collision still active or not? * @property {boolean} isActive - Is the collision still active or not?
* @property {boolean} confirmedActive - Has Matter determined the collision are being active yet? * @property {boolean} confirmedActive - Has Matter determined the collision are being active yet?