Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


IsLinkActive(NavMeshLinkInstance)

Determines whether the instance of the link can be used to calculate paths, and if NavMesh agents can move over it.
Read time 1 minuteLast updated 11 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine.AI
  • Assembly: UnityEngine.AIModule
public static bool IsLinkActive(NavMeshLinkInstance handle)

Parameters

The link instance whose state to query.

Returns

Type

Description

boolTrue if agents can plan paths through, and traverse, this instance of the link, otherwise false.

Remarks

Use this method to determine if paths for the assigned agent type can traverse this link or not.
A link instance is active by default regardless of whether the ends connect to NavMesh surfaces or not. To change the link's state, call NavMesh.SetLinkActive. After you remove the link from the running navigation system this method always returns
false
.
This method is available as of 2023.2.
Additional Resources: NavMesh.SetLinkActive