godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (e0de3573f)

Browse Source
This commit is contained in:
Rémi Verschelde
2023-02-23 14:11:39 +01:00
parent 3f73172085
commit 1dc22280b6
54 changed files with 464 additions and 405 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
classes/class_navigationlink2d.rst
View File

@@ -19,7 +19,7 @@ Creates a link between two positions that :ref:`NavigationServer2D<class_Navigat
Description
-----------
Creates a link between two positions that :ref:`NavigationServer2D<class_NavigationServer2D>` can route agents through. Links can be used to express navigation methods that aren't just traveling along the surface of the navigation mesh, like zip-lines, teleporters, or jumping across gaps.
Creates a link between two positions that :ref:`NavigationServer2D<class_NavigationServer2D>` can route agents through. Links can be used to express navigation methods that aren't just traveling along the surface of the navigation mesh, like zip-lines, teleporters, or jumping across gaps.
.. rst-class:: classref-introduction-group
@@ -60,11 +60,19 @@ Methods
.. table::
:widths: auto
+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_navigation_layer_value<class_NavigationLink2D_method_get_navigation_layer_value>` **(** :ref:`int<class_int>` layer_number **)** |const| |
+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_navigation_layer_value<class_NavigationLink2D_method_set_navigation_layer_value>` **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)** |
+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_global_end_position<class_NavigationLink2D_method_get_global_end_position>` **(** **)** |const| |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_global_start_position<class_NavigationLink2D_method_get_global_start_position>` **(** **)** |const| |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_navigation_layer_value<class_NavigationLink2D_method_get_navigation_layer_value>` **(** :ref:`int<class_int>` layer_number **)** |const| |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_global_end_position<class_NavigationLink2D_method_set_global_end_position>` **(** :ref:`Vector2<class_Vector2>` position **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_global_start_position<class_NavigationLink2D_method_set_global_start_position>` **(** :ref:`Vector2<class_Vector2>` position **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_navigation_layer_value<class_NavigationLink2D_method_set_navigation_layer_value>` **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@@ -207,6 +215,30 @@ When pathfinding moves along the link the traveled distance is multiplied with `
Method Descriptions
-------------------
.. _class_NavigationLink2D_method_get_global_end_position:
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` **get_global_end_position** **(** **)** |const|
Returns the :ref:`end_position<class_NavigationLink2D_property_end_position>` that is relative to the link as a global position.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_method_get_global_start_position:
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` **get_global_start_position** **(** **)** |const|
Returns the :ref:`start_position<class_NavigationLink2D_property_start_position>` that is relative to the link as a global position.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_method_get_navigation_layer_value:
.. rst-class:: classref-method
@@ -219,6 +251,30 @@ Returns whether or not the specified layer of the :ref:`navigation_layers<class_
----
.. _class_NavigationLink2D_method_set_global_end_position:
.. rst-class:: classref-method
void **set_global_end_position** **(** :ref:`Vector2<class_Vector2>` position **)**
Sets the :ref:`end_position<class_NavigationLink2D_property_end_position>` that is relative to the link from a global ``position``.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_method_set_global_start_position:
.. rst-class:: classref-method
void **set_global_start_position** **(** :ref:`Vector2<class_Vector2>` position **)**
Sets the :ref:`start_position<class_NavigationLink2D_property_start_position>` that is relative to the link from a global ``position``.
.. rst-class:: classref-item-separator
----
.. _class_NavigationLink2D_method_set_navigation_layer_value:
.. rst-class:: classref-method