Struct MovementState Extends IComponentData

void SetPathIsEmpty (

UnityEngine.Vector3

agentPosition

)

Sets the appropriate fields to indicate that the agent has no path.

float3 closestOnNavmesh

The closest point on the navmesh to the agent.

The agent will be snapped to this point.

float3 endOfPath

The end of the current path.

Note that the agent may be heading towards an off-mesh link which is not the same as this point.

PIDMovement.PersistentState followerState

State of the PID controller for the movement.

int hierarchicalNodeIndex

The index of the hierarchical node that the agent is currently in.

Will be -1 if the hierarchical node index is not known.

float3 nextCorner

The next corner in the path.

bool pathIsStale

True if the path needs to be recalculated as quickly as possible.

This can happen if the agent is teleported, or if some nodes in the graph have changed or been destroyed.

ushort pathTracerVersion

Version number of PathTracer.version when the movement state was last updated.

In particular, closestOnNavmesh, nextCorner, endOfPath, remainingDistanceToEndOfPart, reachedDestination and reachedEndOfPath will only be considered up to date if this is equal to the current version number of the path tracer.

bool reachedDestination

True if the agent has reached its destination.

The destination will be considered reached if:

• The path is not stale

• The destination is not significantly below the agent's feet.

• The destination is not significantly above the agent's head.

• The agent is on the last part of the path (there are no more remaining off-mesh links).

• The remaining distance to the end of the path + the distance from the end of the path to the destination is less than MovementSettings.stopDistance.

bool reachedDestinationAndOrientation

True if the agent has reached its destination and is facing the desired orientation.

This will become true if:

• reachedDestination is true

• The agent is facing the desired facing direction as specified in DestinationPoint.facingDirection.

bool reachedEndOfPart

True if the agent has reached the end of the current part in the path.

The end of the current part will be considered reached if:

• The path is not stale

• The end of the current part is not significantly below the agent's feet.

• The end of the current part is not significantly above the agent's head.

• The remaining distance to the end of the part is not significantly larger than the agent's radius.

bool reachedEndOfPath

True if the agent has reached the end of the path.

The end of the path will be considered reached if:

• The path is not stale

• The end of the path is not significantly below the agent's feet.

• The end of the path is not significantly above the agent's head.

• The agent is on the last part of the path (there are no more remaining off-mesh links).

• The remaining distance to the end of the path is less than MovementSettings.stopDistance.

bool reachedEndOfPathAndOrientation

True if the agent has reached its destination and is facing the desired orientation.

This will become true if:

• reachedEndOfPath is true

• The agent is facing the desired facing direction as specified in DestinationPoint.facingDirection.

float remainingDistanceToEndOfPart

The remaining distance until the end of the path, or the next off-mesh link.

float rotationOffset

The current additional rotation that is applied to the agent.

This is used by the local avoidance system to rotate the agent, without this causing a feedback loop.