summaryrefslogtreecommitdiff
path: root/doc/classes/GrooveJoint2D.xml
blob: 643b7aefea0cf8ceb839b6901d39f18dcc037ee4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GrooveJoint2D" inherits="Joint2D" version="4.0">
	<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>
	<methods>
	</methods>
	<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>
	<constants>
	</constants>
</class>