summaryrefslogtreecommitdiff
path: root/doc/classes/Joint.xml
blob: 14116afddffa73a6b8420d4e92bb277b65c2262d (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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Joint" inherits="Spatial" category="Core" version="3.0-beta">
	<brief_description>
		Base class for all 3D joints
	</brief_description>
	<description>
		All 3D joints link two nodes, has a priority, and can decide if the two bodies of the nodes should be able to collide with each other
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_exclude_nodes_from_collision" qualifiers="const">
			<return type="bool">
			</return>
			<description>
			</description>
		</method>
		<method name="get_node_a" qualifiers="const">
			<return type="NodePath">
			</return>
			<description>
			</description>
		</method>
		<method name="get_node_b" qualifiers="const">
			<return type="NodePath">
			</return>
			<description>
			</description>
		</method>
		<method name="get_solver_priority" qualifiers="const">
			<return type="int">
			</return>
			<description>
			</description>
		</method>
		<method name="set_exclude_nodes_from_collision">
			<return type="void">
			</return>
			<argument index="0" name="enable" type="bool">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_node_a">
			<return type="void">
			</return>
			<argument index="0" name="node" type="NodePath">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_node_b">
			<return type="void">
			</return>
			<argument index="0" name="node" type="NodePath">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_solver_priority">
			<return type="void">
			</return>
			<argument index="0" name="priority" type="int">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="collision/exclude_nodes" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision">
			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">
			The [Node], the first side of the Joint attaches to.
		</member>
		<member name="nodes/node_b" type="NodePath" setter="set_node_b" getter="get_node_b">
			The [Node], the second side of the Joint attaches to.
		</member>
		<member name="solver/priority" type="int" setter="set_solver_priority" getter="get_solver_priority">
			The order in wich the solver is executed compared to the other [Joints], the lower, the earlier.
		</member>
	</members>
	<constants>
	</constants>
</class>