Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetDestination(Vector3)

Sets or updates the destination thus triggering the calculation for a new path.
Read time 1 minuteLast updated 10 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine.AI
  • Assembly: UnityEngine.AIModule
public bool SetDestination(Vector3 target)

Parameters

target

Vector3
The target point to navigate to.

Returns

Type

Description

boolTrue if the destination was requested successfully, otherwise false.

Remarks

Note that the path may not become available until after a few frames later. While the path is being computed, _pathPending will be true. If a valid path becomes available then the agent will resume movement.

Examples

using UnityEngine;using UnityEngine.AI;public class Example : MonoBehaviour{    NavMeshAgent myNavMeshAgent;    void Start()    {        myNavMeshAgent = GetComponent<NavMeshAgent>();    }    void Update()    {        if (Input.GetMouseButtonDown(0))        {            SetDestinationToMousePosition();        }    }    void SetDestinationToMousePosition()    {        RaycastHit hit;        Ray ray = Camera.main.ScreenPointToRay(Input.mousePosition);        if (Physics.Raycast(ray, out hit))        {            myNavMeshAgent.SetDestination(hit.point);        }    }}