Open Classmigueldeicaza.swiftgodot 0.46.0SwiftGodot

NavigationRegion2D

A traversable 2D region that NavigationAgent2Ds can use for pathfinding.

class NavigationRegion2D

Mangled symbol

s10SwiftGodot18NavigationRegion2DCWhat are these?

FNV24: [7E6WM]

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 mapSetEdgeConnectionMargin(map:margin:).

The pathfinding cost of entering a region from another region can be controlled with the enterCost value.

The pathfinding cost of traveling distances inside this region can be controlled with the travelCost multiplier.

This object emits the following signals:

Superclasses

class Node2D
A 2D game object, inherited by all 2D-related nodes. Has a position, rotation, scale, and Z index.

Citizens in SwiftGodot

Conformances

protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a Hasher to produce an integer hash value.
protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.
protocol VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

Type members

class var godotClassName: StringName

Instance members

var bakeFinished: SimpleSignal
Emitted when a navigation polygon bake operation is completed.
var enabled: Bool
Determines if the NavigationRegion2D is enabled or disabled.
var enterCost: Double
When pathfinding enters this region’s navigation mesh from another regions navigation mesh the enterCost value is added to the path distance for determining the shortest path.
var navigationLayers: UInt32
A bitfield determining all navigation layers the region belongs to. These navigation layers can be checked upon when requesting a path with mapGetPath(map:origin:destination:optimize:navigationLayers:).
var navigationPolygon: NavigationPolygon?
The NavigationPolygon resource to use.
var navigationPolygonChanged: SimpleSignal
Emitted when the used navigation polygon is replaced or changes to the internals of the current navigation polygon are committed.
var travelCost: Double
When pathfinding moves inside this region’s navigation mesh the traveled distances are multiplied with travelCost for determining the shortest path.
var useEdgeConnections: Bool
If enabled the navigation region will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
func bakeNavigationPolygon(onThread: Bool)
Bakes the NavigationPolygon. If onThread is set to true (default), the baking is done on a separate thread.
func getNavigationLayerValue(layerNumber: Int32) -> Bool
Returns whether or not the specified layer of the navigationLayers bitmask is enabled, given a layerNumber between 1 and 32.
func getNavigationMap() -> RID
Returns the current navigation map RID used by this region.
func getRegionRid() -> RID
Returns the RID of this region on the NavigationServer2D.
func getRid() -> RID
Returns the RID of this region on the NavigationServer2D. Combined with mapGetClosestPointOwner(map:toPoint:) can be used to identify the NavigationRegion2D closest to a point on the merged navigation map.
func isBaking() -> Bool
Returns true when the NavigationPolygon is being baked on a background thread.
func setNavigationLayerValue(layerNumber: Int32, value: Bool)
Based on value, enables or disables the specified layer in the navigationLayers bitmask, given a layerNumber between 1 and 32.
func setNavigationMap(RID)
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.