Version: 2017.3 (switch to 2017.4)
  • C#
  • JS

Script language

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


Suggest a change


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.


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.



public method ActivateCurrentOffMeshLink(activated: bool): void;
public void ActivateCurrentOffMeshLink(bool activated);


activated Is the link activated?


Enables or disables the current off-mesh link.

This function activates or deactivates the off-mesh link where the agent is currently waiting. This is useful for granting access to newly discovered areas of the game world or simulating the creation or removal of an obstacle to an area.

#pragma strict

private var agent: UnityEngine.AI.NavMeshAgent;

function Start () { agent = GetComponent.<UnityEngine.AI.NavMeshAgent>(); }

// Allow all agents to have access to an area once it has officially // been "discovered". function OpenDiscoveredArea(areasDiscovered: Hashtable) { if (agent.isOnOffMeshLink) { if (areasDiscovered.ContainsKey( { agent.ActivateCurrentOffMeshLink(true); } } }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { private AI.NavMeshAgent agent; void Start() { agent = GetComponent<AI.NavMeshAgent>(); } void OpenDiscoveredArea(Hashtable areasDiscovered) { if (agent.isOnOffMeshLink) if (areasDiscovered.ContainsKey( agent.ActivateCurrentOffMeshLink(true); } }

Did you find this page useful? Please give it a rating: