Struct MovementSettings Extends IComponentData

PIDMovement.DebugFlags debugFlags

Flags for enabling debug rendering in the scene view.

PIDMovement follower

Additional movement settings.

LayerMask groundMask

Layer mask to use for ground placement.

Make sure this does not include the layer of any colliders attached to this gameobject.

bool isStopped

Gets or sets if the agent should stop moving.

If this is set to true the agent will immediately start to slow down as quickly as it can to come to a full stop. The agent will still react to local avoidance and gravity (if applicable), but it will not try to move in any particular direction.

The current path of the agent will not be cleared, so when this is set to false again the agent will continue moving along the previous path.

This is a purely user-controlled parameter, so for example it is not set automatically when the agent stops moving because it has reached the target. Use reachedEndOfPath for that.

If this property is set to true while the agent is traversing an off-mesh link (RichAI script only), then the agent will continue traversing the link and stop once it has completed it.

The steeringTarget property will continue to indicate the point which the agent would move towards if it would not be stopped.

MovementPlaneSource movementPlaneSource

How to calculate which direction is "up" for the agent.

float positionSmoothing

float rotationSmoothing

How much to smooth the visual rotation of the agent.

This does not affect movement, but smoothes out how the agent rotates visually.

Recommended values are between 0.0 and 0.5. A value of zero will disable smoothing completely.

The smoothing is done primarily using an exponential moving average, but with a small linear term to make the rotation converge faster when the agent is almost facing the desired direction.

Adding smoothing will make the visual rotation of the agent lag a bit behind the actual rotation. Too much smoothing may make the agent seem sluggish, and appear to move sideways.

The unit for this field is seconds.

float stopDistance

How far away from the destination should the agent aim to stop, in world units.

If the agent is within this distance from the destination point it will be considered to have reached the destination.

Even if you want the agent to stop precisely at a given point, it is recommended to keep this slightly above zero. If it is exactly zero, the agent may have a hard time deciding that it has actually reached the end of the path, due to floating point errors and such.