2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-02-14 21:18:53 +08:00
<class name= "NavigationRegion3D" inherits= "Node3D" version= "4.0" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-13 04:42:36 +08:00
<brief_description >
2020-02-21 00:56:30 +08:00
A region of the navigation map.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2021-03-08 16:47:18 +08:00
A region of the navigation map. It tells the [NavigationServer3D] what can be navigated and what cannot, based on its [NavigationMesh] resource.
2021-03-09 03:56:33 +08:00
Two regions can be connected to each other if they share a similar edge. You can set the minimum distance between two vertices required to connect two edges by using [method NavigationServer3D.map_set_edge_connection_margin].
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
2020-02-10 22:24:00 +08:00
<method name= "bake_navigation_mesh" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2020-02-10 22:24:00 +08:00
<description >
2020-03-12 01:59:18 +08:00
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].
2020-02-10 22:24:00 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
</methods>
<members >
2019-06-29 18:38:01 +08:00
<member name= "enabled" type= "bool" setter= "set_enabled" getter= "is_enabled" default= "true" >
2020-03-31 00:22:57 +08:00
Determines if the [NavigationRegion3D] is enabled or disabled.
2017-09-13 04:42:36 +08:00
</member>
2021-03-09 03:56:33 +08:00
<member name= "layers" type= "int" setter= "set_layers" getter= "get_layers" default= "1" >
A bitfield determining all layers the region belongs to. These layers can be checked upon when requesting a path with [method NavigationServer3D.map_get_path].
</member>
2019-07-16 02:42:47 +08:00
<member name= "navmesh" type= "NavigationMesh" setter= "set_navigation_mesh" getter= "get_navigation_mesh" >
2020-02-10 22:24:00 +08:00
The [NavigationMesh] resource to use.
2017-09-13 04:42:36 +08:00
</member>
</members>
2020-02-10 22:24:00 +08:00
<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>
2017-09-13 04:42:36 +08:00
</class>
