Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

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

NavMeshAgent.CalculatePath

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

Submission failed

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

Close

Cancel

public method CalculatePath(targetPosition: Vector3, path: AI.NavMeshPath): bool;
public bool CalculatePath(Vector3 targetPosition, AI.NavMeshPath path);

Parameters

targetPositionThe final position of the path requested.
pathThe 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... } }
using UnityEngine;
using UnityEngine.AI;
using System.Collections;

public class ExampleClass : MonoBehaviour { public Transform target; private NavMeshAgent agent; void Start() { agent = GetComponent<NavMeshAgent>(); NavMeshPath path = new NavMeshPath(); agent.CalculatePath(target.position, path); if (path.status == NavMeshPathStatus.PathPartial) { } } }