Browse Source

Merge pull request #7447 from smix8/navlink_location_4.x

Fix NavigationLink doc using old property names
Max Hilbrunner 2 years ago
parent
commit
f5cc90c19c
1 changed files with 7 additions and 7 deletions
  1. 7 7
      tutorials/navigation/navigation_using_navigationlinks.rst

+ 7 - 7
tutorials/navigation/navigation_using_navigationlinks.rst

@@ -5,7 +5,7 @@ Using NavigationLinks
 
 
 .. image:: img/nav_navmesh_links.png
 .. image:: img/nav_navmesh_links.png
 
 
-NavigationLinks are used to connect navmesh polygons from :ref:`NavigationRegion2D<class_NavigationRegion2D>` 
+NavigationLinks are used to connect navigation mesh polygons from :ref:`NavigationRegion2D<class_NavigationRegion2D>` 
 and :ref:`NavigationRegion3D<class_NavigationRegion3D>` over arbitrary distances for pathfinding.
 and :ref:`NavigationRegion3D<class_NavigationRegion3D>` over arbitrary distances for pathfinding.
 
 
 NavigationLinks are also used to consider movement shortcuts in pathfinding available through 
 NavigationLinks are also used to consider movement shortcuts in pathfinding available through 
@@ -15,7 +15,7 @@ interacting with gameplay objects e.g. ladders, jump pads or teleports.
 :ref:`NavigationLink2D<class_NavigationLink2D>` and 
 :ref:`NavigationLink2D<class_NavigationLink2D>` and 
 :ref:`NavigationLink3D<class_NavigationLink3D>` respectively.
 :ref:`NavigationLink3D<class_NavigationLink3D>` respectively.
 
 
-Different NavigationRegions can connect their navmeshes without the need for a NavigationLink 
+Different NavigationRegions can connect their navigation meshes without the need for a NavigationLink 
 as long as they are within navigation map ``edge_connection_margin`` and have compatible ``navigation_layers``.
 as long as they are within navigation map ``edge_connection_margin`` and have compatible ``navigation_layers``.
 As soon as the distance becomes too large, building valid connections becomes a problem - a problem that NavigationLinks can solve.
 As soon as the distance becomes too large, building valid connections becomes a problem - a problem that NavigationLinks can solve.
 
 
@@ -26,17 +26,17 @@ See :ref:`doc_navigation_connecting_navmesh` to learn more about how to connect
 
 
 NavigationLinks share many properties with NavigationRegions like ``navigation_layers``.
 NavigationLinks share many properties with NavigationRegions like ``navigation_layers``.
 NavigationLinks add a single connection between two positions over an arbitrary distance 
 NavigationLinks add a single connection between two positions over an arbitrary distance 
-compared to NavigationRegions that add a more local traversable area with a navmesh resource.
+compared to NavigationRegions that add a more local traversable area with a navigation mesh resource.
 
 
-NavigationLinks have a ``start_location`` and ``end_location`` and can go in both directions when ``bidirectional`` is enabled.
-When placed a navigationlink connects the navmesh polygons closest to its ``start_location`` and ``end_location`` within search radius for pathfinding.
+NavigationLinks have a ``start_position`` and ``end_position`` and can go in both directions when ``bidirectional`` is enabled.
+When placed a navigationlink connects the navigation mesh polygons closest to its ``start_position`` and ``end_position`` within search radius for pathfinding.
 
 
 The polygon search radius can be configured globally in the ProjectSettings under ``navigation/2d_or_3d/default_link_connection_radius`` 
 The polygon search radius can be configured globally in the ProjectSettings under ``navigation/2d_or_3d/default_link_connection_radius`` 
 or set for each navigation ``map`` individually using the ``NavigationServer.map_set_link_connection_radius()`` function.
 or set for each navigation ``map`` individually using the ``NavigationServer.map_set_link_connection_radius()`` function.
 
 
-Both ``start_location`` and ``end_location`` have debug markers in the Editor.
+Both ``start_position`` and ``end_position`` have debug markers in the Editor.
 The visible radius of a position shows the polygon search radius. 
 The visible radius of a position shows the polygon search radius. 
-All navmesh polygons inside are compared and the closest is picked for the edge connection.
+All navigation mesh polygons inside are compared and the closest is picked for the edge connection.
 If no valid polygon is found within the search radius the navigation link gets disabled.
 If no valid polygon is found within the search radius the navigation link gets disabled.
 
 
 .. image:: img/nav_link_debug_visuals.png
 .. image:: img/nav_link_debug_visuals.png