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

Add path query region filters

Browse Source 
Adds filter lists to exclude or include specific regions in path queries.
This commit is contained in:
smix8
2025-01-26 22:35:23 +01:00
parent c2732ae4b6
commit 9dfeabc92a
13 changed files with 235 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/classes/NavigationPathQueryParameters3D.xml
View File

@@ -10,6 +10,14 @@
<link title="Using NavigationPathQueryObjects">$DOCS_URL/tutorials/navigation/navigation_using_navigationpathqueryobjects.html</link>
</tutorials>
<members>
<member name="excluded_regions" type="RID[]" setter="set_excluded_regions" getter="get_excluded_regions" default="[]">
The list of region [RID]s that will be excluded from the path query. Use [method NavigationRegion3D.get_rid] to get the [RID] associated with a [NavigationRegion3D] node.
[b]Note:[/b] The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then set it to the property again.
</member>
<member name="included_regions" type="RID[]" setter="set_included_regions" getter="get_included_regions" default="[]">
The list of region [RID]s that will be included by the path query. Use [method NavigationRegion3D.get_rid] to get the [RID] associated with a [NavigationRegion3D] node. If left empty all regions are included. If a region ends up being both included and excluded at the same time it will be excluded.
[b]Note:[/b] The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then set it to the property again.
</member>
<member name="map" type="RID" setter="set_map" getter="get_map" default="RID()">
The navigation map [RID] used in the path query.
</member>