summaryrefslogtreecommitdiff
path: root/doc/classes/NavigationRegion.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/NavigationRegion.xml')
-rw-r--r--doc/classes/NavigationRegion.xml42
1 files changed, 0 insertions, 42 deletions
diff --git a/doc/classes/NavigationRegion.xml b/doc/classes/NavigationRegion.xml
deleted file mode 100644
index a32ded2878..0000000000
--- a/doc/classes/NavigationRegion.xml
+++ /dev/null
@@ -1,42 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="NavigationRegion" inherits="Spatial" version="4.0">
- <brief_description>
- A region of the navigation map.
- </brief_description>
- <description>
- A region of the navigation map. It tells the [Navigation] node what can be navigated and what cannot, based on the [NavigationMesh] resource. This should be a child of a [Navigation] node (even not a direct child).
- </description>
- <tutorials>
- </tutorials>
- <methods>
- <method name="bake_navigation_mesh">
- <return type="void">
- </return>
- <description>
- 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>
- </methods>
- <members>
- <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" default="true">
- Determines if the [NavigationRegion] is enabled or disabled.
- </member>
- <member name="navmesh" type="NavigationMesh" setter="set_navigation_mesh" getter="get_navigation_mesh">
- The [NavigationMesh] resource to use.
- </member>
- </members>
- <signals>
- <signal name="bake_finished">
- <description>
- Notifies when the navigation mesh bake operation is completed.
- </description>
- </signal>
- <signal name="navigation_mesh_changed">
- <description>
- Notifies when the [NavigationMesh] has changed.
- </description>
- </signal>
- </signals>
- <constants>
- </constants>
-</class>