mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 20:29:03 +00:00
68 lines
3.1 KiB
ReStructuredText
68 lines
3.1 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationPathQueryResult2D.xml.
|
|
|
|
.. _class_NavigationPathQueryResult2D:
|
|
|
|
NavigationPathQueryResult2D
|
|
===========================
|
|
|
|
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Result from a :ref:`NavigationPathQueryParameters2D<class_NavigationPathQueryParameters2D>` navigation path query.
|
|
|
|
Description
|
|
-----------
|
|
|
|
This class contains the result of a navigation path query from :ref:`NavigationServer2D.query_path<class_NavigationServer2D_method_query_path>`.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------------------------------------+--------------------------------------------------------------+--------------------------+
|
|
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`path<class_NavigationPathQueryResult2D_property_path>` | ``PackedVector2Array()`` |
|
|
+-----------------------------------------------------+--------------------------------------------------------------+--------------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+------+--------------------------------------------------------------------------+
|
|
| void | :ref:`reset<class_NavigationPathQueryResult2D_method_reset>` **(** **)** |
|
|
+------+--------------------------------------------------------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_NavigationPathQueryResult2D_property_path:
|
|
|
|
- :ref:`PackedVector2Array<class_PackedVector2Array>` **path**
|
|
|
|
+-----------+--------------------------+
|
|
| *Default* | ``PackedVector2Array()`` |
|
|
+-----------+--------------------------+
|
|
| *Setter* | set_path(value) |
|
|
+-----------+--------------------------+
|
|
| *Getter* | get_path() |
|
|
+-----------+--------------------------+
|
|
|
|
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 :ref:`NavigationServer2D.map_get_path<class_NavigationServer2D_method_map_get_path>`.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_NavigationPathQueryResult2D_method_reset:
|
|
|
|
- void **reset** **(** **)**
|
|
|
|
Reset the result object to its initial state. This is useful to reuse the object across multiple queries.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|