summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorsmix8 <52464204+smix8@users.noreply.github.com>2022-05-14 23:33:09 +0200
committersmix8 <52464204+smix8@users.noreply.github.com>2022-05-15 01:03:22 +0200
commit001d89223f1377717d2b3d5ec453ff8dd3604182 (patch)
treed1a75c203bdfadecd1e31411eb8cdbd7e17273f4 /doc/classes
parent0841f72c380a285802f52f6f28240345c97a80d7 (diff)
Expose NavigationObstacle2D/3D get_rid() and add config warning
Exposes get_rid() function for scripting. Adds configuration warning when obstacle is used with not intended static body parent.
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/NavigationObstacle2D.xml8
-rw-r--r--doc/classes/NavigationObstacle3D.xml8
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/classes/NavigationObstacle2D.xml b/doc/classes/NavigationObstacle2D.xml
index 2540c56258..f3690ce8a7 100644
--- a/doc/classes/NavigationObstacle2D.xml
+++ b/doc/classes/NavigationObstacle2D.xml
@@ -8,6 +8,14 @@
</description>
<tutorials>
</tutorials>
+ <methods>
+ <method name="get_rid" qualifiers="const">
+ <return type="RID" />
+ <description>
+ Returns the [RID] of this obstacle on the [NavigationServer2D].
+ </description>
+ </method>
+ </methods>
<members>
<member name="estimate_radius" type="bool" setter="set_estimate_radius" getter="is_radius_estimated" default="true">
Enables radius estimation algorithm which uses parent's collision shapes to determine the obstacle radius.
diff --git a/doc/classes/NavigationObstacle3D.xml b/doc/classes/NavigationObstacle3D.xml
index f9489db5f1..e6ea70b91a 100644
--- a/doc/classes/NavigationObstacle3D.xml
+++ b/doc/classes/NavigationObstacle3D.xml
@@ -8,6 +8,14 @@
</description>
<tutorials>
</tutorials>
+ <methods>
+ <method name="get_rid" qualifiers="const">
+ <return type="RID" />
+ <description>
+ Returns the [RID] of this obstacle on the [NavigationServer3D].
+ </description>
+ </method>
+ </methods>
<members>
<member name="estimate_radius" type="bool" setter="set_estimate_radius" getter="is_radius_estimated" default="true">
Enables radius estimation algorithm which uses parent's collision shapes to determine the obstacle radius.