Class AgentOffMeshLinkTraversalContext Extends ICloneable

void Abort (

bool

teleportToStart=true

If true, the agent will be teleported back to the start of the link (from the perspective of the agent). Its rotation will remain unchanged.

)

Aborts traversing the off-mesh link.

This will immediately stop your off-mesh link traversal coroutine.

This is useful if your agent was traversing an off-mesh link, but you have detected that it cannot continue. Maybe the ladder it was climbing was destroyed, or the bridge it was walking on collapsed.

AgentOffMeshLinkTraversalContext (

OffMeshLinks.OffMeshLinkConcrete

link

)

object Clone ()

void DisableLocalAvoidance ()

Disables local avoidance for the agent.

Agents that traverse links are already marked as 'unstoppable' by the local avoidance system, but calling this method will make other agents ignore them completely while traversing the link.

void DisableRotationSmoothing ()

Disables rotation smoothing for the agent.

This disables the effect of MovementSettings.rotationSmoothing while the agent is traversing the link. Having rotation smoothing enabled can make the agent rotate towards its target rotation more slowly, which is sometimes not desirable.

Rotation smoothing will automatically be restored when the agent finishes traversing the link (if it was enabled before).

The MoveTowards method automatically disables rotation smoothing when called.

MovementTarget MoveTowards (

float3	position	The position to move towards.
quaternion	rotation	The rotation to rotate towards.
bool	gravity	If true, gravity will be applied to the agent.
bool	slowdown	If true, the agent will slow down as it approaches the target.

)

Move towards a point while ignoring the navmesh.

This method should be called repeatedly until the returned MovementTarget.reached property is true.

void Restore ()

Restores the agent's settings to what it was before the link traversal started.

This undos the changes made by DisableLocalAvoidance and DisableRotationSmoothing.

This method is automatically called when the agent finishes traversing the link.

unsafe void SetInternalData (

Entity	entity
ref LocalTransform	transform
refAgentMovementPlane	movementPlane
refMovementControl	movementControl
refMovementSettings	movementSettings
refAgentOffMeshLinkTraversal	linkInfo
ManagedState	state
float	deltaTime

)

Internal method to set the data of the context.

This is used by the job system to set the data of the context. You should almost never need to use this.

void Teleport (

float3

position

)

Teleports the agent to the given position.

float deltaTime

Delta time since the last link simulation.

During high time scales, the simulation may run multiple substeps per frame.

This is not the same as Time.deltaTime. Inside the link coroutine, you should always use this field instead of Time.deltaTime.

Entity entity

The entity that is traversing the off-mesh link.

GameObject gameObject

GameObject associated with the agent.

In most cases, an agent is associated with an agent, but this is not always the case. For example, if you have created an entity without using the FollowerEntity component, this property may return null.

OffMeshLinks.OffMeshLinkTracer link

Information about the off-mesh link that the agent is traversing.

ManagedState managedState

Some internal state of the agent.

refMovementControl movementControl

How the agent should move.

The agent will move according to this data, every frame.

refNativeMovementPlane movementPlane

The plane in which the agent is moving.

In a 3D game, this will typically be the XZ plane, but in a 2D game it will typically be the XY plane. Games on spherical planets could have planes that are aligned with the surface of the planet.

refMovementSettings movementSettings

The movement settings for the agent.

ref LocalTransform transform

ECS LocalTransform component attached to the agent.

float backupRotationSmoothing = float.NaN

OffMeshLinks.OffMeshLinkConcrete concreteLink

The off-mesh link that is being traversed.

bool disabledRVO

GameObject gameObjectCache

unsafeAgentOffMeshLinkTraversal* linkInfoPtr

unsafeMovementControl* movementControlPtr

unsafeAgentMovementPlane* movementPlanePtr

unsafeMovementSettings* movementSettingsPtr

unsafe LocalTransform * transformPtr

AgentOffMeshLinkTraversal linkInfo

Information about the off-mesh link that the agent is traversing.