Index · Object → RefCounted → Resource → NavigationMesh

NavigationMesh

A navigation mesh that defines traversable areas and obstacles.

Class Description

A navigation mesh is a collection of polygons that define which areas of an environment are traversable to aid agents in pathfinding through complicated spaces.

Properties

var agent_height: float = 1.5

The minimum floor to ceiling height that will still allow the floor area to be considered walkable.

Note: While baking, this value will be rounded up to the nearest multiple of cell_height.

var agent_max_climb: float = 0.25

The minimum ledge height that is considered to still be traversable.

Note: While baking, this value will be rounded down to the nearest multiple of cell_height.

var agent_max_slope: float = 45.0

The maximum slope that is considered walkable, in degrees.

var agent_radius: float = 0.5

The distance to erode/shrink the walkable area of the heightfield away from obstructions.

Note: While baking, this value will be rounded up to the nearest multiple of cell_size.

Note: The radius must be equal or higher than 0.0. If the radius is 0.0, it won't be possible to fix invalid outline overlaps and other precision errors during the baking process. As a result, some obstacles may be excluded incorrectly from the final navigation mesh, or may delete the navigation mesh's polygons.

var border_size: float = 0.0

The size of the non-navigable border around the bake bounding area.

In conjunction with the filter_baking_aabb and a edge_max_error value at 1.0 or below the border size can be used to bake tile aligned navigation meshes without the tile edges being shrunk by agent_radius.

Note: If this value is not 0.0, it will be rounded up to the nearest multiple of cell_size during baking.

var cell_height: float = 0.25

The cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height on the navigation map.

var cell_size: float = 0.25

The cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size on the navigation map.

var detail_sample_distance: float = 6.0

The sampling distance to use when generating the detail mesh, in cell unit.

var detail_sample_max_error: float = 1.0

The maximum distance the detail mesh surface should deviate from heightfield, in cell unit.

var edge_max_error: float = 1.3

The maximum distance a simplified contour's border edges should deviate the original raw contour.

var edge_max_length: float = 0.0

The maximum allowed length for contour edges along the border of the mesh. A value of 0.0 disables this feature.

Note: While baking, this value will be rounded up to the nearest multiple of cell_size.

var filter_baking_aabb: AABB = AABB(0, 0, 0, 0, 0, 0)

If the baking AABB has a volume the navigation mesh baking will be restricted to its enclosing area.

var filter_baking_aabb_offset: Vector3 = Vector3(0, 0, 0)

The position offset applied to the filter_baking_aabb AABB.

var filter_ledge_spans: bool = false

If true, marks spans that are ledges as non-walkable.

var filter_low_hanging_obstacles: bool = false

If true, marks non-walkable spans as walkable if their maximum is within agent_max_climb of a walkable neighbor.

var filter_walkable_low_height_spans: bool = false

If true, marks walkable spans as not walkable if the clearance above the span is less than agent_height.

var geometry_collision_mask: int = 4294967295

The physics layers to scan for static colliders.

Only used when geometry_parsed_geometry_type is PARSED_GEOMETRY_STATIC_COLLIDERS or PARSED_GEOMETRY_BOTH.

var geometry_parsed_geometry_type: NavigationMesh.ParsedGeometryType = 2

Determines which type of nodes will be parsed as geometry.

var geometry_source_geometry_mode: NavigationMesh.SourceGeometryMode = 0

The source of the geometry used when baking.

var geometry_source_group_name: StringName = &"navigation_mesh_source_group"

The name of the group to scan for geometry.

Only used when geometry_source_geometry_mode is SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN or SOURCE_GEOMETRY_GROUPS_EXPLICIT.

var region_merge_size: float = 20.0

Any regions with a size smaller than this will be merged with larger regions if possible.

Note: This value will be squared to calculate the number of cells. For example, a value of 20 will set the number of cells to 400.

var region_min_size: float = 2.0

The minimum size of a region for it to be created.

Note: This value will be squared to calculate the minimum number of cells allowed to form isolated island areas. For example, a value of 8 will set the number of cells to 64.

var sample_partition_type: NavigationMesh.SamplePartitionType = 0

Partitioning algorithm for creating the navigation mesh polys.

var vertices_per_polygon: float = 6.0

The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process.

Inherited from Resource (4)

Methods

func add_polygon(polygon: PackedInt32Array) -> void

Adds a polygon using the indices of the vertices you get when calling get_vertices().

func clear() -> void

Clears the internal arrays for vertices and polygon indices.

func clear_polygons() -> void

Clears the array of polygons, but it doesn't clear the array of vertices.

func create_from_mesh(mesh: Mesh) -> void

Initializes the navigation mesh by setting the vertices and indices according to a Mesh.

Note: The given mesh must be of type Mesh.PRIMITIVE_TRIANGLES and have an index array.

func get_collision_mask_value(layer_number: int) -> bool

Returns whether or not the specified layer of the geometry_collision_mask is enabled, given a layer_number between 1 and 32.

func get_polygon(idx: int) -> PackedInt32Array

Returns a PackedInt32Array containing the indices of the vertices of a created polygon.

func get_polygon_count() -> int

Returns the number of polygons in the navigation mesh.

func get_vertices() -> PackedVector3Array

Returns a PackedVector3Array containing all the vertices being used to create the polygons.

func set_collision_mask_value(layer_number: int, value: bool) -> void

Based on value, enables or disables the specified layer in the geometry_collision_mask, given a layer_number between 1 and 32.

func set_vertices(vertices: PackedVector3Array) -> void

Sets the vertices that can be then indexed to create polygons with the add_polygon() method.

Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)

Enums & Constants

enum SamplePartitionType
SAMPLE_PARTITION_WATERSHED = 0

Watershed partitioning. Generally the best choice if you precompute the navigation mesh, use this if you have large open areas.

SAMPLE_PARTITION_MONOTONE = 1

Monotone partitioning. Use this if you want fast navigation mesh generation.

SAMPLE_PARTITION_LAYERS = 2

Layer partitioning. Good choice to use for tiled navigation mesh with medium and small sized tiles.

SAMPLE_PARTITION_MAX = 3

Represents the size of the SamplePartitionType enum.

enum ParsedGeometryType
PARSED_GEOMETRY_MESH_INSTANCES = 0

Parses mesh instances as geometry. This includes MeshInstance3D, CSGShape3D, and GridMap nodes.

PARSED_GEOMETRY_STATIC_COLLIDERS = 1

Parses StaticBody3D colliders as geometry. The collider should be in any of the layers specified by geometry_collision_mask.

PARSED_GEOMETRY_BOTH = 2

Both PARSED_GEOMETRY_MESH_INSTANCES and PARSED_GEOMETRY_STATIC_COLLIDERS.

PARSED_GEOMETRY_MAX = 3

Represents the size of the ParsedGeometryType enum.

enum SourceGeometryMode
SOURCE_GEOMETRY_ROOT_NODE_CHILDREN = 0

Scans the child nodes of the root node recursively for geometry.

SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN = 1

Scans nodes in a group and their child nodes recursively for geometry. The group is specified by geometry_source_group_name.

SOURCE_GEOMETRY_GROUPS_EXPLICIT = 2

Uses nodes in a group for geometry. The group is specified by geometry_source_group_name.

SOURCE_GEOMETRY_MAX = 3

Represents the size of the SourceGeometryMode enum.