Struct MovementState Extends IComponentData

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.

ushort flags

Bitmask for various flags.

PIDMovement.PersistentState followerState

State of the PID controller for the movement.

uint graphIndex

The index of the graph that the agent is currently traversing.

Will be GraphNode.InvalidGraphIndex if the agent has no path, or the node that the agent is traversing has been destroyed.

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.

This field is valid during all system updates in the AIMovementSystemGroup. It is not guaranteed to be valid after that group has finished running, as graph updates may have changed the graph.

bool isOnValidNode

True if the agent is currently on a valid node.

This is true if the agent has a path, and the node that the agent is traversing is walkable and not destroyed.

If false, the hierarchicalNodeIndex and graphIndex fields are invalid.

float3 nextCorner

The next corner in the path.

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.

float3 positionOffset

Offset from the agent's internal position to its visual position.

This is used when position smoothing is enabled. Otherwise it is zero.

bool? reachedDestination

True if the agent has reached its destination.

The destination will be considered reached if all of these conditions are met:

• The agent has a path

• 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 all of these conditions are met:

• 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 all of these conditions are met:

• The agent has a path

• 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 all of these conditions are met:

• The agent has a path

• 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 all of these conditions are met:

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

float rotationOffset2

An additional, purely visual, rotation offset.

This is used for rotation smoothing, but does not affect the movement of the agent.

bool? traversingLastPart

True if the agent is traversing the last part of the path.

If false, the agent will have to traverse at least one off-mesh link before it gets to its destination.

const int ReachedDestinationFlag = 1 << 0

const int ReachedEndOfPartFlag = 1 << 4

const int ReachedEndOfPathFlag = 1 << 2

const int TraversingLastPartFlag = 1 << 5

const int reachedDestinationAndOrientationFlag = 1 << 1

const int reachedEndOfPathAndOrientationFlag = 1 << 3