summaryrefslogtreecommitdiffstats
path: root/doc/classes/NavigationServer3D.xml
diff options
context:
space:
mode:
authorYuri Sizov <yuris@humnom.net>2023-07-26 18:39:47 +0200
committerYuri Sizov <yuris@humnom.net>2023-07-26 18:39:47 +0200
commit6f6f7db91108e567c353723aba244fce63ccea5d (patch)
tree6aeae51fe4041a51d9a9f6c73d68e8287878764c /doc/classes/NavigationServer3D.xml
parente8df8c5e2c067edfbe5ca448e4ba1c266f653843 (diff)
parent69fad39cf5437b45bac2039d864605b2b63b9950 (diff)
downloadredot-engine-6f6f7db91108e567c353723aba244fce63ccea5d.tar.gz
Merge pull request #79129 from smix8/navbase_enabled_4.x
Add NavigationServer API to enable regions and links
Diffstat (limited to 'doc/classes/NavigationServer3D.xml')
-rw-r--r--doc/classes/NavigationServer3D.xml30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml
index e4f9a1627f..ebde6fdf7b 100644
--- a/doc/classes/NavigationServer3D.xml
+++ b/doc/classes/NavigationServer3D.xml
@@ -248,6 +248,13 @@
Create a new link between two positions on a map.
</description>
</method>
+ <method name="link_get_enabled" qualifiers="const">
+ <return type="bool" />
+ <param index="0" name="link" type="RID" />
+ <description>
+ Returns [code]true[/code] if the specified [param link] is enabled.
+ </description>
+ </method>
<method name="link_get_end_position" qualifiers="const">
<return type="Vector3" />
<param index="0" name="link" type="RID" />
@@ -312,6 +319,14 @@
Sets whether this [param link] can be travelled in both directions.
</description>
</method>
+ <method name="link_set_enabled">
+ <return type="void" />
+ <param index="0" name="link" type="RID" />
+ <param index="1" name="enabled" type="bool" />
+ <description>
+ If [param enabled] is [code]true[/code] the specified [param link] will contribute to its current navigation map.
+ </description>
+ </method>
<method name="link_set_end_position">
<return type="void" />
<param index="0" name="link" type="RID" />
@@ -734,6 +749,13 @@
Returns how many connections this [param region] has with other regions in the map.
</description>
</method>
+ <method name="region_get_enabled" qualifiers="const">
+ <return type="bool" />
+ <param index="0" name="region" type="RID" />
+ <description>
+ Returns [code]true[/code] if the specified [param region] is enabled.
+ </description>
+ </method>
<method name="region_get_enter_cost" qualifiers="const">
<return type="float" />
<param index="0" name="region" type="RID" />
@@ -786,6 +808,14 @@
[b]Note:[/b] If navigation meshes from different navigation regions overlap (which should be avoided in general) the result might not be what is expected.
</description>
</method>
+ <method name="region_set_enabled">
+ <return type="void" />
+ <param index="0" name="region" type="RID" />
+ <param index="1" name="enabled" type="bool" />
+ <description>
+ If [param enabled] is [code]true[/code] the specified [param region] will contribute to its current navigation map.
+ </description>
+ </method>
<method name="region_set_enter_cost">
<return type="void" />
<param index="0" name="region" type="RID" />