essentials.action.Pathing.IPathingEngine Interface Reference

A pathing engine that can discover a Path from point A->B That can increment itself to the conclusion More...

Inheritance diagram for essentials.action.Pathing.IPathingEngine:

Public Member Functions
Path	GetResult ()
	Returns the full resulting path. Throws if incomplete More...
Path	GetIncrementalPath ()
	Gets the currently known best-path to the result. Depending on the implementation, may be called to get the best-path in the case where the overall search has failed. More...
void	Iterate ()
	Iterate the engine (Call this in a loop until finished) More...
Path	Compute ()
	Full path compute (Iterate until done). Returns Path or null More...

Properties
Vector3i	Start [get]
	Starting position More...
Vector3i	End [get]
	Ending position More...
PathEngineState	State [get]
	The current state of the path resolution More...

Detailed Description

A pathing engine that can discover a Path from point A->B That can increment itself to the conclusion

Member Function Documentation

Compute()

Path essentials.action.Pathing.IPathingEngine.Compute

(

)

Full path compute (Iterate until done). Returns Path or null

Returns

The compute.

Implemented in essentials.action.Pathing.Engines.AStarEngine.

GetIncrementalPath()

Path essentials.action.Pathing.IPathingEngine.GetIncrementalPath

(

)

Gets the currently known best-path to the result. Depending on the implementation, may be called to get the best-path in the case where the overall search has failed.

Returns

The incremental path.

Implemented in essentials.action.Pathing.Engines.AStarEngine.

GetResult()

Path essentials.action.Pathing.IPathingEngine.GetResult

(

)

Returns the full resulting path. Throws if incomplete

Exceptions

PathEngineException

Returns

The result.

Implemented in essentials.action.Pathing.Engines.AStarEngine.

Iterate()

void essentials.action.Pathing.IPathingEngine.Iterate

(

)

Iterate the engine (Call this in a loop until finished)

Implemented in essentials.action.Pathing.Engines.AStarEngine.

Property Documentation

End

Vector3i essentials.action.Pathing.IPathingEngine.End

get

Ending position

The end.

Start

Vector3i essentials.action.Pathing.IPathingEngine.Start

get

Starting position

The start.

State

PathEngineState essentials.action.Pathing.IPathingEngine.State

get

The current state of the path resolution

The state.

---

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

• essentials.action/Pathing/IPathingEngine.cs