summaryrefslogtreecommitdiff
path: root/doc/classes/NavigationServer2D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/NavigationServer2D.xml')
-rw-r--r--doc/classes/NavigationServer2D.xml34
1 files changed, 31 insertions, 3 deletions
diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml
index a59666356c..928834101f 100644
--- a/doc/classes/NavigationServer2D.xml
+++ b/doc/classes/NavigationServer2D.xml
@@ -21,6 +21,13 @@
Creates the agent.
</description>
</method>
+ <method name="agent_get_map" qualifiers="const">
+ <return type="RID" />
+ <argument index="0" name="agent" type="RID" />
+ <description>
+ Returns the navigation map [RID] the requested [code]agent[/code] is currently assigned to.
+ </description>
+ </method>
<method name="agent_is_map_changed" qualifiers="const">
<return type="bool" />
<argument index="0" name="agent" type="RID" />
@@ -110,11 +117,11 @@
Sets the current velocity of the agent.
</description>
</method>
- <method name="free" qualifiers="const">
+ <method name="free_rid" qualifiers="const">
<return type="void" />
- <argument index="0" name="object" type="RID" />
+ <argument index="0" name="rid" type="RID" />
<description>
- Destroy the RID
+ Destroys the given RID.
</description>
</method>
<method name="map_create" qualifiers="const">
@@ -123,6 +130,13 @@
Create a new map.
</description>
</method>
+ <method name="map_get_agents" qualifiers="const">
+ <return type="Array" />
+ <argument index="0" name="map" type="RID" />
+ <description>
+ Returns all navigation agents [RID]s that are currently assigned to the requested navigation [code]map[/code].
+ </description>
+ </method>
<method name="map_get_cell_size" qualifiers="const">
<return type="float" />
<argument index="0" name="map" type="RID" />
@@ -164,6 +178,13 @@
Returns the navigation path to reach the destination from the origin. [code]layers[/code] is a bitmask of all region layers that are allowed to be in the path.
</description>
</method>
+ <method name="map_get_regions" qualifiers="const">
+ <return type="Array" />
+ <argument index="0" name="map" type="RID" />
+ <description>
+ Returns all navigation regions [RID]s that are currently assigned to the requested navigation [code]map[/code].
+ </description>
+ </method>
<method name="map_is_active" qualifiers="const">
<return type="bool" />
<argument index="0" name="nap" type="RID" />
@@ -231,6 +252,13 @@
Returns the region's layers.
</description>
</method>
+ <method name="region_get_map" qualifiers="const">
+ <return type="RID" />
+ <argument index="0" name="region" type="RID" />
+ <description>
+ Returns the navigation map [RID] the requested [code]region[/code] is currently assigned to.
+ </description>
+ </method>
<method name="region_set_layers" qualifiers="const">
<return type="void" />
<argument index="0" name="region" type="RID" />