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 (705b7a0)

Browse Source
This commit is contained in:
Godot Organization
2024-05-31 13:54:35 +00:00
parent 32f1b6ea48
commit eacfba2716
835 changed files with 17350 additions and 17256 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
classes/class_navigationobstacle2d.rst
View File

@@ -91,7 +91,7 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`bool<class_bool>` **affect_navigation_mesh** = ``false``
:ref:`bool<class_bool>` **affect_navigation_mesh** = ``false`` :ref:`🔗<class_NavigationObstacle2D_property_affect_navigation_mesh>`
.. rst-class:: classref-property-setget
@@ -108,7 +108,7 @@ If enabled and parsed in a navigation mesh baking process the obstacle will disc
.. rst-class:: classref-property
:ref:`bool<class_bool>` **avoidance_enabled** = ``true``
:ref:`bool<class_bool>` **avoidance_enabled** = ``true`` :ref:`🔗<class_NavigationObstacle2D_property_avoidance_enabled>`
.. rst-class:: classref-property-setget
@@ -125,7 +125,7 @@ If ``true`` the obstacle affects avoidance using agents.
.. rst-class:: classref-property
:ref:`int<class_int>` **avoidance_layers** = ``1``
:ref:`int<class_int>` **avoidance_layers** = ``1`` :ref:`🔗<class_NavigationObstacle2D_property_avoidance_layers>`
.. rst-class:: classref-property-setget
@@ -142,7 +142,7 @@ A bitfield determining the avoidance layers for this obstacle. Agents with a mat
.. rst-class:: classref-property
:ref:`bool<class_bool>` **carve_navigation_mesh** = ``false``
:ref:`bool<class_bool>` **carve_navigation_mesh** = ``false`` :ref:`🔗<class_NavigationObstacle2D_property_carve_navigation_mesh>`
.. rst-class:: classref-property-setget
@@ -163,7 +163,7 @@ Requires :ref:`affect_navigation_mesh<class_NavigationObstacle2D_property_affect
.. rst-class:: classref-property
:ref:`float<class_float>` **radius** = ``0.0``
:ref:`float<class_float>` **radius** = ``0.0`` :ref:`🔗<class_NavigationObstacle2D_property_radius>`
.. rst-class:: classref-property-setget
@@ -180,7 +180,7 @@ Sets the avoidance radius for the obstacle.
.. rst-class:: classref-property
:ref:`Vector2<class_Vector2>` **velocity** = ``Vector2(0, 0)``
:ref:`Vector2<class_Vector2>` **velocity** = ``Vector2(0, 0)`` :ref:`🔗<class_NavigationObstacle2D_property_velocity>`
.. rst-class:: classref-property-setget
@@ -197,7 +197,7 @@ Sets the wanted velocity for the obstacle so other agent's can better predict th
.. rst-class:: classref-property
:ref:`PackedVector2Array<class_PackedVector2Array>` **vertices** = ``PackedVector2Array()``
:ref:`PackedVector2Array<class_PackedVector2Array>` **vertices** = ``PackedVector2Array()`` :ref:`🔗<class_NavigationObstacle2D_property_vertices>`
.. rst-class:: classref-property-setget
@@ -221,7 +221,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`bool<class_bool>` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int<class_int>`\ ) |const|
:ref:`bool<class_bool>` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_NavigationObstacle2D_method_get_avoidance_layer_value>`
Returns whether or not the specified layer of the :ref:`avoidance_layers<class_NavigationObstacle2D_property_avoidance_layers>` bitmask is enabled, given a ``layer_number`` between 1 and 32.
@@ -233,7 +233,7 @@ Returns whether or not the specified layer of the :ref:`avoidance_layers<class_N
.. rst-class:: classref-method
:ref:`RID<class_RID>` **get_navigation_map**\ (\ ) |const|
:ref:`RID<class_RID>` **get_navigation_map**\ (\ ) |const| :ref:`🔗<class_NavigationObstacle2D_method_get_navigation_map>`
Returns the :ref:`RID<class_RID>` of the navigation map for this NavigationObstacle node. This function returns always the map set on the NavigationObstacle node and not the map of the abstract obstacle on the NavigationServer. If the obstacle map is changed directly with the NavigationServer API the NavigationObstacle node will not be aware of the map change. Use :ref:`set_navigation_map<class_NavigationObstacle2D_method_set_navigation_map>` to change the navigation map for the NavigationObstacle and also update the obstacle on the NavigationServer.
@@ -245,7 +245,7 @@ Returns the :ref:`RID<class_RID>` of the navigation map for this NavigationObsta
.. rst-class:: classref-method
:ref:`RID<class_RID>` **get_rid**\ (\ ) |const|
:ref:`RID<class_RID>` **get_rid**\ (\ ) |const| :ref:`🔗<class_NavigationObstacle2D_method_get_rid>`
Returns the :ref:`RID<class_RID>` of this obstacle on the :ref:`NavigationServer2D<class_NavigationServer2D>`.
@@ -257,7 +257,7 @@ Returns the :ref:`RID<class_RID>` of this obstacle on the :ref:`NavigationServer
.. rst-class:: classref-method
|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int<class_int>`, value\: :ref:`bool<class_bool>`\ )
|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int<class_int>`, value\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_NavigationObstacle2D_method_set_avoidance_layer_value>`
Based on ``value``, enables or disables the specified layer in the :ref:`avoidance_layers<class_NavigationObstacle2D_property_avoidance_layers>` bitmask, given a ``layer_number`` between 1 and 32.
@@ -269,7 +269,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`avoidan
.. rst-class:: classref-method
|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID<class_RID>`\ )
|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_NavigationObstacle2D_method_set_navigation_map>`
Sets the :ref:`RID<class_RID>` of the navigation map this NavigationObstacle node should use and also updates the ``obstacle`` on the NavigationServer.