Interface IWorkItemContext Extends IGraphUpdateContext

void EnsureValidFloodFill ()

If a WorkItem needs to have a valid area information during execution, call this method to ensure there are no pending flood fills.

If you are using the Pathfinding.GraphNode.Area property or the Pathfinding.PathUtilities.IsPathPossible method in your work items, then you might want to call this method before you use them to ensure that the data is up to date.

AstarPath.active.AddWorkItem(new AstarWorkItem((IWorkItemContext ctx) => {
ctx.EnsureValidFloodFill();

// The above call guarantees that this method has up to date information about the graph
if (PathUtilities.IsPathPossible(someNode, someOtherNode)) {
// Do something
}
}));


void PreUpdate ()

Call to send a GraphModifier.EventType.PreUpdate event to all graph modifiers.

The difference between this and GraphModifier.TriggerEvent(GraphModifier.EventType.PreUpdate) is that using this method ensures that multiple PreUpdate events will not be issued during a single update.

Once an event has been sent no more events will be sent until all work items are complete and a PostUpdate or PostScan event is sent.

When scanning a graph PreUpdate events are never sent. However a PreScan event is always sent before a scan begins.

void SetGraphDirty (

NavGraph

graph

)

Trigger a graph modification event.

This will cause a GraphModifier.EventType.PostUpdate event to be issued after all graph updates have finished. Some scripts listen for this event. For example off-mesh links listen to it and will recalculate which nodes they are connected to when it it sent. If a graph is dirtied multiple times, or even if multiple graphs are dirtied, the event will only be sent once.

void DirtyBounds (

Bounds

bounds

)

Mark a particular region of the world as having been changed.

This should be used whenever graphs are changed.

This is used to recalculate off-mesh links that touch these bounds, and it will also ensure GraphModifier events are callled.

The bounding box should cover the surface of all nodes that have been updated. It is fine to use a larger bounding box than necessary (even an infinite one), though this may be slower, since more off-mesh links need to be recalculated. You can even use an infinitely large bounding box if you don't want to bother calculating a more accurate one. You can also call this multiple times to dirty multiple bounding boxes.

void QueueFloodFill ()

Call during work items to queue a flood fill.

An instant flood fill can be done via FloodFill() but this method can be used to batch several updates into one to increase performance. WorkItems which require a valid Flood Fill in their execution can call EnsureValidFloodFill to ensure that a flood fill is done if any earlier work items queued one.

Once a flood fill is queued it will be done after all WorkItems have been executed.