godot/doc/classes/PinJoint.xml
2021-04-26 13:15:29 +02:00

56 lines
2.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PinJoint" inherits="Joint" version="3.4">
<brief_description>
Pin joint for 3D PhysicsBodies.
</brief_description>
<description>
Pin joint for 3D rigid bodies. It pins 2 bodies (rigid or static) together. See also [Generic6DOFJoint].
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_param" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="PinJoint.Param">
</argument>
<description>
Returns the value of the specified parameter.
</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>
Sets the value of the specified parameter.
</description>
</method>
</methods>
<members>
<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" 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" 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.
</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.
</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.
</constant>
</constants>
</class>