Class ManagedState Extends IComponentData, IDisposable, ICloneable

void CancelCurrentPathRequest ()

void ClearPath ()

void Dispose ()

void SetPath (

Path	path	The path to follow.
ManagedState	state
inAgentMovementPlane	movementPlane

)

Make the AI follow the specified path.

In case the path has not been calculated, the script will call seeker.StartPath to calculate it. This means the AI may not actually start to follow the path until in a few frames when the path has been calculated. The #pathPending field will as usual return true while the path is being calculated.

In case the path has already been calculated it will immediately replace the current path the AI is following. This is useful if you want to replace how the AI calculates its paths. Note that if you calculate the path using seeker.StartPath then this script will already pick it up because it is listening for all paths that the Seeker finishes calculating. In that case you do not need to call this function.

If you pass null as a parameter then the current path will be cleared and the agent will stop moving. Note than unless you have also disabled #canSearch then the agent will soon recalculate its path and start moving again.

You can disable the automatic path recalculation by setting the #canSearch field to false.

// Disable the automatic path recalculation
ai.canSearch = false;
var pointToAvoid = enemy.position;
// Make the AI flee from the enemy.
// The path will be about 20 world units long (the default cost of moving 1 world unit is 1000).
var path = FleePath.Construct(ai.position, pointToAvoid, 1000 * 20);
ai.SetPath(path);

// If you want to make use of properties like ai.reachedDestination or ai.remainingDistance or similar
// you should also set the destination property to something reasonable.
// Since the agent's own path recalculation is disabled, setting this will not affect how the paths are calculated.
// ai.destination = ...


AutoRepathPolicy autoRepath = new AutoRepathPolicy()

Settings for when to recalculate the path.

bool enableGravity = true

True if gravity is enabled for this agent.

The agent will always fall down according to its own movement plane. The gravity applied is Physics.gravity.y.

Enabling this will add the GravityState component to the entity.

bool enableLocalAvoidance

True if local avoidance is enabled for this agent.

Enabling this will automatically add a Pathfinding.ECS.RVO.RVOAgent component to the entity.

System.Func<AgentOffMeshLinkTraversalContext, System.Collections.IEnumerable> onTraverseOffMeshLink

Callback for when the agent starts to traverse an off-mesh link.

PathTracer pathTracer

Calculates in which direction to move to follow the path.

PathRequestSettings pathfindingSettings = PathRequestSettings.Default

Path pendingPath

Path that is being calculated, if any.

RVOAgent rvoAgent = RVOAgent.Default

Local avoidance settings.

When the agent has local avoidance enabled, these settings will be copied into a Pathfinding.ECS.RVO.RVOAgent component which is attached to the agent.

object System.ICloneable. Clone ()

Clones the managed state for when an entity is duplicated.

Some fields are cleared instead of being cloned, such as the pending path, which cannot reasonably be cloned.

object pendingPathBacking

Path that is being calculated, if any.

We need to store this as an object, as otherwise otherwise the ECS will unnecessarily complain about nested native components.