A navigation mesh that defines traversable areas and obstacles.
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.
$DOCS_URL/tutorials/navigation/navigation_using_navigationmeshes.html https://godotengine.org/asset-library/asset/2743
Adds a polygon using the indices of the vertices you get when calling [method get_vertices].
Clears the internal arrays for vertices and polygon indices.
Clears the array of polygons, but it doesn't clear the array of vertices.
Initializes the navigation mesh by setting the vertices and indices according to a [Mesh]. [b]Note:[/b] The given [param mesh] must be of type [constant Mesh.PRIMITIVE_TRIANGLES] and have an index array.
Returns whether or not the specified layer of the [member geometry_collision_mask] is enabled, given a [param layer_number] between 1 and 32.
Returns a [PackedInt32Array] containing the indices of the vertices of a created polygon.
Returns the number of polygons in the navigation mesh.
Returns a [PackedVector3Array] containing all the vertices being used to create the polygons.
Based on [param value], enables or disables the specified layer in the [member geometry_collision_mask], given a [param layer_number] between 1 and 32.
Sets the vertices that can be then indexed to create polygons with the [method add_polygon] method.
- The minimum floor to ceiling height that will still allow the floor area to be considered walkable. [b]Note:[/b] While baking, this value will be rounded up to the nearest multiple of [member cell_height].
- The minimum ledge height that is considered to still be traversable. [b]Note:[/b] While baking, this value will be rounded down to the nearest multiple of [member cell_height].
- The maximum slope that is considered walkable, in degrees.
- The distance to erode/shrink the walkable area of the heightfield away from obstructions. [b]Note:[/b] While baking, this value will be rounded up to the nearest multiple of [member cell_size]. [b]Note:[/b] The radius must be equal or higher than [code]0.0[/code]. If the radius is [code]0.0[/code], 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.
- The size of the non-navigable border around the bake bounding area. In conjunction with the [member filter_baking_aabb] and a [member edge_max_error] value at [code]1.0[/code] or below the border size can be used to bake tile aligned navigation meshes without the tile edges being shrunk by [member agent_radius]. [b]Note:[/b] If this value is not [code]0.0[/code], it will be rounded up to the nearest multiple of [member cell_size] during baking.
- The cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height on the navigation map.
- The cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size on the navigation map.
- The sampling distance to use when generating the detail mesh, in cell unit.
- The maximum distance the detail mesh surface should deviate from heightfield, in cell unit.
- The maximum distance a simplified contour's border edges should deviate the original raw contour.
- The maximum allowed length for contour edges along the border of the mesh. A value of [code]0.0[/code] disables this feature. [b]Note:[/b] While baking, this value will be rounded up to the nearest multiple of [member cell_size].
- If the baking [AABB] has a volume the navigation mesh baking will be restricted to its enclosing area.
- The position offset applied to the [member filter_baking_aabb] [AABB].
- If [code]true[/code], marks spans that are ledges as non-walkable.
- If [code]true[/code], marks non-walkable spans as walkable if their maximum is within [member agent_max_climb] of a walkable neighbor.
- If [code]true[/code], marks walkable spans as not walkable if the clearance above the span is less than [member agent_height].
- The physics layers to scan for static colliders. Only used when [member geometry_parsed_geometry_type] is [constant PARSED_GEOMETRY_STATIC_COLLIDERS] or [constant PARSED_GEOMETRY_BOTH].
- Determines which type of nodes will be parsed as geometry.
- The source of the geometry used when baking.
- The name of the group to scan for geometry. Only used when [member geometry_source_geometry_mode] is [constant SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN] or [constant SOURCE_GEOMETRY_GROUPS_EXPLICIT].
- Any regions with a size smaller than this will be merged with larger regions if possible. [b]Note:[/b] 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.
- The minimum size of a region for it to be created. [b]Note:[/b] 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.
- Partitioning algorithm for creating the navigation mesh polys.
- The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process.
Watershed partitioning. Generally the best choice if you precompute the navigation mesh, use this if you have large open areas.
Monotone partitioning. Use this if you want fast navigation mesh generation.
Layer partitioning. Good choice to use for tiled navigation mesh with medium and small sized tiles.
Represents the size of the [enum SamplePartitionType] enum.
Parses mesh instances as geometry. This includes [MeshInstance3D], [CSGShape3D], and [GridMap] nodes.
Parses [StaticBody3D] colliders as geometry. The collider should be in any of the layers specified by [member geometry_collision_mask].
Both [constant PARSED_GEOMETRY_MESH_INSTANCES] and [constant PARSED_GEOMETRY_STATIC_COLLIDERS].
Represents the size of the [enum ParsedGeometryType] enum.
Scans the child nodes of the root node recursively for geometry.
Scans nodes in a group and their child nodes recursively for geometry. The group is specified by [member geometry_source_group_name].
Uses nodes in a group for geometry. The group is specified by [member geometry_source_group_name].
Represents the size of the [enum SourceGeometryMode] enum.