Files
godot-docs-l10n/classes/zh_Hant/class_navigationlink3d.rst

334 lines
16 KiB
ReStructuredText

:github_url: hide
.. _class_NavigationLink3D:
NavigationLink3D
================
**實驗性:** This class may be changed or removed in future versions.
**繼承:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
連接兩個位於 :ref:`NavigationRegion3D<class_NavigationRegion3D>` 上的位置的連結,導覽時能夠讓代理走這個鏈接。
.. rst-class:: classref-introduction-group
說明
----
連接兩個位於 :ref:`NavigationRegion3D<class_NavigationRegion3D>` 上的位置的連結,導覽時能夠讓代理走這個鏈接。這兩個位置可以在同一個 :ref:`NavigationRegion3D<class_NavigationRegion3D>` 上,也可以是在兩個不同的區塊上。連結可以用來表達沿著導覽網格表面行進以外的導覽方法,例如滑鎖、傳送、跳過溝壑等等。
.. rst-class:: classref-introduction-group
教學
----
- :doc:`使用 NavigationLink <../tutorials/navigation/navigation_using_navigationlinks>`
.. rst-class:: classref-reftable-group
屬性
----
.. table::
:widths: auto
+-------------------------------+-----------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>` | :ref:`bidirectional<class_NavigationLink3D_property_bidirectional>` | ``true`` |
+-------------------------------+-----------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>` | :ref:`enabled<class_NavigationLink3D_property_enabled>` | ``true`` |
+-------------------------------+-----------------------------------------------------------------------------+----------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`end_position<class_NavigationLink3D_property_end_position>` | ``Vector3(0, 0, 0)`` |
+-------------------------------+-----------------------------------------------------------------------------+----------------------+
| :ref:`float<class_float>` | :ref:`enter_cost<class_NavigationLink3D_property_enter_cost>` | ``0.0`` |
+-------------------------------+-----------------------------------------------------------------------------+----------------------+
| :ref:`int<class_int>` | :ref:`navigation_layers<class_NavigationLink3D_property_navigation_layers>` | ``1`` |
+-------------------------------+-----------------------------------------------------------------------------+----------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`start_position<class_NavigationLink3D_property_start_position>` | ``Vector3(0, 0, 0)`` |
+-------------------------------+-----------------------------------------------------------------------------+----------------------+
| :ref:`float<class_float>` | :ref:`travel_cost<class_NavigationLink3D_property_travel_cost>` | ``1.0`` |
+-------------------------------+-----------------------------------------------------------------------------+----------------------+
.. rst-class:: classref-reftable-group
方法
----
.. table::
:widths: auto
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_global_end_position<class_NavigationLink3D_method_get_global_end_position>`\ (\ ) |const| |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_global_start_position<class_NavigationLink3D_method_get_global_start_position>`\ (\ ) |const| |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_navigation_layer_value<class_NavigationLink3D_method_get_navigation_layer_value>`\ (\ layer_number\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`get_navigation_map<class_NavigationLink3D_method_get_navigation_map>`\ (\ ) |const| |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`get_rid<class_NavigationLink3D_method_get_rid>`\ (\ ) |const| |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_global_end_position<class_NavigationLink3D_method_set_global_end_position>`\ (\ position\: :ref:`Vector3<class_Vector3>`\ ) |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_global_start_position<class_NavigationLink3D_method_set_global_start_position>`\ (\ position\: :ref:`Vector3<class_Vector3>`\ ) |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_navigation_layer_value<class_NavigationLink3D_method_set_navigation_layer_value>`\ (\ layer_number\: :ref:`int<class_int>`, value\: :ref:`bool<class_bool>`\ ) |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_navigation_map<class_NavigationLink3D_method_set_navigation_map>`\ (\ navigation_map\: :ref:`RID<class_RID>`\ ) |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
屬性說明
--------
.. _class_NavigationLink3D_property_bidirectional:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **bidirectional** = ``true`` :ref:`🔗<class_NavigationLink3D_property_bidirectional>`
.. rst-class:: classref-property-setget
- |void| **set_bidirectional**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_bidirectional**\ (\ )
返回這個連接是可以雙向通行,還是只能從 :ref:`start_position<class_NavigationLink3D_property_start_position>` 通向 :ref:`end_position<class_NavigationLink3D_property_end_position>`\ 。
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_property_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **enabled** = ``true`` :ref:`🔗<class_NavigationLink3D_property_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_enabled**\ (\ )
該連結目前是否處於活動狀態。如果為 ``false`` ,則 :ref:`NavigationServer3D.map_get_path()<class_NavigationServer3D_method_map_get_path>` 會忽略這個連結。
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_property_end_position:
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **end_position** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_NavigationLink3D_property_end_position>`
.. rst-class:: classref-property-setget
- |void| **set_end_position**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- :ref:`Vector3<class_Vector3>` **get_end_position**\ (\ )
連結的結束位置。
連結會搜索導覽網格中最接近這個位置的多邊形,並將自身與該多邊形相關聯。
連結搜索的距離由 :ref:`NavigationServer3D.map_set_link_connection_radius()<class_NavigationServer3D_method_map_set_link_connection_radius>` 控制。
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_property_enter_cost:
.. rst-class:: classref-property
:ref:`float<class_float>` **enter_cost** = ``0.0`` :ref:`🔗<class_NavigationLink3D_property_enter_cost>`
.. rst-class:: classref-property-setget
- |void| **set_enter_cost**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_enter_cost**\ (\ )
當尋路從其他地區的導覽網格進入該連結時,\ :ref:`enter_cost<class_NavigationLink3D_property_enter_cost>` 會加到路徑距離中,用於確定最短路徑。
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_property_navigation_layers:
.. rst-class:: classref-property
:ref:`int<class_int>` **navigation_layers** = ``1`` :ref:`🔗<class_NavigationLink3D_property_navigation_layers>`
.. rst-class:: classref-property-setget
- |void| **set_navigation_layers**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_navigation_layers**\ (\ )
決定連結所屬導覽層的位元域。使用 :ref:`NavigationServer3D.map_get_path()<class_NavigationServer3D_method_map_get_path>` 請求路徑時會檢查這些導覽層。
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_property_start_position:
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **start_position** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_NavigationLink3D_property_start_position>`
.. rst-class:: classref-property-setget
- |void| **set_start_position**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- :ref:`Vector3<class_Vector3>` **get_start_position**\ (\ )
連結的起始位置。
連結會搜索導覽網格中最接近這個位置的多邊形,並將自身與該多邊形相關聯。
連結搜索的距離由 :ref:`NavigationServer3D.map_set_link_connection_radius()<class_NavigationServer3D_method_map_set_link_connection_radius>` 控制。
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_property_travel_cost:
.. rst-class:: classref-property
:ref:`float<class_float>` **travel_cost** = ``1.0`` :ref:`🔗<class_NavigationLink3D_property_travel_cost>`
.. rst-class:: classref-property-setget
- |void| **set_travel_cost**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_travel_cost**\ (\ )
當尋路沿著該連結移動時,移動距離會和 :ref:`travel_cost<class_NavigationLink3D_property_travel_cost>` 相乘,用於確定最短路徑。
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
方法說明
--------
.. _class_NavigationLink3D_method_get_global_end_position:
.. rst-class:: classref-method
:ref:`Vector3<class_Vector3>` **get_global_end_position**\ (\ ) |const| :ref:`🔗<class_NavigationLink3D_method_get_global_end_position>`
返回該連結的 :ref:`end_position<class_NavigationLink3D_property_end_position>` 的全域位置。
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_method_get_global_start_position:
.. rst-class:: classref-method
:ref:`Vector3<class_Vector3>` **get_global_start_position**\ (\ ) |const| :ref:`🔗<class_NavigationLink3D_method_get_global_start_position>`
返回該連結的 :ref:`start_position<class_NavigationLink3D_property_start_position>` 的全域位置。
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_method_get_navigation_layer_value:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_NavigationLink3D_method_get_navigation_layer_value>`
返回 :ref:`navigation_layers<class_NavigationLink3D_property_navigation_layers>` 位元遮罩中指定的層是否啟用,給定的 ``layer_number`` 應在 1 和 32 之間。
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_method_get_navigation_map:
.. rst-class:: classref-method
:ref:`RID<class_RID>` **get_navigation_map**\ (\ ) |const| :ref:`🔗<class_NavigationLink3D_method_get_navigation_map>`
Returns the current navigation map :ref:`RID<class_RID>` used by this link.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_method_get_rid:
.. rst-class:: classref-method
:ref:`RID<class_RID>` **get_rid**\ (\ ) |const| :ref:`🔗<class_NavigationLink3D_method_get_rid>`
Returns the :ref:`RID<class_RID>` of this link on the :ref:`NavigationServer3D<class_NavigationServer3D>`.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_method_set_global_end_position:
.. rst-class:: classref-method
|void| **set_global_end_position**\ (\ position\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_NavigationLink3D_method_set_global_end_position>`
設定該連結的 :ref:`end_position<class_NavigationLink3D_property_end_position>` 的全域位置。
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_method_set_global_start_position:
.. rst-class:: classref-method
|void| **set_global_start_position**\ (\ position\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_NavigationLink3D_method_set_global_start_position>`
設定該連結的 :ref:`start_position<class_NavigationLink3D_property_start_position>` 的全域位置。
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_method_set_navigation_layer_value:
.. rst-class:: classref-method
|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int<class_int>`, value\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_NavigationLink3D_method_set_navigation_layer_value>`
根據 ``value``\ ,啟用或禁用 :ref:`navigation_layers<class_NavigationLink3D_property_navigation_layers>` 位元遮罩中指定的層,給定的 ``layer_number`` 應在 1 和 32 之間。
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink3D_method_set_navigation_map:
.. rst-class:: classref-method
|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_NavigationLink3D_method_set_navigation_map>`
Sets the :ref:`RID<class_RID>` of the navigation map this link should use. By default the link will automatically join the :ref:`World3D<class_World3D>` default navigation map so this function is only required to override the default map.
.. |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 (無回傳值。)`