summaryrefslogtreecommitdiff
path: root/doc/classes/NavigationPathQueryResult2D.xml
blob: 77b19b07b696fe8b3ea0fe289321e0a4112fd78a (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="NavigationPathQueryResult2D" 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 [NavigationPathQueryParameters2D] navigation path query.
	</brief_description>
	<description>
		This class contains the result of a navigation path query from [method NavigationServer2D.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="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].
		</member>
	</members>
</class>