Up to date

This page is up to date for Godot 4.1. If you still find outdated information, please open an issue.

Support different actor types

../../_images/nav_actor_sizes.png

To support different actor types due to e.g. their sizes each type requires its own navigation map and navigation mesh baked with an appropriated agent radius and height. The same approach can be used to distinguish between e.g. landwalking, swimming or flying agents.

Note

Agents are exclusively defined by a radius and height value for baking navigation meshes, pathfinding and avoidance. More complex shapes are not supported.

GDScript

  1. # Create a navigation mesh resource for each actor size.
  2. var navigation_mesh_standard_size: NavigationMesh = NavigationMesh.new()
  3. var navigation_mesh_small_size: NavigationMesh = NavigationMesh.new()
  4. var navigation_mesh_huge_size: NavigationMesh = NavigationMesh.new()
  6. # Set appropriated agent parameters.
  7. navigation_mesh_standard_size.agent_radius = 0.5
  8. navigation_mesh_standard_size.agent_height = 1.8
  9. navigation_mesh_small_size.agent_radius = 0.25
  10. navigation_mesh_small_size.agent_height = 0.7
  11. navigation_mesh_huge_size.agent_radius = 1.5
  12. navigation_mesh_huge_size.agent_height = 2.5
  14. # Get the root node to parse geometry for the baking.
  15. var root_node: Node3D = get_node("NavigationMeshBakingRootNode")
  17. # Create the source geometry resource that will hold the parsed geometry data.
  18. var source_geometry_data: NavigationMeshSourceGeometryData3D = NavigationMeshSourceGeometryData3D.new()
  20. # Parse the source geometry from the SceneTree on the main thread.
  21. # The navigation mesh is only required for the parse settings so any of the three will do.
  22. NavigationServer3D.parse_source_geometry_data(navigation_mesh_standard_size, source_geometry_data, root_node)
  24. # Bake the navigation geometry for each agent size from the same source geometry.
  25. # If required for performance this baking step could also be done on background threads.
  26. NavigationServer3D.bake_from_source_geometry_data(navigation_mesh_standard_size, source_geometry_data)
  27. NavigationServer3D.bake_from_source_geometry_data(navigation_mesh_small_size, source_geometry_data)
  28. NavigationServer3D.bake_from_source_geometry_data(navigation_mesh_huge_size, source_geometry_data)
  30. # Create different navigation maps on the NavigationServer.
  31. var navigation_map_standard: RID = NavigationServer3D.map_create()
  32. var navigation_map_small: RID = NavigationServer3D.map_create()
  33. var navigation_map_huge: RID = NavigationServer3D.map_create()
  35. # Set the new navigation maps as active.
  36. NavigationServer3D.map_set_active(navigation_map_standard, true)
  37. NavigationServer3D.map_set_active(navigation_map_small, true)
  38. NavigationServer3D.map_set_active(navigation_map_huge, true)
  40. # Create a region for each map.
  41. var navigation_region_standard: RID = NavigationServer3D.region_create()
  42. var navigation_region_small: RID = NavigationServer3D.region_create()
  43. var navigation_region_huge: RID = NavigationServer3D.region_create()
  45. # Add the regions to the maps.
  46. NavigationServer3D.region_set_map(navigation_region_standard, navigation_map_standard)
  47. NavigationServer3D.region_set_map(navigation_region_small, navigation_map_small)
  48. NavigationServer3D.region_set_map(navigation_region_huge, navigation_map_huge)
  50. # Set navigation mesh for each region.
  51. NavigationServer3D.region_set_navigation_mesh(navigation_region_standard, navigation_mesh_standard_size)
  52. NavigationServer3D.region_set_navigation_mesh(navigation_region_small, navigation_mesh_small_size)
  53. NavigationServer3D.region_set_navigation_mesh(navigation_region_huge, navigation_mesh_huge_size)
  55. # Create start and end position for the navigation path query.
  56. var start_pos: Vector3 = Vector3(0.0, 0.0, 0.0)
  57. var end_pos: Vector3 = Vector3(2.0, 0.0, 0.0)
  58. var use_corridorfunnel: bool = true
  60. # Query paths for each agent size.
  61. var path_standard_agent = NavigationServer3D.map_get_path(navigation_map_standard, start_pos, end_pos, use_corridorfunnel)
  62. var path_small_agent = NavigationServer3D.map_get_path(navigation_map_small, start_pos, end_pos, use_corridorfunnel)
  63. var path_huge_agent = NavigationServer3D.map_get_path(navigation_map_huge, start_pos, end_pos, use_corridorfunnel)