blob: ec14322be39529886602d819a1b5901305818fd3 (
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="NavigationServer" inherits="Object" version="4.0">
<brief_description>
Server interface for low-level 3D navigation access
</brief_description>
<description>
NavigationServer is the server responsible for all 3D navigation. It creates the agents, maps, and regions for navigation to work as expected. This keeps tracks of any call and executes them during the sync phase. This means that you can request any change to the map, using any thread, without worrying.
</description>
<tutorials>
</tutorials>
<methods>
<method name="agent_create" qualifiers="const">
<return type="RID">
</return>
<description>
Creates the agent.
</description>
</method>
<method name="agent_is_map_changed" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="agent" type="RID">
</argument>
<description>
Returns true if the map got changed the previous frame.
</description>
</method>
<method name="agent_set_callback" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="agent" type="RID">
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
<argument index="2" name="method" type="String">
</argument>
<argument index="3" name="userdata" type="Variant" default="null">
</argument>
<description>
Callback called at the end of the RVO process.
</description>
</method>
<method name="agent_set_map" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="agent" type="RID">
</argument>
<argument index="1" name="map" type="RID">
</argument>
<description>
Puts the agent in the map.
</description>
</method>
<method name="agent_set_max_neighbors" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="agent" type="RID">
</argument>
<argument index="1" name="count" type="int">
</argument>
<description>
Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe.
</description>
</method>
<method name="agent_set_max_speed" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="agent" type="RID">
</argument>
<argument index="1" name="max_speed" type="float">
</argument>
<description>
Sets the maximum speed of the agent. Must be positive.
</description>
</method>
<method name="agent_set_neighbor_dist" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="agent" type="RID">
</argument>
<argument index="1" name="dist" type="float">
</argument>
<description>
Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe.
</description>
</method>
<method name="agent_set_position" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="agent" type="RID">
</argument>
<argument index="1" name="position" type="Vector3">
</argument>
<description>
Sets the position of the agent in world space.
</description>
</method>
<method name="agent_set_radius" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="agent" type="RID">
</argument>
<argument index="1" name="radius" type="float">
</argument>
<description>
Sets the radius of the agent.
</description>
</method>
<method name="agent_set_target_velocity" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="agent" type="RID">
</argument>
<argument index="1" name="target_velocity" type="Vector3">
</argument>
<description>
Sets the new target velocity.
</description>
</method>
<method name="agent_set_time_horizon" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="agent" type="RID">
</argument>
<argument index="1" name="time" type="float">
</argument>
<description>
The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. Must be positive.
</description>
</method>
<method name="agent_set_velocity" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="agent" type="RID">
</argument>
<argument index="1" name="velocity" type="Vector3">
</argument>
<description>
Sets the current velocity of the agent.
</description>
</method>
<method name="free" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="object" type="RID">
</argument>
<description>
Destroy the RID
</description>
</method>
<method name="map_create" qualifiers="const">
<return type="RID">
</return>
<description>
Create a new map.
</description>
</method>
<method name="map_get_cell_size" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="map" type="RID">
</argument>
<description>
Returns the map cell size.
</description>
</method>
<method name="map_get_closest_point" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="map" type="RID">
</argument>
<argument index="1" name="to_point" type="Vector3">
</argument>
<description>
Returns the point closest to the provided [code]point[/code] on the navigation mesh surface.
</description>
</method>
<method name="map_get_closest_point_normal" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="map" type="RID">
</argument>
<argument index="1" name="to_point" type="Vector3">
</argument>
<description>
Returns the normal for the point returned by [method map_get_closest_point].
</description>
</method>
<method name="map_get_closest_point_owner" qualifiers="const">
<return type="RID">
</return>
<argument index="0" name="map" type="RID">
</argument>
<argument index="1" name="to_point" type="Vector3">
</argument>
<description>
Returns the owner region RID for the point returned by [method map_get_closest_point].
</description>
</method>
<method name="map_get_closest_point_to_segment" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="map" type="RID">
</argument>
<argument index="1" name="start" type="Vector3">
</argument>
<argument index="2" name="end" type="Vector3">
</argument>
<argument index="3" name="use_collision" type="bool" default="false">
</argument>
<description>
Returns the closest point between the navigation surface and the segment.
</description>
</method>
<method name="map_get_edge_connection_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="map" type="RID">
</argument>
<description>
Returns the edge connection margin of the map.
</description>
</method>
<method name="map_get_path" qualifiers="const">
<return type="PackedVector3Array">
</return>
<argument index="0" name="map" type="RID">
</argument>
<argument index="1" name="origin" type="Vector3">
</argument>
<argument index="2" name="destination" type="Vector3">
</argument>
<argument index="3" name="optimize" type="bool">
</argument>
<description>
Returns the navigation path to reach the destination from the origin.
</description>
</method>
<method name="map_get_up" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="map" type="RID">
</argument>
<description>
Returns the map's up direction.
</description>
</method>
<method name="map_is_active" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="nap" type="RID">
</argument>
<description>
Returns true if the map is active.
</description>
</method>
<method name="map_set_active" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="map" type="RID">
</argument>
<argument index="1" name="active" type="bool">
</argument>
<description>
Sets the map active.
</description>
</method>
<method name="map_set_cell_size" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="map" type="RID">
</argument>
<argument index="1" name="cell_size" type="float">
</argument>
<description>
Set the map cell size used to weld the navigation mesh polygons.
</description>
</method>
<method name="map_set_edge_connection_margin" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="map" type="RID">
</argument>
<argument index="1" name="margin" type="float">
</argument>
<description>
Set the map edge connection margein used to weld the compatible region edges.
</description>
</method>
<method name="map_set_up" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="map" type="RID">
</argument>
<argument index="1" name="up" type="Vector3">
</argument>
<description>
Sets the map up direction.
</description>
</method>
<method name="region_bake_navmesh" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="mesh" type="NavigationMesh">
</argument>
<argument index="1" name="node" type="Node">
</argument>
<description>
Bakes the navigation mesh.
</description>
</method>
<method name="region_create" qualifiers="const">
<return type="RID">
</return>
<description>
Creates a new region.
</description>
</method>
<method name="region_set_map" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="region" type="RID">
</argument>
<argument index="1" name="map" type="RID">
</argument>
<description>
Sets the map for the region.
</description>
</method>
<method name="region_set_navmesh" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="region" type="RID">
</argument>
<argument index="1" name="nav_mesh" type="NavigationMesh">
</argument>
<description>
Sets the navigation mesh for the region.
</description>
</method>
<method name="region_set_transform" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="region" type="RID">
</argument>
<argument index="1" name="transform" type="Transform">
</argument>
<description>
Sets the global transformation for the region.
</description>
</method>
<method name="set_active" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="active" type="bool">
</argument>
<description>
Control activation of this server.
</description>
</method>
<method name="step">
<return type="void">
</return>
<argument index="0" name="delta_time" type="float">
</argument>
<description>
Steps the server. This is not threadsafe and must be called in single thread.
</description>
</method>
</methods>
<constants>
</constants>
</class>
|