: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 =========================== **Experimental:** This class may be changed or removed in future versions. **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Represents the result of a 2D pathfinding query. .. rst-class:: classref-introduction-group Description ----------- This class stores the result of a 2D navigation path query from the :ref:`NavigationServer2D`. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Using NavigationPathQueryObjects <../tutorials/navigation/navigation_using_navigationpathqueryobjects>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ | :ref:`PackedVector2Array` | :ref:`path` | ``PackedVector2Array()`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ | :ref:`PackedInt64Array` | :ref:`path_owner_ids` | ``PackedInt64Array()`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ | :ref:`Array`\[:ref:`RID`\] | :ref:`path_rids` | ``[]`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ | :ref:`PackedInt32Array` | :ref:`path_types` | ``PackedInt32Array()`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +--------+--------------------------------------------------------------------+ | |void| | :ref:`reset`\ (\ ) | +--------+--------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_NavigationPathQueryResult2D_PathSegmentType: .. rst-class:: classref-enumeration enum **PathSegmentType**: :ref:`🔗` .. _class_NavigationPathQueryResult2D_constant_PATH_SEGMENT_TYPE_REGION: .. rst-class:: classref-enumeration-constant :ref:`PathSegmentType` **PATH_SEGMENT_TYPE_REGION** = ``0`` This segment of the path goes through a region. .. _class_NavigationPathQueryResult2D_constant_PATH_SEGMENT_TYPE_LINK: .. rst-class:: classref-enumeration-constant :ref:`PathSegmentType` **PATH_SEGMENT_TYPE_LINK** = ``1`` This segment of the path goes through a link. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_NavigationPathQueryResult2D_property_path: .. rst-class:: classref-property :ref:`PackedVector2Array` **path** = ``PackedVector2Array()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_path**\ (\ value\: :ref:`PackedVector2Array`\ ) - :ref:`PackedVector2Array` **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`. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector2Array` for more details. .. rst-class:: classref-item-separator ---- .. _class_NavigationPathQueryResult2D_property_path_owner_ids: .. rst-class:: classref-property :ref:`PackedInt64Array` **path_owner_ids** = ``PackedInt64Array()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_path_owner_ids**\ (\ value\: :ref:`PackedInt64Array`\ ) - :ref:`PackedInt64Array` **get_path_owner_ids**\ (\ ) The ``ObjectID``\ s of the :ref:`Object`\ s which manage the regions and links each point of the path goes through. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt64Array` for more details. .. rst-class:: classref-item-separator ---- .. _class_NavigationPathQueryResult2D_property_path_rids: .. rst-class:: classref-property :ref:`Array`\[:ref:`RID`\] **path_rids** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_path_rids**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) - :ref:`Array`\[:ref:`RID`\] **get_path_rids**\ (\ ) The :ref:`RID`\ s of the regions and links that each point of the path goes through. .. rst-class:: classref-item-separator ---- .. _class_NavigationPathQueryResult2D_property_path_types: .. rst-class:: classref-property :ref:`PackedInt32Array` **path_types** = ``PackedInt32Array()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_path_types**\ (\ value\: :ref:`PackedInt32Array`\ ) - :ref:`PackedInt32Array` **get_path_types**\ (\ ) The type of navigation primitive (region or link) that each point of the path goes through. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_NavigationPathQueryResult2D_method_reset: .. rst-class:: classref-method |void| **reset**\ (\ ) :ref:`🔗` 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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`