summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-05-01 14:17:40 +0200
committerGitHub <noreply@github.com>2022-05-01 14:17:40 +0200
commit4e06ce7840be00403f28fcd4bb031780cbaffe86 (patch)
tree6e7d612b91bcf9876161661ebe38f358189edd80 /doc
parent951f1a707bb11ed2abc3c3202d10ab4858d18a16 (diff)
parent05d06b89579a2f39677dcaf7c94432e4c550dea5 (diff)
Merge pull request #60655 from smix8/navigation_region_rid_4.x
Add get_region_rid() to NavigationRegion2D and NavigationRegion3D
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/NavigationRegion2D.xml8
-rw-r--r--doc/classes/NavigationRegion3D.xml6
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/classes/NavigationRegion2D.xml b/doc/classes/NavigationRegion2D.xml
index b1165174a2..5cd2e035b6 100644
--- a/doc/classes/NavigationRegion2D.xml
+++ b/doc/classes/NavigationRegion2D.xml
@@ -10,6 +10,14 @@
</description>
<tutorials>
</tutorials>
+ <methods>
+ <method name="get_region_rid" qualifiers="const">
+ <return type="RID" />
+ <description>
+ Returns the [RID] of this region on the [NavigationServer2D]. Combined with [method NavigationServer2D.map_get_closest_point_owner] can be used to identify the [NavigationRegion2D] closest to a point on the merged navigation map.
+ </description>
+ </method>
+ </methods>
<members>
<member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" default="true">
Determines if the [NavigationRegion2D] is enabled or disabled.
diff --git a/doc/classes/NavigationRegion3D.xml b/doc/classes/NavigationRegion3D.xml
index e007633a1e..b27410ed74 100644
--- a/doc/classes/NavigationRegion3D.xml
+++ b/doc/classes/NavigationRegion3D.xml
@@ -16,6 +16,12 @@
Bakes the [NavigationMesh]. The baking is done in a separate thread because navigation baking is not a cheap operation. This can be done at runtime. When it is completed, it automatically sets the new [NavigationMesh].
</description>
</method>
+ <method name="get_region_rid" qualifiers="const">
+ <return type="RID" />
+ <description>
+ Returns the [RID] of this region on the [NavigationServer3D]. Combined with [method NavigationServer3D.map_get_closest_point_owner] can be used to identify the [NavigationRegion3D] closest to a point on the merged navigation map.
+ </description>
+ </method>
</methods>
<members>
<member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" default="true">