godot/doc/classes/NavigationPathQueryResult2D.xml
Josh Jones a2c53b881b Update NavigationAgent to use query_path
This paves the way for having agents respond to link traversal.
2022-09-28 23:01:12 -06:00

25 lines
1.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="NavigationPathQueryResult2D" inherits="RefCounted" 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>