A* Pathfinding Project  4.1.19
The A* Pathfinding Project for Unity 3D
PathReturnQueue Class Reference

Public Member Functions

 PathReturnQueue (System.Object pathsClaimedSilentlyBy)
 
void Enqueue (Path path)
 
void ReturnPaths (bool timeSlice)
 Returns all paths in the return stack. More...
 

Private Attributes

Queue< PathpathReturnQueue = new Queue<Path>()
 Holds all paths which are waiting to be flagged as completed. More...
 
System.Object pathsClaimedSilentlyBy
 Paths are claimed silently by some object to prevent them from being recycled while still in use. More...
 

Constructor & Destructor Documentation

◆ PathReturnQueue()

PathReturnQueue ( System.Object  pathsClaimedSilentlyBy)

Member Function Documentation

◆ Enqueue()

void Enqueue ( Path  path)

◆ ReturnPaths()

void ReturnPaths ( bool  timeSlice)

Returns all paths in the return stack.

Paths which have been processed are put in the return stack. This function will pop all items from the stack and return them to e.g the Seeker requesting them.

Parameters
timeSliceDo not return all paths at once if it takes a long time, instead return some and wait until the next call.

Member Data Documentation

◆ pathReturnQueue

Queue<Path> pathReturnQueue = new Queue<Path>()
private

Holds all paths which are waiting to be flagged as completed.

See also
ReturnPaths

◆ pathsClaimedSilentlyBy

System.Object pathsClaimedSilentlyBy
private

Paths are claimed silently by some object to prevent them from being recycled while still in use.

This will be set to the AstarPath object.


The documentation for this class was generated from the following file: