mirror of
https://github.com/liabru/matter-js.git
synced 2025-01-12 16:08:50 -05:00
Merge pull request #232 from Rantanen/docs
Document World bounds and Grid bucket size.
This commit is contained in:
commit
79fa57e3cd
2 changed files with 24 additions and 0 deletions
|
@ -85,6 +85,14 @@ var Common = require('../core/Common');
|
|||
* @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
|
||||
// see src/module/Outro.js for these aliases:
|
||||
|
||||
|
|
|
@ -34,6 +34,22 @@ var Common = require('../core/Common');
|
|||
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.
|
||||
* @method update
|
||||
|
|
Loading…
Reference in a new issue