Class ABPath Extends Path

Public

Basic path, finds the shortest path from A to B.

This is the most basic path object it will try to find the shortest path between two points.
Many other path types inherit from this type.

Public Methods

ABPath ()

Default constructor.

Public

Public Static Methods

Construct (start, end, callback=null)

Construct a path with a start and end point.

Public Static

Public Variables

calculatePartial

Calculate partial path if the target node cannot be reached.

Public
endNode

End node of the path.

Public
endPoint

End point of the path.

Public
originalEndPoint

End Point exactly as in the path request.

Public
originalStartPoint

Start Point exactly as in the path request.

Public
result
Public
startIntPoint

Start point in integer coordinates.

Public
startNode

Start node of the path.

Public
startPoint

Start point of the path.

Public

Inherited Public Members

BlockUntilCalculated ()

Blocks until this path has been calculated and returned.

Public
callback

Callback to call when the path is complete.

Public
Claim (o)

Claim this path (pooling).

Public
CompleteState

Current state of the path.

Public
enabledTags

Which graph tags are traversable.

Public
error

If the path failed, this is true.

Public
Error ()

Aborts the path because of an error.

Public
errorLog

Additional info on why a path failed.

Public
GetTotalLength ()

Total Length of the path.

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
isDone

Returns if this path has been fully calculated and the result has been set.

Public
modifiers

List of modifiers used to post process the result of this path.

Public
nnConstraint

Constraint for how to search for nodes.

Public
path

Holds the path as a Node array.

Public
Release (o, silent=…)

Releases a path claim (pooling).

Public
result

Result of the path calculation.

Public
tagPenalties

Penalties for each tag.

Public
traversalProvider

Provides additional traversal information to a path request.

Public
WaitForPath ()

Waits until this path has been calculated and returned.

Public

Private/Protected Members

CalculateHScore (node)

Estimated cost from the specified node to the target.

Package
CalculateStep (targetTick)

Calculates the path until completed or until the time has passed targetTick.

Protected
CanTraverse (node)

Returns if the node can be traversed.

Package
Cleanup ()

Always called after the path has been calculated.

Protected
CompletePathIfStartIsValidTarget ()

Checks if the start node is the target and complete the path if that is the case.

Protected
completeState

Backing field for CompleteState.

Protected
CompleteWith (node)

Completes the path using the specified target node.

Private
currentR

The node currently being processed.

Protected
DebugString (logMode)

Returns a debug string for this path.

Package
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
duration

How long it took to calculate this path in milliseconds.

Package
endNodeCosts

Saved original costs for the end node.

Protected
EndPointGridGraphSpecialCase (closestWalkableEndNode)

Applies a special case for grid nodes.

Protected
FailWithError (msg)

Causes the path to fail and sets errorLog to msg.

Package
FloodingPath

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

Package
GetConnectionSpecialCost (a, b, currentCost)

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

Package
GetHTarget ()
Package
GetTagPenalty (tag)

Returns penalty for the given tag.

Package
GetTraversalCost (node)
Package
gridSpecialCaseNode

Used in EndPointGridGraphSpecialCase.

Private
hasBeenReset

True if the Reset function has been called.

Protected
hasEndPoint

Determines if a search for an end node should be done.

Protected
hTarget

Target to use for H score calculations.

Protected
hTargetNode

Target to use for H score calculation.

Protected
Initialize ()

Initializes the path.

Protected
internalTagPenalties

The tag penalties that are actually used.

Protected
manualTagPenalties

Tag penalties set by other scripts.

Protected
next

Internal linked list implementation.

Package
OnEnterPool ()

Called when the path enters the pool.

Protected
partialBestTarget

Current best target for the partial path.

Protected
pathHandler

Data for the thread calculating this path.

Protected
pathID

ID of this path.

Package
PipelineState

Returns the state of the path in the pathfinding pipeline.

Package
Prepare ()

Prepares the path.

Protected
PrepareBase (pathHandler)

Prepares low level path variables for calculation.

Protected
Reset ()

Reset all values to their default values.

Protected
ReturnPath ()

Calls callback to return the calculated path.

Protected
searchedNodes

Number of nodes this path has searched.

Package
SetFlagOnSurroundingGridNodes (gridNode, flag, flagState)

Helper method to set PathNode.flag1 to a specific value for all nodes adjacent to a grid node.

Private
Setup (start, end, callbackDelegate)
Protected
Trace (from)

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

Protected
UpdateStartEnd (start, end)

Sets the start and end points.

Protected