NavigationRegion3D¶
Inherits: Node3D < Node < Object
A region of the navigation map.
Description¶
A region of the navigation map. It tells the NavigationServer3D what can be navigated and what cannot, based on its NavigationMesh resource.
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 NavigationServer3D.map_set_edge_connection_margin.
Properties¶
|
||
|
||
Methods¶
void |
Signals¶
bake_finished ( )
Notifies when the navigation mesh bake operation is completed.
navigation_mesh_changed ( )
Notifies when the NavigationMesh has changed.
Property Descriptions¶
bool enabled
Default |
|
Setter |
set_enabled(value) |
Getter |
is_enabled() |
Determines if the NavigationRegion3D
is enabled or disabled.
int layers
Default |
|
Setter |
set_layers(value) |
Getter |
get_layers() |
A bitfield determining all layers the region belongs to. These layers can be checked upon when requesting a path with NavigationServer3D.map_get_path.
NavigationMesh navmesh
Setter |
set_navigation_mesh(value) |
Getter |
get_navigation_mesh() |
The NavigationMesh resource to use.
Method Descriptions¶
void bake_navigation_mesh ( )
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.