diff options
Diffstat (limited to 'doc/classes/PinJoint.xml')
| -rw-r--r-- | doc/classes/PinJoint.xml | 22 |
1 files changed, 9 insertions, 13 deletions
diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml index 4546377171..10ae3d27d9 100644 --- a/doc/classes/PinJoint.xml +++ b/doc/classes/PinJoint.xml @@ -1,36 +1,32 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="PinJoint" inherits="Joint" category="Core" version="3.2"> <brief_description> - Pin Joint for 3D Shapes. + Pin joint for 3D shapes. </brief_description> <description> - Pin Joint for 3D Rigid Bodies. It pins 2 bodies (rigid or static) together. + Pin joint for 3D rigid bodies. It pins 2 bodies (rigid or static) together. </description> <tutorials> </tutorials> <methods> </methods> <members> - <member name="params/bias" type="float" setter="set_param" getter="get_param"> - The force with which the pinned objects stay in positional relation to each other. - The higher, the stronger. + <member name="params/bias" type="float" setter="set_param" getter="get_param" default="0.3"> + The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. </member> - <member name="params/damping" type="float" setter="set_param" getter="get_param"> - The force with which the pinned objects stay in velocity relation to each other. - The higher, the stronger. + <member name="params/damping" type="float" setter="set_param" getter="get_param" default="1.0"> + The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. </member> - <member name="params/impulse_clamp" type="float" setter="set_param" getter="get_param"> + <member name="params/impulse_clamp" type="float" setter="set_param" getter="get_param" default="0.0"> If above 0, this value is the maximum value for an impulse that this Joint produces. </member> </members> <constants> <constant name="PARAM_BIAS" value="0" enum="Param"> - The force with which the pinned objects stay in positional relation to each other. - The higher, the stronger. + The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. </constant> <constant name="PARAM_DAMPING" value="1" enum="Param"> - The force with which the pinned objects stay in velocity relation to each other. - The higher, the stronger. + The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. </constant> <constant name="PARAM_IMPULSE_CLAMP" value="2" enum="Param"> If above 0, this value is the maximum value for an impulse that this Joint produces. |