summaryrefslogtreecommitdiff
path: root/doc/classes/CollisionObject.xml
blob: 791978993c966019a0477afafc215888409fc88c (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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CollisionObject" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
	</brief_description>
	<description>
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="_input_event" qualifiers="virtual">
			<return type="void">
			</return>
			<argument index="0" name="camera" type="Object">
			</argument>
			<argument index="1" name="event" type="InputEvent">
			</argument>
			<argument index="2" name="click_pos" type="Vector3">
			</argument>
			<argument index="3" name="click_normal" type="Vector3">
			</argument>
			<argument index="4" name="shape_idx" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="create_shape_owner">
			<return type="int">
			</return>
			<argument index="0" name="owner" type="Object">
			</argument>
			<description>
				Creates new holder for the shapes. Argument is a [CollisionShape] node. It will return owner_id which usually you will want to save for later use.
			</description>
		</method>
		<method name="get_capture_input_on_drag" qualifiers="const">
			<return type="bool">
			</return>
			<description>
			</description>
		</method>
		<method name="get_rid" qualifiers="const">
			<return type="RID">
			</return>
			<description>
			</description>
		</method>
		<method name="get_shape_owners">
			<return type="Array">
			</return>
			<description>
				Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods.
			</description>
		</method>
		<method name="is_ray_pickable" qualifiers="const">
			<return type="bool">
			</return>
			<description>
			</description>
		</method>
		<method name="is_shape_owner_disabled" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="owner_id" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="remove_shape_owner">
			<return type="void">
			</return>
			<argument index="0" name="owner_id" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_capture_input_on_drag">
			<return type="void">
			</return>
			<argument index="0" name="enable" type="bool">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_ray_pickable">
			<return type="void">
			</return>
			<argument index="0" name="ray_pickable" type="bool">
			</argument>
			<description>
			</description>
		</method>
		<method name="shape_find_owner" qualifiers="const">
			<return type="int">
			</return>
			<argument index="0" name="shape_index" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="shape_owner_add_shape">
			<return type="void">
			</return>
			<argument index="0" name="owner_id" type="int">
			</argument>
			<argument index="1" name="shape" type="Shape">
			</argument>
			<description>
			</description>
		</method>
		<method name="shape_owner_clear_shapes">
			<return type="void">
			</return>
			<argument index="0" name="owner_id" type="int">
			</argument>
			<description>
				Will remove all the shapes associated with given owner.
			</description>
		</method>
		<method name="shape_owner_get_owner" qualifiers="const">
			<return type="Object">
			</return>
			<argument index="0" name="owner_id" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="shape_owner_get_shape" qualifiers="const">
			<return type="Shape">
			</return>
			<argument index="0" name="owner_id" type="int">
			</argument>
			<argument index="1" name="shape_id" type="int">
			</argument>
			<description>
				Will return a [Shape]. First argument owner_id is an integer that can be obtained from [method get_shape_owners]. Shape_id is a position of the shape inside owner; it's a value in range from 0 to [method shape_owner_get_shape_count].
			</description>
		</method>
		<method name="shape_owner_get_shape_count" qualifiers="const">
			<return type="int">
			</return>
			<argument index="0" name="owner_id" type="int">
			</argument>
			<description>
				Returns number of shapes to which given owner is associated to.
			</description>
		</method>
		<method name="shape_owner_get_shape_index" qualifiers="const">
			<return type="int">
			</return>
			<argument index="0" name="owner_id" type="int">
			</argument>
			<argument index="1" name="shape_id" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="shape_owner_get_transform" qualifiers="const">
			<return type="Transform">
			</return>
			<argument index="0" name="owner_id" type="int">
			</argument>
			<description>
				Will return [Transform] of an owner node.
			</description>
		</method>
		<method name="shape_owner_remove_shape">
			<return type="void">
			</return>
			<argument index="0" name="owner_id" type="int">
			</argument>
			<argument index="1" name="shape_id" type="int">
			</argument>
			<description>
				Removes related shape from the owner.
			</description>
		</method>
		<method name="shape_owner_set_disabled">
			<return type="void">
			</return>
			<argument index="0" name="owner_id" type="int">
			</argument>
			<argument index="1" name="disabled" type="bool">
			</argument>
			<description>
			</description>
		</method>
		<method name="shape_owner_set_transform">
			<return type="void">
			</return>
			<argument index="0" name="owner_id" type="int">
			</argument>
			<argument index="1" name="transform" type="Transform">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="input_capture_on_drag" type="bool" setter="set_capture_input_on_drag" getter="get_capture_input_on_drag">
		</member>
		<member name="input_ray_pickable" type="bool" setter="set_ray_pickable" getter="is_ray_pickable">
		</member>
	</members>
	<signals>
		<signal name="input_event">
			<argument index="0" name="camera" type="Object">
			</argument>
			<argument index="1" name="event" type="Object">
			</argument>
			<argument index="2" name="click_pos" type="Vector3">
			</argument>
			<argument index="3" name="click_normal" type="Vector3">
			</argument>
			<argument index="4" name="shape_idx" type="int">
			</argument>
			<description>
			</description>
		</signal>
		<signal name="mouse_entered">
			<description>
			</description>
		</signal>
		<signal name="mouse_exited">
			<description>
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>