Crate oxidized_navigation

Tiled Runtime Nav-mesh Generation for 3D worlds in Bevy.

Takes in Bevy Rapier3D colliders from entities with the NavMeshAffector component and asynchronously generates tiles of navigation meshes based on NavMeshSettings. Nav-meshes can then be queried using query::find_path.

Quick Start:

Nav-mesh generation:

1. Add OxidizedNavigationPlugin as a plugin.
2. Attach a NavMeshAffector component and a rapier collider to any entity you want to affect the nav-mesh.

At this point nav-meshes will be automatically generated whenever the collider or [GlobalTransform] of any entity with a NavMeshAffector is changed.

Querying the nav-mesh / Pathfinding:

1. Your system needs to take in the NavMesh resource.
2. Get the underlying data from the nav-mesh using NavMesh::get. This data is wrapped in an RwLock.
3. To access the data call RwLock::read. This will block until you get read acces on the lock. If a task is already writing to the lock it may take time.
4. Call query::find_path with the NavMeshTiles returned from the RwLock.

Also see the examples for how to run pathfinding in an async task which may be preferable.

Modules

• query
  Module for querying the nav-mesh.
• tiles

Structs

• NavMesh
  Wrapper around the nav-mesh data.
• NavMeshAffector
  Component for entities that should affect the nav-mesh.
• NavMeshAreaType
  Optional component to define the area type of an entity. Setting this to None means that the entity isn’t walkable.
• NavMeshSettings
  Settings for nav-mesh generation.
• OxidizedNavigationPlugin

Enums

• OxidizedNavigation
  System sets containing the crate’s systems.