OffMeshLink

Info

OffMeshLink inherits from [Behaviour](/docs/create/lua/API/Behaviour/index.html)

Link allowing movement outside the planar navigation mesh.

Members

Properties

Name	Description
OffMeshLink.activated	Is link active.
OffMeshLink.area	NavMesh area index for this OffMeshLink component.
OffMeshLink.autoUpdatePositions	Automatically update endpoints.
OffMeshLink.biDirectional	Can link be traversed in both directions.
OffMeshLink.costOverride	Modify pathfinding cost for the link.
OffMeshLink.endTransform	The transform representing link end position.
OffMeshLink.occupied	Is link occupied. (Read Only)
OffMeshLink.startTransform	The transform representing link start position.

Methods

Name	Description
OffMeshLink.UpdatePositions()	Explicitly update the link endpoints.

Inherited Members

Inherited Properties

Name	Description
OffMeshLink.enabled	Enabled Behaviours are Updated, disabled Behaviours are not.
OffMeshLink.isActiveAndEnabled	Has the Behaviour had active and enabled called?
OffMeshLink.gameObject	The game object this component is attached to. A component is always attached to a game object.
OffMeshLink.tag	The tag of this game object.
OffMeshLink.transform	The Transform attached to this GameObject.
OffMeshLink.hideFlags	Should the object be hidden, saved with the Scene or modifiable by the user?
OffMeshLink.name	The name of the object.

Inherited Methods

Name	Description
OffMeshLink.BroadcastMessage(methodName, parameter=nil)	Calls the method named methodName on every Lua Script in this game object or any of its children.
OffMeshLink.CompareTag(tag)	Is this game object tagged with tag ?
OffMeshLink.GetAllLuaScripts()	Returns an array of all Lua scripts that attached to the game object.
OffMeshLink.GetComponent(type)	Returns the component of Type type if the game object has one attached, nil if it doesn't.
OffMeshLink.GetComponentInChildren(t)	Returns the component of Type type in the GameObject or any of its children using depth first search.
OffMeshLink.GetComponentInParent(t)	Returns the component of Type type in the GameObject or any of its parents.
OffMeshLink.GetComponents(type)	Returns all components of Type type in the GameObject.
OffMeshLink.GetComponentsInChildren(t)	Returns all components of Type type in the GameObject or any of its children.
OffMeshLink.GetComponentsInParent(t)	Returns all components of Type type in the GameObject or any of its parents.
OffMeshLink.SendMessage(methodName, value=nil)	Calls the method named methodName on every Lua Script in this game object.
OffMeshLink.SendMessageUpwards(methodName, value=nil)	Calls the method named methodName on every LuaScript in this game object and on every ancestor of the behaviour.
OffMeshLink.TryGetComponent(type)	Gets the component of the specified type, if it exists.
OffMeshLink.GetInstanceID()	Returns the instance id of the object.