0
0
Fork 0
mirror of https://github.com/liabru/matter-js.git synced 2025-01-12 16:08:50 -05:00

Document World bounds and Grid bucket size.

Added jsdoc comments for the following properties:

- `world.bounds`
- `grid.bucketWidth`
- `grid.bucketHeight`
This commit is contained in:
Mikko Rantanen 2016-04-02 13:49:43 +03:00
parent a5b535d529
commit 5054c9717c
2 changed files with 24 additions and 0 deletions

View file

@ -85,6 +85,14 @@ var Common = require('../core/Common');
* @default 0.001 * @default 0.001
*/ */
/**
* A `Bounds` object that defines the world bounds for collision detection.
*
* @property bounds
* @type bounds
* @default { min: { x: -Infinity, y: -Infinity }, max: { x: Infinity, y: Infinity } }
*/
// World is a Composite body // World is a Composite body
// see src/module/Outro.js for these aliases: // see src/module/Outro.js for these aliases:

View file

@ -34,6 +34,22 @@ var Common = require('../core/Common');
return Common.extend(defaults, options); return Common.extend(defaults, options);
}; };
/**
* The width of a single grid bucket.
*
* @property bucketWidth
* @type number
* @default 48
*/
/**
* The height of a single grid bucket.
*
* @property bucketHeight
* @type number
* @default 48
*/
/** /**
* Updates the grid. * Updates the grid.
* @method update * @method update