summaryrefslogtreecommitdiff
path: root/doc/classes/NavigationPathQueryResult3D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/NavigationPathQueryResult3D.xml')
-rw-r--r--doc/classes/NavigationPathQueryResult3D.xml24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/classes/NavigationPathQueryResult3D.xml b/doc/classes/NavigationPathQueryResult3D.xml
new file mode 100644
index 0000000000..6c553bf36b
--- /dev/null
+++ b/doc/classes/NavigationPathQueryResult3D.xml
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="NavigationPathQueryResult3D" inherits="RefCounted" is_experimental="true" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+ <brief_description>
+ Result from a [NavigationPathQueryParameters3D] navigation path query.
+ </brief_description>
+ <description>
+ This class contains the result of a navigation path query from [method NavigationServer3D.query_path].
+ </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].
+ </member>
+ </members>
+</class>