Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

NavMesh.pathfindingIterationsPerFrame

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public static var pathfindingIterationsPerFrame: int;
public static int pathfindingIterationsPerFrame;

Description

The maximum amount of nodes processed each frame in the asynchronous pathfinding process.

The pathfinder expands only a certain amount of nodes (NavMesh polygons) each frame while doing path finding. This allows the game to run smoothly without hiccups when long paths or large number of request are being processed at the same time, the flip side is that it can take number of frames for a path request to complete.

The iteration count only affects asyncronous pathfinding which used when setting NavMesh Agent destination using NavMeshAgent.SetDestination or NavMeshAgent.destination.

Increasing this value will cause the paths to be processed faster, but can cause some hiccups in frame rate. Default value is 100, a good range for tuning is between 50 and 500.