Inheritance #

NavigationMesh #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

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.

Members #

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.

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: While baking and not zero, this value will be rounded up to the nearest multiple of cell_size.

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 = PARSED_GEOMETRY_BOTH#

Determines which type of nodes will be parsed as geometry. See ParsedGeometryType for possible values.

var geometry_source_geometry_mode = SOURCE_GEOMETRY_ROOT_NODE_CHILDREN#

The source of the geometry used when baking. See SourceGeometryMode for possible values.

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 = SAMPLE_PARTITION_WATERSHED#

Partitioning algorithm for creating the navigation mesh polys. See SamplePartitionType for possible values.

var vertices_per_polygon: float = 6.0#

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

Methods #

Annotations #

Constants #

const SAMPLE_PARTITION_WATERSHED = 0 enum SamplePartitionType#

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

const SAMPLE_PARTITION_MONOTONE = 1 enum SamplePartitionType#

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

const SAMPLE_PARTITION_LAYERS = 2 enum SamplePartitionType#

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

const SAMPLE_PARTITION_MAX = 3 enum SamplePartitionType#

Represents the size of the SamplePartitionType enum.

const PARSED_GEOMETRY_MESH_INSTANCES = 0 enum ParsedGeometryType#

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

const PARSED_GEOMETRY_STATIC_COLLIDERS = 1 enum ParsedGeometryType#

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

const PARSED_GEOMETRY_BOTH = 2 enum ParsedGeometryType#

Both PARSED_GEOMETRY_MESH_INSTANCES and PARSED_GEOMETRY_STATIC_COLLIDERS.

const PARSED_GEOMETRY_MAX = 3 enum ParsedGeometryType#

Represents the size of the ParsedGeometryType enum.

const SOURCE_GEOMETRY_ROOT_NODE_CHILDREN = 0 enum SourceGeometryMode#

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

const SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN = 1 enum SourceGeometryMode#

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

const SOURCE_GEOMETRY_GROUPS_EXPLICIT = 2 enum SourceGeometryMode#

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

const SOURCE_GEOMETRY_MAX = 3 enum SourceGeometryMode#

Represents the size of the SourceGeometryMode enum.

Constructors #

Enums #

SamplePartitionType#

ParsedGeometryType#

SourceGeometryMode#

Operators #

Signals #

Theme Items #

Tutorials #