Skip to content

API > OffMeshLink

OffMeshLink⚓︎

OffMeshLink inherits from Behaviour

Link allowing movement outside the planar navigation mesh.

Members⚓︎

Properties⚓︎

Name Description
OffMeshLink.activatedProperty Is link active.
OffMeshLink.areaProperty NavMesh area index for this OffMeshLink component.
OffMeshLink.autoUpdatePositionsProperty Automatically update endpoints.
OffMeshLink.biDirectionalProperty Can link be traversed in both directions.
OffMeshLink.costOverrideProperty Modify pathfinding cost for the link.
OffMeshLink.endTransformProperty The transform representing link end position.
OffMeshLink.occupiedProperty Is link occupied. (Read Only)
OffMeshLink.startTransformProperty The transform representing link start position.

Methods⚓︎

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

Inherited Members⚓︎

Inherited Properties⚓︎

Name Description
OffMeshLink.enabledProperty Enabled Behaviours are Updated, disabled Behaviours are not.
OffMeshLink.isActiveAndEnabledProperty Has the Behaviour had active and enabled called?
OffMeshLink.gameObjectPropertyReadonly Property The game object this component is attached to. A component is always attached to a game object.
OffMeshLink.tagPropertyReadonly Property The tag of this game object.
OffMeshLink.transformPropertyReadonly Property The Transform attached to this GameObject.
OffMeshLink.hideFlagsProperty Should the object be hidden, saved with the Scene or modifiable by the user?
OffMeshLink.nameProperty The name of the object.

Inherited Methods⚓︎

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