diff options
| author | Josh Jones <kilauea.jones@gmail.com> | 2022-09-19 22:56:54 -0700 |
|---|---|---|
| committer | Josh Jones <kilauea.jones@gmail.com> | 2022-09-28 23:01:12 -0600 |
| commit | a2c53b881b1a54c95036f27577ee7d9b6e583d62 (patch) | |
| tree | aa84002a7cb9f54d3347f8e9c827a991e44b49ef /doc | |
| parent | c2f66648f1cb7f26adf77cc3cf91052c95be5dbe (diff) | |
Update NavigationAgent to use query_path
This paves the way for having agents respond to link traversal.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/NavigationPathQueryResult2D.xml | 8 | ||||
| -rw-r--r-- | doc/classes/NavigationPathQueryResult3D.xml | 8 |
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]. |