Version: 2021.3
LanguageEnglish
  • C#

NavMeshLinkData

struct in UnityEngine.AI

/

Implemented in:UnityEngine.AIModule

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

Description

Used for runtime manipulation of links connecting polygons of the NavMesh.

A typical use case is to connect different navigation meshes. The link is described by the NavMeshLinkData struct. The NavMesh Link is the scripting equivalent of the class-OffMeshLink component – but allows for wide links as opposed to just points.

Properties

agentTypeIDSpecifies which agent type this link is available for.
areaArea type of the link.
bidirectionalIf true, the link can be traversed in both directions, otherwise only from start to end position.
costModifierIf positive, overrides the pathfinder cost to traverse the link.
endPositionEnd position of the link.
startPositionStart position of the link.
widthIf positive, the link will be rectangle aligned along the line from start to end.