summaryrefslogtreecommitdiff
path: root/doc/classes/HingeJoint.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/HingeJoint.xml')
-rw-r--r--doc/classes/HingeJoint.xml56
1 files changed, 46 insertions, 10 deletions
diff --git a/doc/classes/HingeJoint.xml b/doc/classes/HingeJoint.xml
index 0a4c4d6564..4582e36da6 100644
--- a/doc/classes/HingeJoint.xml
+++ b/doc/classes/HingeJoint.xml
@@ -9,35 +9,71 @@
<tutorials>
</tutorials>
<methods>
+ <method name="get_flag" qualifiers="const">
+ <return type="bool">
+ </return>
+ <argument index="0" name="flag" type="int" enum="HingeJoint.Flag">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="get_param" qualifiers="const">
+ <return type="float">
+ </return>
+ <argument index="0" name="param" type="int" enum="HingeJoint.Param">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_flag">
+ <return type="void">
+ </return>
+ <argument index="0" name="flag" type="int" enum="HingeJoint.Flag">
+ </argument>
+ <argument index="1" name="enabled" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_param">
+ <return type="void">
+ </return>
+ <argument index="0" name="param" type="int" enum="HingeJoint.Param">
+ </argument>
+ <argument index="1" name="value" type="float">
+ </argument>
+ <description>
+ </description>
+ </method>
</methods>
<members>
- <member name="angular_limit/bias" type="float" setter="set_param" getter="get_param">
+ <member name="angular_limit/bias" type="float" setter="set_param" getter="get_param" default="0.3">
The speed with which the rotation across the axis perpendicular to the hinge gets corrected.
</member>
- <member name="angular_limit/enable" type="bool" setter="set_flag" getter="get_flag">
+ <member name="angular_limit/enable" type="bool" setter="set_flag" getter="get_flag" default="false">
If [code]true[/code], the hinges maximum and minimum rotation, defined by [member angular_limit/lower] and [member angular_limit/upper] has effects.
</member>
- <member name="angular_limit/lower" type="float" setter="_set_lower_limit" getter="_get_lower_limit">
+ <member name="angular_limit/lower" type="float" setter="_set_lower_limit" getter="_get_lower_limit" default="-90.0">
The minimum rotation. Only active if [member angular_limit/enable] is [code]true[/code].
</member>
- <member name="angular_limit/relaxation" type="float" setter="set_param" getter="get_param">
+ <member name="angular_limit/relaxation" type="float" setter="set_param" getter="get_param" default="1.0">
The lower this value, the more the rotation gets slowed down.
</member>
- <member name="angular_limit/softness" type="float" setter="set_param" getter="get_param">
+ <member name="angular_limit/softness" type="float" setter="set_param" getter="get_param" default="0.9">
</member>
- <member name="angular_limit/upper" type="float" setter="_set_upper_limit" getter="_get_upper_limit">
+ <member name="angular_limit/upper" type="float" setter="_set_upper_limit" getter="_get_upper_limit" default="90.0">
The maximum rotation. Only active if [member angular_limit/enable] is [code]true[/code].
</member>
- <member name="motor/enable" type="bool" setter="set_flag" getter="get_flag">
+ <member name="motor/enable" type="bool" setter="set_flag" getter="get_flag" default="false">
When activated, a motor turns the hinge.
</member>
- <member name="motor/max_impulse" type="float" setter="set_param" getter="get_param">
+ <member name="motor/max_impulse" type="float" setter="set_param" getter="get_param" default="1.0">
Maximum acceleration for the motor.
</member>
- <member name="motor/target_velocity" type="float" setter="set_param" getter="get_param">
+ <member name="motor/target_velocity" type="float" setter="set_param" getter="get_param" default="1.0">
Target speed for the motor.
</member>
- <member name="params/bias" type="float" setter="set_param" getter="get_param">
+ <member name="params/bias" type="float" setter="set_param" getter="get_param" default="0.3">
The speed with which the two bodies get pulled together when they move in different directions.
</member>
</members>