Open Classmigueldeicaza.swiftgodot 0.45.0SwiftGodot

NavigationPolygon

A 2D navigation mesh that describes a traversable surface for pathfinding.

class NavigationPolygon

Mangled symbol

s10SwiftGodot17NavigationPolygonCWhat are these?

FNV24: [7TVRW]

A navigation mesh can be created either by baking it with the help of the NavigationServer2D, or by adding vertices and convex polygon indices arrays manually.

To bake a navigation mesh at least one outline needs to be added that defines the outer bounds of the baked area.

Adding vertices and polygon indices manually.

Superclasses

class Resource
Base class for serializable objects.

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.

Types

Type members

class var godotClassName: StringName

Instance members

var agentRadius: Double
The distance to erode/shrink the walkable surface when baking the navigation mesh.
var cellSize: Double
The cell size used to rasterize the navigation mesh vertices. Must match with the cell size on the navigation map.
var parsedCollisionMask: UInt32
The physics layers to scan for static colliders.
var parsedGeometryType: NavigationPolygon.ParsedGeometryType
Determines which type of nodes will be parsed as geometry. See ParsedGeometryType for possible values.
var sourceGeometryGroupName: StringName
The group name of nodes that should be parsed for baking source geometry.
var sourceGeometryMode: NavigationPolygon.SourceGeometryMode
The source of the geometry used when baking. See SourceGeometryMode for possible values.
var vertices: PackedVector2Array
func addOutline(PackedVector2Array)
Appends a PackedVector2Array that contains the vertices of an outline to the internal array that contains all the outlines.
func addOutlineAtIndex(outline: PackedVector2Array, index: Int32)
Adds a PackedVector2Array that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position.
func addPolygon(PackedInt32Array)
Adds a polygon using the indices of the vertices you get when calling getVertices().
func clear()
Clears the internal arrays for vertices and polygon indices.
func clearOutlines()
Clears the array of the outlines, but it doesn’t clear the vertices and the polygons that were created by them.
func clearPolygons()
Clears the array of polygons, but it doesn’t clear the array of outlines and vertices.
func getNavigationMesh() -> NavigationMesh?
Returns the NavigationMesh resulting from this navigation polygon. This navigation mesh can be used to update the navigation mesh of a region with the regionSetNavigationMesh(region:navigationMesh:) API directly (as 2D uses the 3D server behind the scene).
func getOutline(idx: Int32) -> PackedVector2Array
Returns a PackedVector2Array containing the vertices of an outline that was created in the editor or by script.
func getOutlineCount() -> Int32
Returns the number of outlines that were created in the editor or by script.
func getParsedCollisionMaskValue(layerNumber: Int32) -> Bool
Returns whether or not the specified layer of the parsedCollisionMask is enabled, given a layerNumber between 1 and 32.
func getPolygon(idx: Int32) -> PackedInt32Array
Returns a PackedInt32Array containing the indices of the vertices of a created polygon.
func getPolygonCount() -> Int32
Returns the count of all polygons.
func makePolygonsFromOutlines()
Creates polygons from the outlines added in the editor or by script.
func removeOutline(idx: Int32)
Removes an outline created in the editor or by script. You have to call makePolygonsFromOutlines for the polygons to update.
func setOutline(idx: Int32, outline: PackedVector2Array)
Changes an outline created in the editor or by script. You have to call makePolygonsFromOutlines for the polygons to update.
func setParsedCollisionMaskValue(layerNumber: Int32, value: Bool)
Based on value, enables or disables the specified layer in the parsedCollisionMask, given a layerNumber between 1 and 32.