summaryrefslogtreecommitdiff
path: root/doc/classes/NavigationServer.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/NavigationServer.xml')
-rw-r--r--doc/classes/NavigationServer.xml58
1 files changed, 54 insertions, 4 deletions
diff --git a/doc/classes/NavigationServer.xml b/doc/classes/NavigationServer.xml
index 7553d700f8..1f65a6004e 100644
--- a/doc/classes/NavigationServer.xml
+++ b/doc/classes/NavigationServer.xml
@@ -32,7 +32,7 @@
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
- <argument index="2" name="method" type="String">
+ <argument index="2" name="method" type="StringName">
</argument>
<argument index="3" name="userdata" type="Variant" default="null">
</argument>
@@ -164,6 +164,54 @@
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>
@@ -174,7 +222,7 @@
</description>
</method>
<method name="map_get_path" qualifiers="const">
- <return type="PoolVector3Array">
+ <return type="PackedVector3Array">
</return>
<argument index="0" name="map" type="RID">
</argument>
@@ -310,13 +358,15 @@
Control activation of this server.
</description>
</method>
- <method name="step">
+ <method name="process">
<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.
+ Process the collision avoidance agents.
+ The result of this process is needed by the physics server, so this must be called in the main thread.
+ Note: This function is not thread safe.
</description>
</method>
</methods>