noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Add navigation path query parameter limits

Browse Source 
Adds navigation path query parameter limits.
This commit is contained in:
smix8
2025-02-08 22:08:04 +01:00
parent 591e70ff78
commit cbd446ac29
23 changed files with 698 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/NavigationAgent3D.xml
+19
View File
@@ -75,6 +75,12 @@
Returns the next position in global coordinates that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. The use of this function once every physics frame is required to update the internal path logic of the NavigationAgent.
</description>
</method>
<method name="get_path_length" qualifiers="const">
<return type="float" />
<description>
Returns the length of the currently calculated path. The returned value is [code]0.0[/code], if the path is still calculating or no calculation has been requested yet.
</description>
</method>
<method name="get_rid" qualifiers="const">
<return type="RID" />
<description>
@@ -197,6 +203,19 @@
<member name="path_postprocessing" type="int" setter="set_path_postprocessing" getter="get_path_postprocessing" enum="NavigationPathQueryParameters3D.PathPostProcessing" default="0">
The path postprocessing applied to the raw path corridor found by the [member pathfinding_algorithm].
</member>
<member name="path_return_max_length" type="float" setter="set_path_return_max_length" getter="get_path_return_max_length" default="0.0">
The maximum allowed length of the returned path in world units. A path will be clipped when going over this length.
</member>
<member name="path_return_max_radius" type="float" setter="set_path_return_max_radius" getter="get_path_return_max_radius" default="0.0">
The maximum allowed radius in world units that the returned path can be from the path start. The path will be clipped when going over this radius. Compared to [member path_return_max_length], this allows the agent to go that much further, if they need to walk around a corner.
[b]Note:[/b] This will perform a sphere clip considering only the actual navigation mesh path points with the first path position being the sphere's center.
</member>
<member name="path_search_max_distance" type="float" setter="set_path_search_max_distance" getter="get_path_search_max_distance" default="0.0">
The maximum distance a searched polygon can be away from the start polygon before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of [code]0[/code] or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted.
</member>
<member name="path_search_max_polygons" type="int" setter="set_path_search_max_polygons" getter="get_path_search_max_polygons" default="4096">
The maximum number of polygons that are searched before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of [code]0[/code] or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted.
</member>
<member name="pathfinding_algorithm" type="int" setter="set_pathfinding_algorithm" getter="get_pathfinding_algorithm" enum="NavigationPathQueryParameters3D.PathfindingAlgorithm" default="0">
The pathfinding algorithm used in the path query.
</member>