From 7506ecc5d96b6a894be05acca61593da73cccb81 Mon Sep 17 00:00:00 2001 From: smix8 <52464204+smix8@users.noreply.github.com> Date: Wed, 11 Jan 2023 06:05:04 +0100 Subject: [PATCH] Add navigation tutorial links inside class doc Adds navigation tutorial links inside the class doc to the related and more detailed godot-docs pages. --- doc/classes/NavigationAgent2D.xml | 1 + doc/classes/NavigationAgent3D.xml | 1 + doc/classes/NavigationLink2D.xml | 1 + doc/classes/NavigationLink3D.xml | 1 + doc/classes/NavigationMesh.xml | 1 + doc/classes/NavigationMeshGenerator.xml | 1 + doc/classes/NavigationObstacle2D.xml | 1 + doc/classes/NavigationObstacle3D.xml | 1 + doc/classes/NavigationPathQueryParameters2D.xml | 1 + doc/classes/NavigationPathQueryParameters3D.xml | 1 + doc/classes/NavigationPathQueryResult2D.xml | 1 + doc/classes/NavigationPathQueryResult3D.xml | 1 + doc/classes/NavigationPolygon.xml | 1 + doc/classes/NavigationRegion2D.xml | 1 + doc/classes/NavigationRegion3D.xml | 1 + doc/classes/NavigationServer2D.xml | 1 + doc/classes/NavigationServer3D.xml | 1 + 17 files changed, 17 insertions(+) diff --git a/doc/classes/NavigationAgent2D.xml b/doc/classes/NavigationAgent2D.xml index 31d347d76c4..1607060ac2f 100644 --- a/doc/classes/NavigationAgent2D.xml +++ b/doc/classes/NavigationAgent2D.xml @@ -8,6 +8,7 @@ [b]Note:[/b] After setting [member target_location] it is required to use the [method get_next_location] function once every physics frame to update the internal path logic of the NavigationAgent. The returned vector position from this function should be used as the next movement position for the agent's parent Node. + $DOCS_URL/tutorials/navigation/navigation_using_navigationagents.html diff --git a/doc/classes/NavigationAgent3D.xml b/doc/classes/NavigationAgent3D.xml index c3f4809b5e4..a1b007ee566 100644 --- a/doc/classes/NavigationAgent3D.xml +++ b/doc/classes/NavigationAgent3D.xml @@ -8,6 +8,7 @@ [b]Note:[/b] After setting [member target_location] it is required to use the [method get_next_location] function once every physics frame to update the internal path logic of the NavigationAgent. The returned vector position from this function should be used as the next movement position for the agent's parent Node. + $DOCS_URL/tutorials/navigation/navigation_using_navigationagents.html diff --git a/doc/classes/NavigationLink2D.xml b/doc/classes/NavigationLink2D.xml index 9d756943602..44d2110a7c3 100644 --- a/doc/classes/NavigationLink2D.xml +++ b/doc/classes/NavigationLink2D.xml @@ -7,6 +7,7 @@ Creates a link between two locations that [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. + $DOCS_URL/tutorials/navigation/navigation_using_navigationlinks.html diff --git a/doc/classes/NavigationLink3D.xml b/doc/classes/NavigationLink3D.xml index 730c43c5a86..4aa5801afbc 100644 --- a/doc/classes/NavigationLink3D.xml +++ b/doc/classes/NavigationLink3D.xml @@ -7,6 +7,7 @@ Creates a link between two locations that [NavigationServer3D] 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. + $DOCS_URL/tutorials/navigation/navigation_using_navigationlinks.html diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index ff898551d41..85af44a13ec 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -8,6 +8,7 @@ https://godotengine.org/asset-library/asset/124 + $DOCS_URL/tutorials/navigation/navigation_using_navigationmeshes.html diff --git a/doc/classes/NavigationMeshGenerator.xml b/doc/classes/NavigationMeshGenerator.xml index 15d149a2293..0d4c083eb0b 100644 --- a/doc/classes/NavigationMeshGenerator.xml +++ b/doc/classes/NavigationMeshGenerator.xml @@ -11,6 +11,7 @@ [b]Note:[/b] Using meshes to not only define walkable surfaces but also obstruct navigation baking does not always work. The navigation baking has no concept of what is a geometry "inside" when dealing with mesh source geometry and this is intentional. Depending on current baking parameters, as soon as the obstructing mesh is large enough to fit a navigation mesh area inside, the baking will generate navigation mesh areas that are inside the obstructing source geometry mesh. + $DOCS_URL/tutorials/navigation/navigation_using_navigationmeshes.html diff --git a/doc/classes/NavigationObstacle2D.xml b/doc/classes/NavigationObstacle2D.xml index ce0f05ad28e..7d391bfa99b 100644 --- a/doc/classes/NavigationObstacle2D.xml +++ b/doc/classes/NavigationObstacle2D.xml @@ -8,6 +8,7 @@ Obstacles [b]don't[/b] change the resulting path from the pathfinding, they only affect the navigation agent movement in a radius. Therefore, using obstacles for the static walls in your level won't work because those walls don't exist in the pathfinding. The navigation agent will be pushed in a semi-random direction away while moving inside that radius. Obstacles are intended as a last resort option for constantly moving objects that cannot be (re)baked to a navigation mesh efficiently. + $DOCS_URL/tutorials/navigation/navigation_using_navigationobstacles.html diff --git a/doc/classes/NavigationObstacle3D.xml b/doc/classes/NavigationObstacle3D.xml index 78bbb788d9d..ce24d2bb0e6 100644 --- a/doc/classes/NavigationObstacle3D.xml +++ b/doc/classes/NavigationObstacle3D.xml @@ -8,6 +8,7 @@ Obstacles [b]don't[/b] change the resulting path from the pathfinding, they only affect the navigation agent movement in a radius. Therefore, using obstacles for the static walls in your level won't work because those walls don't exist in the pathfinding. The navigation agent will be pushed in a semi-random direction away while moving inside that radius. Obstacles are intended as a last resort option for constantly moving objects that cannot be (re)baked to a navigation mesh efficiently. + $DOCS_URL/tutorials/navigation/navigation_using_navigationobstacles.html diff --git a/doc/classes/NavigationPathQueryParameters2D.xml b/doc/classes/NavigationPathQueryParameters2D.xml index 511b2e7a8cd..05d7e9f9184 100644 --- a/doc/classes/NavigationPathQueryParameters2D.xml +++ b/doc/classes/NavigationPathQueryParameters2D.xml @@ -7,6 +7,7 @@ This class contains the start and target position and other parameters to be used with [method NavigationServer2D.query_path]. + $DOCS_URL/tutorials/navigation/navigation_using_navigationpathqueryobjects.html diff --git a/doc/classes/NavigationPathQueryParameters3D.xml b/doc/classes/NavigationPathQueryParameters3D.xml index b5031f60f23..690d74ab700 100644 --- a/doc/classes/NavigationPathQueryParameters3D.xml +++ b/doc/classes/NavigationPathQueryParameters3D.xml @@ -7,6 +7,7 @@ This class contains the start and target position and other parameters to be used with [method NavigationServer3D.query_path]. + $DOCS_URL/tutorials/navigation/navigation_using_navigationpathqueryobjects.html diff --git a/doc/classes/NavigationPathQueryResult2D.xml b/doc/classes/NavigationPathQueryResult2D.xml index 75f7cc47aaf..7bc588619dc 100644 --- a/doc/classes/NavigationPathQueryResult2D.xml +++ b/doc/classes/NavigationPathQueryResult2D.xml @@ -7,6 +7,7 @@ This class contains the result of a navigation path query from [method NavigationServer2D.query_path]. + $DOCS_URL/tutorials/navigation/navigation_using_navigationpathqueryobjects.html diff --git a/doc/classes/NavigationPathQueryResult3D.xml b/doc/classes/NavigationPathQueryResult3D.xml index 03d41cb2302..118a597b6c8 100644 --- a/doc/classes/NavigationPathQueryResult3D.xml +++ b/doc/classes/NavigationPathQueryResult3D.xml @@ -7,6 +7,7 @@ This class contains the result of a navigation path query from [method NavigationServer3D.query_path]. + $DOCS_URL/tutorials/navigation/navigation_using_navigationpathqueryobjects.html diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index b30dd2703a5..c223f88d6d3 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -44,6 +44,7 @@ https://godotengine.org/asset-library/asset/117 + $DOCS_URL/tutorials/navigation/navigation_using_navigationmeshes.html diff --git a/doc/classes/NavigationRegion2D.xml b/doc/classes/NavigationRegion2D.xml index 8b8793b3b4f..5d0fe9dae4e 100644 --- a/doc/classes/NavigationRegion2D.xml +++ b/doc/classes/NavigationRegion2D.xml @@ -13,6 +13,7 @@ [b]Note:[/b] This node caches changes to its properties, so if you make changes to the underlying region [RID] in [NavigationServer2D], they will not be reflected in this node's properties. + $DOCS_URL/tutorials/navigation/navigation_using_navigationregions.html diff --git a/doc/classes/NavigationRegion3D.xml b/doc/classes/NavigationRegion3D.xml index 10662db8691..c3e554e7d6d 100644 --- a/doc/classes/NavigationRegion3D.xml +++ b/doc/classes/NavigationRegion3D.xml @@ -13,6 +13,7 @@ [b]Note:[/b] This node caches changes to its properties, so if you make changes to the underlying region [RID] in [NavigationServer3D], they will not be reflected in this node's properties. + $DOCS_URL/tutorials/navigation/navigation_using_navigationregions.html diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml index b704f39c922..1ba949b2948 100644 --- a/doc/classes/NavigationServer2D.xml +++ b/doc/classes/NavigationServer2D.xml @@ -15,6 +15,7 @@ https://godotengine.org/asset-library/asset/117 + $DOCS_URL/tutorials/navigation/navigation_using_navigationservers.html diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index c38f6e0c042..6fed3f40e57 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -15,6 +15,7 @@ https://godotengine.org/asset-library/asset/124 + $DOCS_URL/tutorials/navigation/navigation_using_navigationservers.html