Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

NavMeshAgent.ActivateCurrentOffMeshLink

Switch to Manual
ActivateCurrentOffMeshLink(activated: bool): void;

Parameters

activatedIs the link activated?

Description

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.

	private var agent: NavMeshAgent;

function Start () { agent = GetComponent.<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.currentOffMeshLinkData.offMeshLink.name)) { agent.ActivateCurrentOffMeshLink(true); } } }