Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

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

NavMeshAgent.CalculatePath

Switch to Manual
public function CalculatePath(targetPosition: Vector3, path: NavMeshPath): bool;

Parameters

targetPosition The final position of the path requested.
path The resulting path.

Returns

bool True if a path is found.

Description

Calculate a path to a specified point and store the resulting path.

This function can be used to plan a path ahead of time to avoid a delay in gameplay when the path is needed. Another use is to check if a target position is reachable before moving the agent.

	var target: Transform;

	private var agent: NavMeshAgent;

	function Start () {
		agent = GetComponent.<NavMeshAgent>();
		var path: NavMeshPath;
		agent.CalculatePath(target.position, path);
		
		if (path.status == NavMeshPathStatus.PathPartial) {
			// The target cannot be reached...
		}
	}