sm.body
A body is a collection of shapes that are built together. Bodies can be connected to other bodies using joints such as the bearing.
Server + Client
getAllBodies
sm.body.getAllBodies( world )
Returns a table with all the bodies in the world.
Parameters:
| Name | Type | Description |
|---|---|---|
world (optional) |
World | The world, will default to the script's world. (optional) |
Returns:
| Type | Description |
|---|---|
| table | The table of all bodies. {Body, ...} |
getCreationsFromBodies
sm.body.getCreationsFromBodies( bodies )
Returns a table of tables, which is an array of tables containing bodies grouped by creation.
A creation includes all bodies connected by joints, etc.
Parameters:
| Name | Type | Description |
|---|---|---|
bodies |
table | The bodies to find all creation bodies from. {Body, ...} |
Returns:
| Type | Description |
|---|---|
| table | The table array containing tables of all the bodies, grouped by creation. { {Body, ...}, ... } |
getLift
sm.body.getLift( body )
Get the lift a body is on.
Parameters:
| Name | Type | Description |
|---|---|---|
body |
Body | The body. |
Returns:
| Type | Description |
|---|---|
| Lift | The lift the body is on, or nil if the body is not on a lift. |
Server-only
createBody
sm.body.createBody( position, rotation, isDynamic )
Create a new body
Parameters:
| Name | Type | Description |
|---|---|---|
position |
Vec3 | The body's world position. |
rotation (optional) |
Quat | The body's world rotation. (Defaults to sm.quat.identity) |
isDynamic (optional) |
boolean | Set true if the body is dynamic or false if the body is static. (Defaults to true) |
Returns:
| Type | Description |
|---|---|
| Body | The created body |