Open Classmigueldeicaza.swiftgodot 0.45.0SwiftGodot

NavigationLink2D

A link between two positions on NavigationRegion2Ds that agents can be routed through.

class NavigationLink2D

Mangled symbol

s10SwiftGodot16NavigationLink2DCWhat are these?

FNV24: [8W6U9]

A link between two positions on NavigationRegion2Ds that agents can be routed through. These positions can be on the same NavigationRegion2D or on two different ones. Links are useful to express navigation methods other than traveling along the surface of the navigation polygon, such as ziplines, teleporters, or gaps that can be jumped across.

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 bidirectional: Bool
Whether this link can be traveled in both directions or only from startPosition to endPosition.
var enabled: Bool
Whether this link is currently active. If false, mapGetPath(map:origin:destination:optimize:navigationLayers:) will ignore this link.
var endPosition: Vector2
Ending position of the link.
var enterCost: Double
When pathfinding enters this link 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 link belongs to. These navigation layers will be checked when requesting a path with mapGetPath(map:origin:destination:optimize:navigationLayers:).
var startPosition: Vector2
Starting position of the link.
var travelCost: Double
When pathfinding moves along the link the traveled distance is multiplied with travelCost for determining the shortest path.
func getGlobalEndPosition() -> Vector2
Returns the endPosition that is relative to the link as a global position.
func getGlobalStartPosition() -> Vector2
Returns the startPosition that is relative to the link as a global position.
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 setGlobalEndPosition(Vector2)
Sets the endPosition that is relative to the link from a global position.
func setGlobalStartPosition(Vector2)
Sets the startPosition that is relative to the link from a global position.
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.