2
0
mirror of https://github.com/godotengine/godot.git synced 2024-12-15 10:12:40 +08:00
godot/doc/classes/GrooveJoint2D.xml
Hugo Locurcio b68dd2e189
Add an XML schema for documentation
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.
2022-02-15 00:03:31 +01:00

20 lines
994 B
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GrooveJoint2D" inherits="Joint2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<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>
<members>
<member name="initial_offset" type="float" setter="set_initial_offset" getter="get_initial_offset" default="25.0">
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).
</member>
<member name="length" type="float" setter="set_length" getter="get_length" default="50.0">
The groove's length. The groove is from the joint's origin towards [member length] along the joint's local Y axis.
</member>
</members>
</class>