Class CollectionSettings

FilterMode collectionMode = FilterMode.Layers

Determines how the initial filtering of objects is done.

float colliderRasterizeDetail = 1

Controls detail on rasterization of sphere and capsule colliders.

The colliders will be approximated with polygons so that the max distance to the theoretical surface is less than 1/(this number of voxels).

A higher value does not necessarily increase quality of the mesh, but a lower value will often speed it up.

You should try to keep this value as low as possible without affecting the mesh quality since that will yield the fastest scan times.

The default value is 1, which corresponds to a maximum error of 1 voxel. In most cases, increasing this to a value higher than 2 (corresponding to a maximum error of 0.5 voxels) is not useful.

LayerMask layerMask = -1

Objects in all of these layers will be rasterized.

Will only be used if collectionMode is set to Layers.

System.Action<RecastMeshGatherer> onCollectMeshes

Callback for collecting custom scene meshes.

This callback will be called once when scanning the graph, to allow you to add custom meshes to the graph, and once every time a graph update happens. Use the RecastMeshGatherer class to add meshes that are to be rasterized.

AstarPath.active.data.recastGraph.collectionSettings.onCollectMeshes += (RecastMeshGatherer gatherer) => {
// Define a mesh using 4 vertices and 2 triangles
var vertices = new Vector3[] {
new Vector3(0, 0, 0),
new Vector3(100, 0, 0),
new Vector3(100, 0, 100),
new Vector3(0, 0, 100)
};
var triangles = new int[] { 0, 1, 2, 0, 2, 3 };
// Register the mesh buffers
var meshDataIndex = gatherer.AddMeshBuffers(vertices, triangles);
// Register the mesh for rasterization
gatherer.AddMesh(new RecastMeshGatherer.GatheredMesh {
meshDataIndex = meshDataIndex,
area = 0,
indexStart = 0,
indexEnd = -1,
bounds = default,
matrix = Matrix4x4.identity,
solid = false,
doubleSided = true,
flatten = false,
areaIsTag = false
});
};
AstarPath.active.Scan();


PhysicsScene? physicsScene = null

The physics scene for collecting colliders when scanning the graph.

If null (the default), the physics scene that the AstarPath component is part of will be used.

You typically don't have to set this, but it can be useful in some rare situations.

Only used if rasterizeColliders is enabled.

PhysicsScene2D? physicsScene2D = null

The physics scene for collecting 2D colliders when scanning the graph.

If null (the default), the physics scene that the AstarPath component is part of will be used.

You typically don't have to set this, but it can be useful in some rare situations.

Only used if rasterizeColliders is enabled.

bool rasterizeColliders = true

Use colliders to calculate the navmesh.

Depending on the dimensionMode, either 3D or 2D colliders will be rasterized.

Sphere/Capsule/Circle colliders will be approximated using polygons, with the precision specified in colliderRasterizeDetail.

bool rasterizeMeshes

Use scene meshes to calculate the navmesh.

This can get you higher precision than colliders, since colliders are typically very simplified versions of the mesh. However, it is often slower to scan, and graph updates can be particularly slow.

The reason that graph updates are slower is that there's no efficient way to find all meshes that intersect a given tile, so the graph has to iterate over all meshes in the scene just to find the ones relevant for the tiles that you want to update. Colliders, on the other hand, can be efficiently queried using the physics system.

You can disable this and attach a RecastNavmeshModifier component (with dynamic=false) to all meshes that you want to be included in the navmesh instead. That way they will be able to be efficiently queried for, without having to iterate through all meshes in the scene.

In 2D mode, this setting has no effect.

bool rasterizeTerrain = true

Use terrains to calculate the navmesh.

In 2D mode, this setting has no effect.

bool rasterizeTrees = true

Rasterize tree colliders on terrains.

If the tree prefab has a collider, that collider will be rasterized. Otherwise a simple box collider will be used and the script will try to adjust it to the tree's scale, it might not do a very good job though so an attached collider is preferable.

In 2D mode, this setting has no effect.

List<string> tagMask = new List<string>()

Objects tagged with any of these tags will be rasterized.

Will only be used if collectionMode is set to Tags.

int terrainHeightmapDownsamplingFactor = 3

Controls how much to downsample the terrain's heightmap before generating the input mesh used for rasterization.

A higher value is faster to scan but less accurate.

FilterMode

Determines how the initial filtering of objects is done.