diff options
Diffstat (limited to 'doc/classes/GrooveJoint2D.xml')
| -rw-r--r-- | doc/classes/GrooveJoint2D.xml | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/classes/GrooveJoint2D.xml b/doc/classes/GrooveJoint2D.xml new file mode 100644 index 0000000000..3db2d9aee9 --- /dev/null +++ b/doc/classes/GrooveJoint2D.xml @@ -0,0 +1,55 @@ +<?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"> + </member> + <member name="length" type="float" setter="set_length" getter="get_length"> + </member> + </members> + <constants> + </constants> +</class> |