diff options
Diffstat (limited to 'doc/classes/PinJoint.xml')
| -rw-r--r-- | doc/classes/PinJoint.xml | 44 |
1 files changed, 28 insertions, 16 deletions
diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml index 470c22cd4c..647a59feef 100644 --- a/doc/classes/PinJoint.xml +++ b/doc/classes/PinJoint.xml @@ -1,38 +1,50 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PinJoint" inherits="Joint" category="Core" version="3.1"> +<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> - <demos> - </demos> <methods> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="param" type="int" enum="PinJoint.Param"> + </argument> + <description> + </description> + </method> + <method name="set_param"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="PinJoint.Param"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + </description> + </method> </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. |