summaryrefslogtreecommitdiff
path: root/doc/classes/HingeJoint3D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/HingeJoint3D.xml')
-rw-r--r--doc/classes/HingeJoint3D.xml34
1 files changed, 12 insertions, 22 deletions
diff --git a/doc/classes/HingeJoint3D.xml b/doc/classes/HingeJoint3D.xml
index 2d4480cb20..a8e7f343ff 100644
--- a/doc/classes/HingeJoint3D.xml
+++ b/doc/classes/HingeJoint3D.xml
@@ -1,50 +1,40 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="HingeJoint3D" inherits="Joint3D" version="4.0">
<brief_description>
- A hinge between two 3D bodies.
+ A hinge between two 3D PhysicsBodies.
</brief_description>
<description>
- A HingeJoint3D normally uses the Z axis of body A as the hinge axis, another axis can be specified when adding it manually though.
+ A HingeJoint3D normally uses the Z axis of body A as the hinge axis, another axis can be specified when adding it manually though. See also [Generic6DOFJoint3D].
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_flag" qualifiers="const">
- <return type="bool">
- </return>
- <argument index="0" name="flag" type="int" enum="HingeJoint3D.Flag">
- </argument>
+ <return type="bool" />
+ <argument index="0" name="flag" type="int" enum="HingeJoint3D.Flag" />
<description>
Returns the value of the specified flag.
</description>
</method>
<method name="get_param" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="param" type="int" enum="HingeJoint3D.Param">
- </argument>
+ <return type="float" />
+ <argument index="0" name="param" type="int" enum="HingeJoint3D.Param" />
<description>
Returns the value of the specified parameter.
</description>
</method>
<method name="set_flag">
- <return type="void">
- </return>
- <argument index="0" name="flag" type="int" enum="HingeJoint3D.Flag">
- </argument>
- <argument index="1" name="enabled" type="bool">
- </argument>
+ <return type="void" />
+ <argument index="0" name="flag" type="int" enum="HingeJoint3D.Flag" />
+ <argument index="1" name="enabled" type="bool" />
<description>
If [code]true[/code], enables the specified flag.
</description>
</method>
<method name="set_param">
- <return type="void">
- </return>
- <argument index="0" name="param" type="int" enum="HingeJoint3D.Param">
- </argument>
- <argument index="1" name="value" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="param" type="int" enum="HingeJoint3D.Param" />
+ <argument index="1" name="value" type="float" />
<description>
Sets the value of the specified parameter.
</description>