Open Classmigueldeicaza.swiftgodot 0.46.0SwiftGodot

NavigationRegion3D

A traversable 3D region that NavigationAgent3Ds can use for pathfinding.

class NavigationRegion3D

Mangled symbol

s10SwiftGodot18NavigationRegion3DCWhat are these?

FNV24: [7GHYD]

A traversable 3D region based on a NavigationMesh that NavigationAgent3Ds 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 cost of entering this region from another region can be controlled with the enterCost value.

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

This object emits the following signals:

Superclasses

class Node3D
Most basic 3D game object, parent of all 3D-related nodes.

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
Notifies when the navigation mesh bake operation is completed.
var enabled: Bool
Determines if the NavigationRegion3D 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 navigationMesh: NavigationMesh?
The NavigationMesh resource to use.
var navigationMeshChanged: SimpleSignal
Notifies when the NavigationMesh has changed.
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 bakeNavigationMesh(onThread: Bool)
Bakes the NavigationMesh. If onThread is set to true (default), the baking is done on a separate thread. Baking on separate thread is useful because navigation baking is not a cheap operation. When it is completed, it automatically sets the new NavigationMesh. Please note that baking on separate thread may be very slow if geometry is parsed from meshes as async access to each mesh involves heavy synchronization. Also, please note that baking on a separate thread is automatically disabled on operating systems that cannot use threads (such as Web with threads disabled).
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 NavigationServer3D.
func getRid() -> RID
Returns the RID of this region on the NavigationServer3D. Combined with mapGetClosestPointOwner(map:toPoint:) can be used to identify the NavigationRegion3D closest to a point on the merged navigation map.
func isBaking() -> Bool
Returns true when the NavigationMesh 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 World3D default navigation map so this function is only required to override the default map.