HPL3/SOMA/Scripting/Scripting Api/Joint
< HPL3 | SOMA | Scripting | Scripting Api
Jump to navigation
Jump to search
 |
This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete. |
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!
Contents
Summary
| Return Type | Function and Description |
|---|---|
| void | Joint_Break(const tString &in asJointName) Breaks the specified joint |
| float | Joint_GetForceSize(const tString &in asJointName) Gets the force magnitude applied to the specified joint |
| bool | Joint_IsBroken(const tString &in asJointName) Checks if the specified joint is broken |
| void | Joint_SetBreakable(const tString &in asJointName, bool abBreakable) Sets if the joint should be breakable by force or not |
Function Detail
Joint_Break
void Joint_Break(const tString &in asJointName)
Breaks the specified joint.
Parameters
- asJointName (tString) — name of the joint.
Returns:
- void
Joint_GetForceSize
float Joint_GetForceSize(const tString &in asJointName)
Gets the force magnitude applied to the specified joint.
Parameters
- asJointName (tString) — name of the joint.
Returns:
- float—force size
Joint_IsBroken
bool Joint_IsBroken(const tString &in asJointName)
Checks if the specified joint is broken.
Parameters
- asJointName (tString) — name of the joint.
Returns:
- bool—true if the joint is broken.
Joint_SetBreakable
void Joint_SetBreakable(const tString &in asJointName,
bool abBreakable)
Sets if the joint should be breakable by force or not.
Parameters
- asJointName (tString) — name of the joint.
- abBreakable (bool) — true if the joint should be breakable, false if it shouldn't.
Returns:
- void