A* Pathfinding Project  3.8
The A* Pathfinding Project for Unity 3D
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Events Macros Groups Pages
CustomPath Class Reference

Public Member Functions

 CustomPath (Vector3 start, Vector3 end, OnPathDelegate callbackDelegate)
- Public Member Functions inherited from ABPath
override void CalculateStep (long targetTick)
 Calculates the path until completed or until the time has passed targetTick.
override void Cleanup ()
 Always called after the path has been calculated.
override string DebugString (PathLog logMode)
 Returns a debug string for this path.
override uint GetConnectionSpecialCost (GraphNode a, GraphNode b, uint currentCost)
 May be called by graph nodes to get a special cost for some connections.
Vector3 GetMovementVector (Vector3 point)
 Returns in which direction to move from a point on the path.
override void Initialize ()
 Initializes the path.
override void Prepare ()
 Prepares the path.
override void Reset ()
 Reset all values to their default values.
void ResetCosts (Path p)
 Resets End Node Costs.
 ABPath ()
 Default constructor.
- Public Member Functions inherited from Path
void AdvanceState (PathState s)
 Threadsafe increment of the state.
uint CalculateHScore (GraphNode node)
 Estimated cost from the specified node to the target.
bool CanTraverse (GraphNode node)
 Returns if the node can be traversed.
void Claim (System.Object o)
 Claim this path (pooling).
void Error ()
 Aborts the path because of an error.
void ForceLogError (string msg)
 Logs an error and calls Error().
Int3 GetHTarget ()
PathState GetState ()
 Returns the state of the path in the pathfinding pipeline.
uint GetTagPenalty (int tag)
 Returns penalty for the given tag.
float GetTotalLength ()
 Total Length of the path.
uint GetTraversalCost (GraphNode node)
bool IsDone ()
 Returns if this path is done calculating.
void Log (string msg)
 Appends a message to the errorLog.
void LogError (string msg)
 Appends msg to errorLog and logs msg to the console.
virtual void OnEnterPool ()
 Called when the path enters the pool.
void Release (System.Object o, bool silent=false)
 Releases a path claim (pooling).
void ReleaseSilent (System.Object o)
 Releases the path silently (pooling).
virtual void ReturnPath ()
 Calls callback to return the calculated path.
IEnumerator WaitForPath ()
 Waits until this path has been calculated and returned.

Public Attributes

float penaltyMultiplier = 1F
- Public Attributes inherited from ABPath
bool calculatePartial
 Calculate partial path if the target node cannot be reached.
GraphNode endHint
 Hints can be set to enable faster Get Nearest Node queries.
GraphNode endNode
 End node of the path.
Vector3 endPoint
 End point of the path.
Vector3 originalEndPoint
 End Point exactly as in the path request.
Vector3 originalStartPoint
 Start Point exactly as in the path request.
bool recalcStartEndCosts = true
 Defines if start and end nodes will have their connection costs recalculated for this path.
GraphNode startHint
 Hints can be set to enable faster Get Nearest Node queries.
Int3 startIntPoint
 Start point in integer coordinates.
GraphNode startNode
 Start node of the path.
Vector3 startPoint
 Start point of the path.
- Public Attributes inherited from Path
OnPathDelegate callback
 Callback to call when the path is complete.
float duration
 The duration of this path in ms.
int enabledTags = -1
 Which graph tags are traversable.
Heuristic heuristic
 Determines which heuristic to use.
float heuristicScale = 1F
 Scale of the heuristic values.
OnPathDelegate immediateCallback
 Immediate callback to call when the path is complete.
NNConstraint nnConstraint = PathNNConstraint.Default
 Constraint for how to search for nodes.
List< GraphNodepath
 Holds the path as a Node array.
int searchedNodes
 Number of nodes this path has searched.
int searchIterations
 The number of frames/iterations this path has executed.
List< Vector3 > vectorPath
 Holds the (perhaps post processed) path as a Vector3 list.

Additional Inherited Members

- Static Public Member Functions inherited from ABPath
static ABPath Construct (Vector3 start, Vector3 end, OnPathDelegate callback=null)
 Construct a path with a start and end point.
- Protected Member Functions inherited from ABPath
virtual void CompletePathIfStartIsValidTarget ()
 Checks if the start node is the target and complete the path if that is the case.
void UpdateStartEnd (Vector3 start, Vector3 end)
 Sets the start and end points.
void Setup (Vector3 start, Vector3 end, OnPathDelegate callbackDelegate)
- Protected Attributes inherited from ABPath
int[] endNodeCosts
 Saved original costs for the end node.
PathNode partialBestTarget
 Current best target for the partial path.
- Package Functions inherited from Path
void PrepareBase (PathHandler pathHandler)
 Prepares low level path variables for calculation.
- Package Attributes inherited from Path
Path next
 Internal linked list implementation.
bool pooled
 True if the path is currently pooled.
- Properties inherited from ABPath
virtual bool hasEndPoint [get]
 Determines if a search for an end node should be done.

Constructor & Destructor Documentation

CustomPath ( Vector3  start,
Vector3  end,
OnPathDelegate  callbackDelegate 

Member Data Documentation

float penaltyMultiplier = 1F

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