58 lines
1.8 KiB
XML
58 lines
1.8 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="GrooveJoint2D" inherits="Joint2D" category="Core" version="3.0.alpha.custom_build">
|
|
<brief_description>
|
|
Groove constraint for 2D physics.
|
|
</brief_description>
|
|
<description>
|
|
Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<demos>
|
|
</demos>
|
|
<methods>
|
|
<method name="get_initial_offset" qualifiers="const">
|
|
<return type="float">
|
|
</return>
|
|
<description>
|
|
Set the final offset of the groove on body A.
|
|
</description>
|
|
</method>
|
|
<method name="get_length" qualifiers="const">
|
|
<return type="float">
|
|
</return>
|
|
<description>
|
|
Return the length of the groove.
|
|
</description>
|
|
</method>
|
|
<method name="set_initial_offset">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="offset" type="float">
|
|
</argument>
|
|
<description>
|
|
Set the initial offset of the groove on body A.
|
|
</description>
|
|
</method>
|
|
<method name="set_length">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="length" type="float">
|
|
</argument>
|
|
<description>
|
|
Set the length of the groove.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="initial_offset" type="float" setter="set_initial_offset" getter="get_initial_offset">
|
|
The body B's initial anchor position defined by the joint's origin and a local offset [member initial_offset] along the joint's y axis (along the groove). Default value: [code]25[/code]
|
|
</member>
|
|
<member name="length" type="float" setter="set_length" getter="get_length">
|
|
The groove's length. The groove is from the joint's origin towards [member length] along the joint's local y axis. Default value: [code]50[/code]
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|