Overrides navmesh generation settings for a single mesh or collider.
Sometimes you want to tweak the RecastGraph on a per-object basis. For example you might want to make some objects completely unwalkable, or you might want to special case some objects to remove them from the navmesh altogether.
You can do this using the RecastNavmeshModifier component. Attach it to any object you want to modify and configure the settings as you wish.
Exclude an object from the graph's scan completely.
Ensure an object is included in the scan, even if it would normally be excluded.
Make the surfaces of an object unwalkable.
Make the surfaces of an object walkable (this is just the default behavior).
Create seams in the navmesh between adjacent objects.
Mark the surfaces of an object with a specific tag (see Working with tags).
Adding this component to an object will make sure it is included in any recast graphs. It will be included even if the Rasterize Meshes toggle is set to false.
If you are using the Rasterize Meshes option on the recast graph, and you are updating the graph during runtime, then disabling it and attaching RecastNavmeshModifiers (with dynamic set to false) to the objects you want to rasterize can be good for performance. This is because it's not possible to find meshes in the scene efficiently in Unity, so every time even a small part of the graph is updated, it has to search all meshes in the scene for ones to rasterize. This can be slow if you have a lot of meshes in the scene. RecastNavmeshModifiers are stored in a tree for extremely fast lookup (O(log n + k) compared to O(n) where n is the number of meshes in your scene and k is the number of meshes which should be rasterized, if you know Big-O notation. But as always, profile before you optimize.
Note
If dynamic is false, then the object is not allowed to move. If it does, the internal lookup tree will be incorrect and the graph may not be updated correctly.
Fills the buffer with all RecastNavmeshModifiers which intersect the specified bounds.
Public Variables
dynamic
Enable if the object will move during runtime.
Public
bool
dynamic = true
Enable if the object will move during runtime.
If disabled, the object will be assumed to stay in the same position, and keep the same size, until the component is disabled or destroyed.
Disabling this will provide a small performance boost when doing graph updates, as the graph no longer has to check if this RecastNavmeshModifier might have moved.
Even you set dynamic=false, you can disable the component, move the object, and enable it at the new position.
If true then the mesh will be treated as solid and its interior will be unwalkable.
Public
bool
solid = false
If true then the mesh will be treated as solid and its interior will be unwalkable.
The unwalkable region will be the minimum to maximum y coordinate in each cell.
If you enable this on a mesh that is actually hollow then the hollow region will also be treated as unwalkable.
surfaceID
Voxel area for mesh.
Public
int
surfaceID = 1
Voxel area for mesh.
This area (not to be confused with pathfinding areas, this is only used when rasterizing meshes for the recast graph) field can be used to explicitly insert edges in the navmesh geometry or to make some parts of the mesh unwalkable.
When rasterizing the world and two objects with different surface id values are adjacent to each other, a split in the navmesh geometry will be added between them, characters will still be able to walk between them, but this can be useful when working with navmesh updates.
Navmesh updates which recalculate a whole tile (updatePhysics=True) are very slow So if there are special places which you know are going to be updated quite often, for example at a door opening (opened/closed door) you can use surface IDs to create splits on the navmesh for easier updating using normal graph updates (updatePhysics=False). See the below video for more information.
When mode is set to Mode.WalkableSurfaceWithTag then this value will be interpreted as a pathfinding tag. See Working with tags.
Note
This only has an effect if mode is set to Mode.WalkableSurfaceWithSeam or Mode.WalkableSurfaceWithTag.
Only non-negative values are valid.
Public Enums
GeometrySource
Source of geometry when voxelizing this object.
Public
GeometrySource
Auto
Uses the MeshFilter component on this GameObject if available, otherwise uses the collider.
MeshFilter
Always uses the MeshFilter component on this GameObject.
Collider
Always uses the Collider on this GameObject.
Source of geometry when voxelizing this object.
Mode
Public
Mode
UnwalkableSurface= 1
All surfaces on this mesh will be made unwalkable.
WalkableSurface
All surfaces on this mesh will be walkable.
WalkableSurfaceWithSeam
All surfaces on this mesh will be walkable and a seam will be created between the surfaces on this mesh and the surfaces on other meshes (with a different surface id)
WalkableSurfaceWithTag
All surfaces on this mesh will be walkable and the nodes will be given the specified tag.
A seam will be created between the surfaces on this mesh and the surfaces on other meshes (with a different tag or surface id)
ScanInclusion
Public
ScanInclusion
Auto
Includes or excludes the object as normal based on the recast graph's layer mask and tag mask.
This area (not to be confused with pathfinding areas, this is only used when rasterizing meshes for the recast graph) field can be used to explicitly insert edges in the navmesh geometry or to make some parts of the mesh unwalkable.
When rasterizing the world and two objects with different surface id values are adjacent to each other, a split in the navmesh geometry will be added between them, characters will still be able to walk between them, but this can be useful when working with navmesh updates.
Navmesh updates which recalculate a whole tile (updatePhysics=True) are very slow So if there are special places which you know are going to be updated quite often, for example at a door opening (opened/closed door) you can use surface IDs to create splits on the navmesh for easier updating using normal graph updates (updatePhysics=False). See the below video for more information.
