Inheritance #
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
- AnimationMixer (2)
- AudioStreamPlayer
- CanvasItem (2)
- CanvasLayer (1)
- EditorFileSystem
- EditorPlugin (1)
- EditorResourcePreview
- HTTPRequest
- InstancePlaceholder
- MissingNode
- MultiplayerSpawner
- MultiplayerSynchronizer
- NavigationAgent2D
- NavigationAgent3D
- Node3D (31)
- ResourcePreloader
- ShaderGlobalsOverride
- StatusIndicator
- Timer
- Viewport (2)
- WorldEnvironment
- AnimatedSprite2D
- AudioListener2D
- AudioStreamPlayer2D
- BackBufferCopy
- Bone2D
- CPUParticles2D
- Camera2D
- CanvasGroup
- CanvasModulate
- CollisionObject2D (2)
- CollisionPolygon2D
- CollisionShape2D
- GPUParticles2D
- Joint2D (3)
- Light2D (2)
- LightOccluder2D
- Line2D
- Marker2D
- MeshInstance2D
- MultiMeshInstance2D
- NavigationLink2D
- NavigationObstacle2D
- NavigationRegion2D
- Parallax2D
- ParallaxLayer
- Path2D
- PathFollow2D
- Polygon2D
- RayCast2D
- RemoteTransform2D
- ShapeCast2D
- Skeleton2D
- Sprite2D
- TileMap
- TileMapLayer
- TouchScreenButton
- VisibleOnScreenNotifier2D (1)
Table of contents
-
var enabled: bool = true -
var enter_cost: float = 0.0 -
var navigation_layers: int = 1 -
var navigation_polygon: NavigationPolygon -
var travel_cost: float = 1.0 -
var use_edge_connections: bool = true -
func bake_navigation_polygon(on_thread: bool = true) -> void -
const func get_bounds() -> Rect2 -
const func get_navigation_layer_value(layer_number: int) -> bool -
const func get_navigation_map() -> RID -
const func get_region_rid() -> RID -
const func get_rid() -> RID -
const func is_baking() -> bool -
func set_navigation_layer_value(value: bool) -> void -
func set_navigation_map(navigation_map: RID) -> void -
signal bake_finished() -
signal navigation_polygon_changed()
NavigationRegion2D #
is_instantiable, Node2D, Node, core, not_builtin_classes
A traversable 2D region that NavigationAgent2Ds can use for pathfinding.
A traversable 2D region based on a NavigationPolygon that NavigationAgent2Ds can use for pathfinding.
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 NavigationServer2D.map_set_edge_connection_margin.
Note: Overlapping two regions' navigation polygons is not enough for connecting two regions. They must share a similar edge.
The pathfinding cost of entering a region from another region can be controlled with the enter_cost value.
Note: This value is not added to the path cost when the start position is already inside this region.
The pathfinding cost of traveling distances inside this region can be controlled with the travel_cost multiplier.
Note: This node caches changes to its properties, so if you make changes to the underlying region RID in NavigationServer2D, they will not be reflected in this node's properties.
Members #
var enabled: bool = true#
Determines if the NavigationRegion2D is enabled or disabled.
var enter_cost: float = 0.0#
When pathfinding enters this region's navigation mesh from another regions navigation mesh the enter_cost value is added to the path distance for determining the shortest path.
var navigation_layers: int = 1#
A bitfield determining all navigation layers the region belongs to. These navigation layers can be checked upon when requesting a path with NavigationServer2D.map_get_path.
var navigation_polygon: NavigationPolygon#
The NavigationPolygon resource to use.
var travel_cost: float = 1.0#
When pathfinding moves inside this region's navigation mesh the traveled distances are multiplied with travel_cost for determining the shortest path.
var use_edge_connections: bool = true#
If enabled the navigation region will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
Methods #
func bake_navigation_polygon(on_thread: bool = true) -> void#
Bakes the NavigationPolygon. If on_thread is set to true (default), the baking is done on a separate thread.
const func get_bounds() -> Rect2#
Returns the axis-aligned rectangle for the region's transformed navigation mesh.
const func get_navigation_layer_value(layer_number: int) -> bool#
Returns whether or not the specified layer of the navigation_layers bitmask is enabled, given a layer_number between 1 and 32.
const func get_region_rid() -> RID#
Returns the RID of this region on the NavigationServer2D.
const func get_rid() -> RID#
Returns the RID of this region on the NavigationServer2D. Combined with NavigationServer2D.map_get_closest_point_owner can be used to identify the NavigationRegion2D closest to a point on the merged navigation map.
const func is_baking() -> bool#
Returns true when the NavigationPolygon is being baked on a background thread.
func set_navigation_layer_value(value: bool) -> void#
Based on value, enables or disables the specified layer in the navigation_layers bitmask, given a layer_number between 1 and 32.
func set_navigation_map(navigation_map: RID) -> void#
Sets the RID of the navigation map this region should use. By default the region will automatically join the World2D default navigation map so this function is only required to override the default map.
Annotations #
Constants #
Constructors #
Enums #
Operators #
Signals #
signal bake_finished()#
Emitted when a navigation polygon bake operation is completed.
signal navigation_polygon_changed()#
Emitted when the used navigation polygon is replaced or changes to the internals of the current navigation polygon are committed.