godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f7cf9fb14)

Browse Source
This commit is contained in:
Rémi Verschelde
2022-12-23 23:57:40 +01:00
parent 319106ba2b
commit 16f90657da
52 changed files with 1475 additions and 543 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
classes/class_navigationpathqueryresult2d.rst
View File

@@ -29,9 +29,15 @@ Properties
.. table::
:widths: auto
+-----------------------------------------------------+--------------------------------------------------------------+--------------------------+
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`path<class_NavigationPathQueryResult2D_property_path>` | ``PackedVector2Array()`` |
+-----------------------------------------------------+--------------------------------------------------------------+--------------------------+
+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`path<class_NavigationPathQueryResult2D_property_path>` | ``PackedVector2Array()`` |
+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+
| :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`path_owner_ids<class_NavigationPathQueryResult2D_property_path_owner_ids>` | ``PackedInt64Array()`` |
+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+
| :ref:`RID[]<class_RID>` | :ref:`path_rids<class_NavigationPathQueryResult2D_property_path_rids>` | ``[]`` |
+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`path_types<class_NavigationPathQueryResult2D_property_path_types>` | ``PackedInt32Array()`` |
+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+
.. rst-class:: classref-reftable-group
@@ -51,6 +57,37 @@ Methods
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_NavigationPathQueryResult2D_PathSegmentType:
.. rst-class:: classref-enumeration
enum **PathSegmentType**:
.. _class_NavigationPathQueryResult2D_constant_PATH_SEGMENT_TYPE_REGION:
.. rst-class:: classref-enumeration-constant
:ref:`PathSegmentType<enum_NavigationPathQueryResult2D_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<enum_NavigationPathQueryResult2D_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
---------------------
@@ -67,6 +104,57 @@ Property Descriptions
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>`.
.. rst-class:: classref-item-separator
----
.. _class_NavigationPathQueryResult2D_property_path_owner_ids:
.. rst-class:: classref-property
:ref:`PackedInt64Array<class_PackedInt64Array>` **path_owner_ids** = ``PackedInt64Array()``
.. rst-class:: classref-property-setget
- void **set_path_owner_ids** **(** :ref:`PackedInt64Array<class_PackedInt64Array>` value **)**
- :ref:`PackedInt64Array<class_PackedInt64Array>` **get_path_owner_ids** **(** **)**
The ``ObjectID``\ s of the :ref:`Object<class_Object>`\ s which manage the regions and links each point of the path goes through.
.. rst-class:: classref-item-separator
----
.. _class_NavigationPathQueryResult2D_property_path_rids:
.. rst-class:: classref-property
:ref:`RID[]<class_RID>` **path_rids** = ``[]``
.. rst-class:: classref-property-setget
- void **set_path_rids** **(** :ref:`RID[]<class_RID>` value **)**
- :ref:`RID[]<class_RID>` **get_path_rids** **(** **)**
The :ref:`RID<class_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<class_PackedInt32Array>` **path_types** = ``PackedInt32Array()``
.. rst-class:: classref-property-setget
- void **set_path_types** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_path_types** **(** **)**
The type of navigation primitive (region or link) that each point of the path goes through.
.. rst-class:: classref-section-separator
----