Interface IOffMeshLinkStateMachine

void OnAbortTraversingOffMeshLink ()

Called when an agent fails to finish traversing an off-mesh link.

This can be used to perform any cleanup that is necessary after the traversal.

An abort can happen if the agent was destroyed while it was traversing the link. It can also happen if the agent was teleported somewhere else while traversing the link.

Either OnFinishTraversingOffMeshLink or OnAbortTraversingOffMeshLink will be called, but not both.

void OnFinishTraversingOffMeshLink (

ECS.AgentOffMeshLinkTraversalContext

context

Context for the traversal. Provides information about the link and the agent, as well as some helper methods for movement. This context is only valid for this method call. Do not store it and use it later.

)

Called when an agent finishes traversing an off-mesh link.

This can be used to perform any cleanup that is necessary after the traversal.

Either OnFinishTraversingOffMeshLink or OnAbortTraversingOffMeshLink will be called, but not both.

System.Collections.IEnumerable OnTraverseOffMeshLink (

ECS.AgentOffMeshLinkTraversalContext

context

Context for the traversal. Provides information about the link and the agent, as well as some helper methods for movement. This context is only valid when this coroutine steps forward. Do not store it and use it elsewhere.

)

Called when an agent traverses an off-mesh link.

This method should be a coroutine (i.e return an IEnumerable) which will be iterated over until it finishes, or the agent is destroyed. The coroutine should yield null every frame until the agent has finished traversing the link.

When the coroutine completes, the agent will be assumed to have reached the end of the link and control will be returned to the normal movement code.

The coroutine typically moves the agent to the end of the link over some time, and perform any other actions that are necessary. For example, it could play an animation, or move the agent in a specific way.