summaryrefslogtreecommitdiff
path: root/doc/classes/Joint.xml
blob: f314f36a5fe0f7f32e5e0bbf89513fcce897cbb8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Joint" inherits="Spatial" version="3.2">
	<brief_description>
		Base class for all 3D joints.
	</brief_description>
	<description>
		Joints are used to bind together two physics bodies. They have a solver priority and can define if the bodies of the two attached nodes should be able to collide with each other.
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="collision/exclude_nodes" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision" default="true">
			If [code]true[/code], the two bodies of the nodes are not able to collide with each other.
		</member>
		<member name="nodes/node_a" type="NodePath" setter="set_node_a" getter="get_node_a" default="NodePath(&quot;&quot;)">
			The node attached to the first side (A) of the joint.
		</member>
		<member name="nodes/node_b" type="NodePath" setter="set_node_b" getter="get_node_b" default="NodePath(&quot;&quot;)">
			The node attached to the second side (B) of the joint.
		</member>
		<member name="solver/priority" type="int" setter="set_solver_priority" getter="get_solver_priority" default="1">
			The priority used to define which solver is executed first for multiple joints. The lower the value, the higher the priority.
		</member>
	</members>
	<constants>
	</constants>
</class>