Class Path Extends IPathInternals

Public Abstract

Base class for all path types.

Public Methods

BlockUntilCalculated ()

Blocks until this path has been calculated and returned.

Public
CanTraverse (node)

Returns if the node can be traversed.

Public
CanTraverse (from, to)

Returns if the path can traverse a link between from and to and if to can be traversed itself.

Public
Claim (o)

Claim this path (pooling).

Public
Error ()

Aborts the path because of an error.

Public
FailWithError (msg)

Causes the path to fail and sets errorLog to msg.

Public
GetConnectionSpecialCost (a, b, currentCost)

May be called by graph nodes to get a special cost for some connections.

Public
GetTagPenalty (tag)

Returns penalty for the given tag.

Public
GetTotalLength ()

Total Length of the path.

Public
GetTraversalCost (node)

Returns the cost of traversing the given node.

Public
IsDone ()

True if this path is done calculating.

Public
Release (o, silent=…)

Releases a path claim (pooling).

Public
WaitForPath ()

Waits until this path has been calculated and returned.

Public

Public Variables

CompleteState

Current state of the path.

Public
FloodingPath

True for paths that want to search all nodes and not jump over nodes as optimizations.

Public
PipelineState

Returns the state of the path in the pathfinding pipeline.

Public
callback

Callback to call when the path is complete.

Public
duration

How long it took to calculate this path in milliseconds.

Public
enabledTags

Which graph tags are traversable.

Public
error

If the path failed, this is true.

Public
errorLog

Additional info on why a path failed.

Public
heuristic

Determines which heuristic to use.

Public
heuristicScale

Scale of the heuristic values.

Public
immediateCallback

Immediate callback to call when the path is complete.

Public
nnConstraint

Constraint for how to search for nodes.

Public
path

Holds the path as a Node array.

Public
pathID

ID of this path.

Public
searchedNodes

Number of nodes this path has searched.

Public
tagPenalties

Penalties for each tag.

Public
traversalProvider

Provides additional traversal information to a path request.

Public
vectorPath

Holds the (possibly post processed) path as a Vector3 list.

Public

Private/Protected Members

AdvanceState (s)

Threadsafe increment of the state.

Private
CalculateHScore (node)

Estimated cost from the specified node to the target.

Internal
CalculateStep (targetTick)

Calculates the until it is complete or the time has progressed past targetTick.

Protected Abstract
CalculateStep (targetTick)
Private
Cleanup ()

Always called after the path has been calculated.

Protected
Cleanup ()
Private
DebugString (logMode)

Returns a string with information about it.

Protected
DebugString (logMode)
Private
DebugStringPrefix (logMode, text)

Writes text shared for all overrides of DebugString to the string builder.

Protected
DebugStringSuffix (logMode, text)

Writes text shared for all overrides of DebugString to the string builder.

Protected
ErrorCheck ()

Performs some error checking.

Private
GetHTarget ()
Protected
Initialize ()

Initializes the path.

Protected Abstract
Initialize ()
Private
OnEnterPool ()

Called when the path enters the pool.

Protected
OnEnterPool ()
Private
PathHandler
Private
Pooled

True if the path is currently pooled.

Private
Prepare ()

Called before the path is started.

Protected Abstract
Prepare ()
Private
PrepareBase (pathHandler)

Prepares low level path variables for calculation.

Protected
PrepareBase (handler)
Private
Reset ()

Reset all values to their default values.

Protected
Reset ()
Private
ReturnPath ()

Calls callback to return the calculated path.

Protected
ReturnPath ()
Private
Trace (from)

Traces the calculated path from the end node to the start.

Protected
ZeroTagPenalties

List of zeroes to use as default tag penalties.

Internal Static Readonly
claimed

List of claims on this path with reference objects.

Private
completeState

Backing field for CompleteState.

Protected
currentR

The node currently being processed.

Protected
hTarget

Target to use for H score calculations.

Protected
hTargetNode

Target to use for H score calculation.

Protected
hasBeenReset

True if the Reset function has been called.

Protected
internalTagPenalties

The tag penalties that are actually used.

Protected
manualTagPenalties

Tag penalties set by other scripts.

Protected
next

Internal linked list implementation.

Internal
pathHandler

Data for the thread calculating this path.

Protected
releasedNotSilent

True if the path has been released with a non-silent call yet.

Private
stateLock
Private

Deprecated Members

GetState ()

State of the path in the pathfinding pipeline.

Public
Log (msg)

Appends a message to the errorLog.

Protected
LogError (msg)

Logs an error.

Protected
ReleaseSilent (o)

Releases the path silently (pooling).

Internal
recycled

True if the path is currently recycled (i.e in the path pool).

Internal