foster/liabru-matter-js
0
0
Fork 0
mirror of https://github.com/liabru/matter-js.git synced 2025-01-13 16:18:50 -05:00
Code Issues Wiki Activity

add docs for Matter.Body velocity properties including unit details

Browse source
This commit is contained in:
liabru 2022-01-04 11:05:09 +00:00
parent db780c371c
commit 181d08bbf7
1 changed files with 36 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
src/body/Body.js
View file

@ -972,7 +972,16 @@ var Axes = require('../geometry/Axes');
*/
/**
* Internal only. Use `Body.getSpeed` and `Body.setSpeed` instead.
* _Read only_. Use `Body.setSpeed` to set.
*
* The body's current linear speed in _unit distance_ per _unit time_.
*
* By default when using `Matter.Render` this is equivalent to
* _pixels_ per `Common._timeUnit` _milliseconds_.
*
* See `Common._timeUnit` for more details.
*
* Equivalent to the magnitude of `body.velocity` (always positive).
*
* @readOnly
* @property speed
@ -981,7 +990,16 @@ var Axes = require('../geometry/Axes');
*/
/**
* Internal only. Use `Body.getAngularSpeed` and `Body.setAngularSpeed` instead.
* _Read only_. Use `Body.setAngularSpeed` to set.
*
* The body's current rotational speed in _radians_ per _unit time_.
*
* By default when using `Matter.Render` this is equivalent to
* _radians_ per `Common._timeUnit` _milliseconds_.
*
* See `Common._timeUnit` for more details.
*
* Equivalent to the magnitude of `body.angularVelocity` (always positive).
*
* @readOnly
* @property angularSpeed
@ -990,7 +1008,14 @@ var Axes = require('../geometry/Axes');
*/
/**
* Internal only. Use `Body.getVelocity` and `Body.setVelocity` instead.
* _Read only_. Use `Body.setVelocity` to set.
*
* The body's current linear velocity in _unit distance_ per _unit time_.
*
* By default when using `Matter.Render` this is equivalent to
* _pixels_ per `Common._timeUnit` _milliseconds_.
*
* See `Common._timeUnit` for more details.
*
* @readOnly
* @property velocity
@ -999,7 +1024,14 @@ var Axes = require('../geometry/Axes');
*/
/**
* Internal only. Use `Body.getAngularVelocity` and `Body.setAngularVelocity` instead.
* _Read only_. Use `Body.setAngularVelocity` to set.
*
* The body's current rotational velocity in _radians_ per _unit time_.
*
* By default when using `Matter.Render` this is equivalent to
* _radians_ per `Common._timeUnit` _milliseconds_.
*
* See `Common._timeUnit` for more details.
*
* @readOnly
* @property angularVelocity