mirror of
https://github.com/godotengine/godot.git
synced 2024-10-23 13:41:43 +00:00
b68dd2e189
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
51 lines
2.2 KiB
XML
51 lines
2.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="PinJoint3D" inherits="Joint3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Pin joint for 3D PhysicsBodies.
|
|
</brief_description>
|
|
<description>
|
|
Pin joint for 3D rigid bodies. It pins 2 bodies (dynamic or static) together. See also [Generic6DOFJoint3D].
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_param" qualifiers="const">
|
|
<return type="float" />
|
|
<argument index="0" name="param" type="int" enum="PinJoint3D.Param" />
|
|
<description>
|
|
Returns the value of the specified parameter.
|
|
</description>
|
|
</method>
|
|
<method name="set_param">
|
|
<return type="void" />
|
|
<argument index="0" name="param" type="int" enum="PinJoint3D.Param" />
|
|
<argument index="1" name="value" type="float" />
|
|
<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 Joint3D 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 Joint3D produces.
|
|
</constant>
|
|
</constants>
|
|
</class>
|