SourceGeometryMode
NavigationMesh.swift:63enum SourceGeometryModeenum SourceGeometryModeimport SwiftGodotFramework to write Godot Game Extensions using the Swift Programming Language.
class NavigationMeshA navigation mesh that defines traversable areas and obstacles.
case rootNodeChildrenScans the child nodes of the root node recursively for geometry.
case groupsWithChildrenScans nodes in a group and their child nodes recursively for geometry. The group is specified by geometrySourceGroupName.
case groupsExplicitUses nodes in a group for geometry. The group is specified by geometrySourceGroupName.
case maxRepresents the size of the SourceGeometryMode enum.
final var geometrySourceGroupName: StringName { get set }The name of the group to scan for geometry.
override class var godotClassName: StringName { get }final var agentHeight: Double { get set }The minimum floor to ceiling height that will still allow the floor area to be considered walkable.
final var agentMaxClimb: Double { get set }The minimum ledge height that is considered to still be traversable.
final var agentMaxSlope: Double { get set }The maximum slope that is considered walkable, in degrees.
final var agentRadius: Double { get set }The distance to erode/shrink the walkable area of the heightfield away from obstructions.
final var borderSize: Double { get set }The size of the non-navigable border around the bake bounding area.
final var cellHeight: Double { get set }The cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height on the navigation map.
final var cellSize: Double { get set }The cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size on the navigation map.
final var detailSampleDistance: Double { get set }The sampling distance to use when generating the detail mesh, in cell unit.
final var detailSampleMaxError: Double { get set }The maximum distance the detail mesh surface should deviate from heightfield, in cell unit.
final var edgeMaxError: Double { get set }The maximum distance a simplified contour’s border edges should deviate the original raw contour.
final var edgeMaxLength: Double { get set }The maximum allowed length for contour edges along the border of the mesh. A value of 0.0 disables this feature.
final var filterBakingAabb: AABB { get set }If the baking AABB has a volume the navigation mesh baking will be restricted to its enclosing area.
final var filterBakingAabbOffset: Vector3 { get set }The position offset applied to the filterBakingAabb AABB.
final var filterLedgeSpans: Bool { get set }If true, marks spans that are ledges as non-walkable.
final var filterLowHangingObstacles: Bool { get set }If true, marks non-walkable spans as walkable if their maximum is within agentMaxClimb of a walkable neighbor.
final var filterWalkableLowHeightSpans: Bool { get set }If true, marks walkable spans as not walkable if the clearance above the span is less than agentHeight.
final var geometryCollisionMask: UInt32 { get set }The physics layers to scan for static colliders.
final var geometryParsedGeometryType: NavigationMesh.ParsedGeometryType { get set }Determines which type of nodes will be parsed as geometry. See ParsedGeometryType for possible values.
final var geometrySourceGeometryMode: NavigationMesh.SourceGeometryMode { get set }The source of the geometry used when baking. See SourceGeometryMode for possible values.
final var regionMergeSize: Double { get set }Any regions with a size smaller than this will be merged with larger regions if possible.
final var regionMinSize: Double { get set }The minimum size of a region for it to be created.
final var samplePartitionType: NavigationMesh.SamplePartitionType { get set }Partitioning algorithm for creating the navigation mesh polys. See SamplePartitionType for possible values.
final var vertices: PackedVector3Array { get set }final var verticesPerPolygon: Double { get set }The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process.
final func addPolygon(_ polygon: PackedInt32Array) Adds a polygon using the indices of the vertices you get when calling getVertices().
final func clear() Clears the internal arrays for vertices and polygon indices.
final func clearPolygons() Clears the array of polygons, but it doesn’t clear the array of vertices.
final func createFromMesh(_ mesh: Mesh?) Initializes the navigation mesh by setting the vertices and indices according to a Mesh.
final func getCollisionMaskValue(layerNumber: Int32) -> Bool Returns whether or not the specified layer of the geometryCollisionMask is enabled, given a layerNumber between 1 and 32.
final func getPolygon(idx: Int32) -> PackedInt32Array Returns a PackedInt32Array containing the indices of the vertices of a created polygon.
final func getPolygonCount() -> Int32 Returns the number of polygons in the navigation mesh.
final func setCollisionMaskValue(layerNumber: Int32, value: Bool) Based on value, enables or disables the specified layer in the geometryCollisionMask, given a layerNumber between 1 and 32.
enum ParsedGeometryTypeenum SamplePartitionTypeprotocol CaseIterableA type that provides a collection of all of its values.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol EquatableA type that can be compared for value equality.
protocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol RawRepresentable<RawValue>A type that can be converted to and from an associated raw value.
init?(rawValue: Int64) var debugDescription: String { get }A textual representation of this instance, suitable for debugging
var hashValue: Int { get }static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.
func hash(into hasher: inout Hasher)