summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2022-09-29 15:33:25 +0200
committerRémi Verschelde <rverschelde@gmail.com>2022-09-29 15:33:25 +0200
commitf5f4d9bf0011f8904cadbd47bc6e53d4d59d7d96 (patch)
tree5a11f337fef41531b55fd21b96841c32376cd159 /doc/classes
parent6991e9b43d0954018e1a82fa4cb28af42632ae92 (diff)
parenta2c53b881b1a54c95036f27577ee7d9b6e583d62 (diff)
Merge pull request #66143 from DarkKilauea/nav-queries-agent
Update NavigationAgent to use query_path
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/NavigationPathQueryResult2D.xml8
-rw-r--r--doc/classes/NavigationPathQueryResult3D.xml8
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/classes/NavigationPathQueryResult2D.xml b/doc/classes/NavigationPathQueryResult2D.xml
index a9b12d3b94..95b90e9383 100644
--- a/doc/classes/NavigationPathQueryResult2D.xml
+++ b/doc/classes/NavigationPathQueryResult2D.xml
@@ -8,6 +8,14 @@
</description>
<tutorials>
</tutorials>
+ <methods>
+ <method name="reset">
+ <return type="void" />
+ <description>
+ Reset the result object to its initial state. This is useful to reuse the object across multiple queries.
+ </description>
+ </method>
+ </methods>
<members>
<member name="path" type="PackedVector2Array" setter="set_path" getter="get_path" default="PackedVector2Array()">
The resulting path array from the navigation query. All path array positions are in global coordinates. Without customized query parameters this is the same path as returned by [method NavigationServer2D.map_get_path].
diff --git a/doc/classes/NavigationPathQueryResult3D.xml b/doc/classes/NavigationPathQueryResult3D.xml
index d8336111fc..b4ca8288db 100644
--- a/doc/classes/NavigationPathQueryResult3D.xml
+++ b/doc/classes/NavigationPathQueryResult3D.xml
@@ -8,6 +8,14 @@
</description>
<tutorials>
</tutorials>
+ <methods>
+ <method name="reset">
+ <return type="void" />
+ <description>
+ Reset the result object to its initial state. This is useful to reuse the object across multiple queries.
+ </description>
+ </method>
+ </methods>
<members>
<member name="path" type="PackedVector3Array" setter="set_path" getter="get_path" default="PackedVector3Array()">
The resulting path array from the navigation query. All path array positions are in global coordinates. Without customized query parameters this is the same path as returned by [method NavigationServer3D.map_get_path].