essentials.action.Pathing.IPathCostEngine Interface Reference

Inheritance diagram for essentials.action.Pathing.IPathCostEngine:

Public Member Functions
int	GetActualCost (Vector3i src, Vector3i dst)
	Gets the actual cost traversing between two points If less than 0, treated as impassible. Otherwise cost is relative More...
int	GetHeuristic (Vector3i src, Vector3i dst)
	Gets the heuristic cost between two points (to better predict which way to search) More...

Member Function Documentation

GetActualCost()

int essentials.action.Pathing.IPathCostEngine.GetActualCost	(	Vector3i	src,
		Vector3i	dst
	)

Gets the actual cost traversing between two points If less than 0, treated as impassible. Otherwise cost is relative

These points should always be on the "surface" of blocks (aka, empty themselves, but over something solid).

Returns

The actual cost.

Parameters

src	Source.
dst	Dst.

Implemented in essentials.action.Pathing.DefaultWorldCostEngine.

GetHeuristic()

int essentials.action.Pathing.IPathCostEngine.GetHeuristic	(	Vector3i	src,
		Vector3i	dst
	)

Gets the heuristic cost between two points (to better predict which way to search)

Returns

The heuristic.

Parameters

src	Source.
dst	Dst.

Implemented in essentials.action.Pathing.DefaultWorldCostEngine.

---

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

• essentials.action/Pathing/IPathCostEngine.cs