Class PathProcessor

void AbortThreads ()

Calls 'Abort' on each of the threads.

void DestroyNode (

GraphNode

node

)

Destroyes the given node.

This is to be called after the node has been disconnected from the graph so that it cannot be reached from any other nodes. It should only be called during graph updates, that is when the pathfinding threads are either not running or paused.

int GetNewNodeIndex ()

Returns a new global node index.

void InitializeNode (

GraphNode

node

)

Initializes temporary path data for a node.

void JoinThreads ()

Calls 'Join' on each of the threads to block until they have completed.

GraphUpdateLock PausePathfinding (

bool

block

If true, this call will block until all pathfinding threads are paused. otherwise the threads will be paused as soon as they are done with what they are currently doing.

)

Prevents pathfinding threads from starting to calculate any new paths.

void TickNonMultithreaded ()

bool IsUsingMultithreading

Returns whether or not multithreading is used.

int NumThreads

Number of parallel pathfinders.

Returns the number of concurrent processes which can calculate paths at once. When using multithreading, this will be the number of threads, if not using multithreading it is always 1 (since only 1 coroutine is used).

System.Action<Path> OnPathPostSearch

Called after every path request.

May be called from a separate thread

System.Action<Path> OnPathPreSearch

Called before every path request.

May be called from a separate thread

System.Action OnQueueUnblocked

AstarPath astar

Reference to main AstarPath object.

IEnumerator CalculatePaths (

PathHandler

pathHandler

)

Main pathfinding method.

This method will calculate the paths in the pathfinding queue.

void CalculatePathsThreaded (

PathHandler

pathHandler

)

Main pathfinding method (multithreaded).

This method will calculate the paths in the pathfinding queue when multithreading is enabled.

int Lock (

bool

block

)

List<int> locks = new List<int>()

int nextLockID = 0

int nextNodeIndex = 1

Holds the next node index which has not been used by any previous node.

Stack<int> nodeIndexPool = new Stack<int>()

Holds indices for nodes that have been destroyed.

To avoid trashing a lot of memory structures when nodes are frequently deleted and created, node indices are reused.

PathHandler[] pathHandlers

PathProcessor (

AstarPath	astar	Uses settings from this AstarPath object
PathReturnQueue	returnQueue	When paths are completed, they will be pushed to this queue
int	processors	The specified number of threads to use. If multithreaded is false, this value must be at most 1 and then it will run on the main Unity thread.
bool	multithreaded	Whether to use multithreading or not
IPathHandlerProvider	pathHandlerProvider	Allows using a different PathHandler than the standard one. For example used for cooperative pathfinding (Pathfinding.Cooperative.CooperativeContext)

)

Creates a new path processor.

ThreadControlQueue queue

Queue for paths waiting to be calculated.

PathReturnQueue returnQueue

Queue to which completed paths will be added.

IEnumerator threadCoroutine

When no multithreading is used, the IEnumerator is stored here.

When no multithreading is used, a coroutine is used instead. It is not directly called with StartCoroutine but a separate function has just a while loop which increments the main IEnumerator. This is done so other functions can step the thread forward at any time, without having to wait for Unity to update it.

Thread[] threads

References to each of the pathfinding threads.

void Unlock (

int

id

)