0
0
Fork 0
mirror of https://github.com/liabru/matter-js.git synced 2024-12-24 13:29:01 -05:00

added docs for body.chamfer property, closes #1059

This commit is contained in:
liabru 2023-03-18 13:49:56 +00:00
parent 7ea5bc1352
commit 5ed985db18

View file

@ -1437,4 +1437,17 @@ var Axes = require('../geometry/Axes');
* @type bounds
*/
/**
* Temporarily may hold parameters to be passed to `Vertices.chamfer` where supported by external functions.
*
* See `Vertices.chamfer` for possible parameters this object may hold.
*
* Currently only functions inside `Matter.Bodies` provide a utility using this property as a vertices pre-processing option.
*
* Alternatively consider using `Vertices.chamfer` directly on vertices before passing them to a body creation function.
*
* @property chamfer
* @type object|null|undefined
*/
})();