Files
godot-docs-l10n/classes/ru/class_navigationpathqueryresult3d.rst

213 lines
10 KiB
ReStructuredText
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. _class_NavigationPathQueryResult3D:
NavigationPathQueryResult3D
===========================
**Экспериментальное:** This class may be changed or removed in future versions.
**Наследует:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Представляет собой результат запроса на поиск трехмерного пути.
.. rst-class:: classref-introduction-group
Описание
----------------
Этот класс хранит результат запроса пути трехмерной навигации из :ref:`NavigationServer3D<class_NavigationServer3D>`.
.. rst-class:: classref-introduction-group
Обучающие материалы
--------------------------------------
- :doc:`Использовать NavigationPathQueryObjects <../tutorials/navigation/navigation_using_navigationpathqueryobjects>`
.. rst-class:: classref-reftable-group
Свойства
----------------
.. table::
:widths: auto
+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`path<class_NavigationPathQueryResult3D_property_path>` | ``PackedVector3Array()`` |
+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+
| :ref:`float<class_float>` | :ref:`path_length<class_NavigationPathQueryResult3D_property_path_length>` | ``0.0`` |
+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+
| :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`path_owner_ids<class_NavigationPathQueryResult3D_property_path_owner_ids>` | ``PackedInt64Array()`` |
+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+
| :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] | :ref:`path_rids<class_NavigationPathQueryResult3D_property_path_rids>` | ``[]`` |
+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`path_types<class_NavigationPathQueryResult3D_property_path_types>` | ``PackedInt32Array()`` |
+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+
.. rst-class:: classref-reftable-group
Методы
------------
.. table::
:widths: auto
+--------+--------------------------------------------------------------------+
| |void| | :ref:`reset<class_NavigationPathQueryResult3D_method_reset>`\ (\ ) |
+--------+--------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Перечисления
------------------------
.. _enum_NavigationPathQueryResult3D_PathSegmentType:
.. rst-class:: classref-enumeration
enum **PathSegmentType**: :ref:`🔗<enum_NavigationPathQueryResult3D_PathSegmentType>`
.. _class_NavigationPathQueryResult3D_constant_PATH_SEGMENT_TYPE_REGION:
.. rst-class:: classref-enumeration-constant
:ref:`PathSegmentType<enum_NavigationPathQueryResult3D_PathSegmentType>` **PATH_SEGMENT_TYPE_REGION** = ``0``
Этот участок пути проходит через регион.
.. _class_NavigationPathQueryResult3D_constant_PATH_SEGMENT_TYPE_LINK:
.. rst-class:: classref-enumeration-constant
:ref:`PathSegmentType<enum_NavigationPathQueryResult3D_PathSegmentType>` **PATH_SEGMENT_TYPE_LINK** = ``1``
Этот участок пути проходит через ссылку.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Описания свойств
--------------------------------
.. _class_NavigationPathQueryResult3D_property_path:
.. rst-class:: classref-property
:ref:`PackedVector3Array<class_PackedVector3Array>` **path** = ``PackedVector3Array()`` :ref:`🔗<class_NavigationPathQueryResult3D_property_path>`
.. rst-class:: classref-property-setget
- |void| **set_path**\ (\ value\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ )
- :ref:`PackedVector3Array<class_PackedVector3Array>` **get_path**\ (\ )
Результирующий массив путей из навигационного запроса. Все позиции массива путей находятся в глобальных координатах. Без настраиваемых параметров запроса это тот же путь, который возвращается :ref:`NavigationServer3D.map_get_path()<class_NavigationServer3D_method_map_get_path>`.
**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector3Array<class_PackedVector3Array>` for more details.
.. rst-class:: classref-item-separator
----
.. _class_NavigationPathQueryResult3D_property_path_length:
.. rst-class:: classref-property
:ref:`float<class_float>` **path_length** = ``0.0`` :ref:`🔗<class_NavigationPathQueryResult3D_property_path_length>`
.. rst-class:: classref-property-setget
- |void| **set_path_length**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_path_length**\ (\ )
Возвращает длину пути.
.. rst-class:: classref-item-separator
----
.. _class_NavigationPathQueryResult3D_property_path_owner_ids:
.. rst-class:: classref-property
:ref:`PackedInt64Array<class_PackedInt64Array>` **path_owner_ids** = ``PackedInt64Array()`` :ref:`🔗<class_NavigationPathQueryResult3D_property_path_owner_ids>`
.. rst-class:: classref-property-setget
- |void| **set_path_owner_ids**\ (\ value\: :ref:`PackedInt64Array<class_PackedInt64Array>`\ )
- :ref:`PackedInt64Array<class_PackedInt64Array>` **get_path_owner_ids**\ (\ )
``ObjectID`` :ref:`Object<class_Object>`, которые управляют регионами и связями, через которые проходит каждая точка пути.
**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt64Array<class_PackedInt64Array>` for more details.
.. rst-class:: classref-item-separator
----
.. _class_NavigationPathQueryResult3D_property_path_rids:
.. rst-class:: classref-property
:ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] **path_rids** = ``[]`` :ref:`🔗<class_NavigationPathQueryResult3D_property_path_rids>`
.. rst-class:: classref-property-setget
- |void| **set_path_rids**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\]\ )
- :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] **get_path_rids**\ (\ )
:ref:`RID<class_RID>` регионов и связей, через которые проходит каждая точка пути.
.. rst-class:: classref-item-separator
----
.. _class_NavigationPathQueryResult3D_property_path_types:
.. rst-class:: classref-property
:ref:`PackedInt32Array<class_PackedInt32Array>` **path_types** = ``PackedInt32Array()`` :ref:`🔗<class_NavigationPathQueryResult3D_property_path_types>`
.. rst-class:: classref-property-setget
- |void| **set_path_types**\ (\ value\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ )
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_path_types**\ (\ )
Тип навигационного примитива (регион или ссылка), через который проходит каждая точка пути.
**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array<class_PackedInt32Array>` for more details.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Описания метода
------------------------------
.. _class_NavigationPathQueryResult3D_method_reset:
.. rst-class:: classref-method
|void| **reset**\ (\ ) :ref:`🔗<class_NavigationPathQueryResult3D_method_reset>`
Сбросить объект результата в исходное состояние. Это полезно для повторного использования объекта в нескольких запросах.
.. |virtual| replace:: :abbr:`virtual (Этот метод обычно должен быть переопределен пользователем, чтобы иметь какой-либо эффект.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Этот метод не имеет побочных эффектов. Он не изменяет ни одну из переменных-членов экземпляра.)`
.. |vararg| replace:: :abbr:`vararg (Этот метод принимает любое количество аргументов после описанных здесь.)`
.. |constructor| replace:: :abbr:`constructor (Этот метод используется для создания типа.)`
.. |static| replace:: :abbr:`static (Этот метод не нуждается в вызове экземпляра, поэтому его можно вызвать напрямую, используя имя класса.)`
.. |operator| replace:: :abbr:`operator (Этот метод описывает допустимый оператор для использования с этим типом в качестве левого операнда.)`
.. |bitfield| replace:: :abbr:`BitField (Это значение является целым числом, составленным как битовая маска следующих флагов.)`
.. |void| replace:: :abbr:`void (Нет возвращаемого значения.)`