Skip to main content

OffMeshLink

info

OffMeshLink inherits from Behaviour

Link allowing movement outside the planar navigation mesh.

Members

Properties

NameDescription
OffMeshLink.activatedIs link active.
OffMeshLink.areaNavMesh area index for this OffMeshLink component.
OffMeshLink.autoUpdatePositionsAutomatically update endpoints.
OffMeshLink.biDirectionalCan link be traversed in both directions.
OffMeshLink.costOverrideModify pathfinding cost for the link.
OffMeshLink.endTransformThe transform representing link end position.
OffMeshLink.occupiedIs link occupied. (Read Only)
OffMeshLink.startTransformThe transform representing link start position.

Methods

NameDescription
OffMeshLink.UpdatePositions()Explicitly update the link endpoints.

Inherited Members

Inherited Properties

NameDescription
OffMeshLink.enabledEnabled Behaviours are Updated, disabled Behaviours are not.
OffMeshLink.isActiveAndEnabledHas the Behaviour had active and enabled called?
OffMeshLink.gameObjectThe game object this component is attached to. A component is always attached to a game object.
OffMeshLink.tagThe tag of this game object.
OffMeshLink.transformThe Transform attached to this GameObject.
OffMeshLink.hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
OffMeshLink.nameThe name of the object.

Inherited Methods

NameDescription
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.