Default world cost engine. Avoids hills and water. Should work for most default blocks More...

Inheritance diagram for essentials.action.Pathing.DefaultWorldCostEngine:

Public Member Functions
	DefaultWorldCostEngine (IWorldReadonly world)

virtual 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...

virtual int	GetHeuristic (Vector3i src, Vector3i dst)
	Gets the heuristic cost between two points (to better predict which way to search) More...

Protected Attributes
readonly IWorldReadonly	World

Detailed Description

Default world cost engine. Avoids hills and water. Should work for most default blocks

Constructor & Destructor Documentation

◆ DefaultWorldCostEngine()

essentials.action.Pathing.DefaultWorldCostEngine.DefaultWorldCostEngine ( IWorldReadonly world )

         {
             World = world;
         }

Member Function Documentation

◆ GetActualCost()

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

virtual

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.

Attribute: dst

;

Attribute: dst.X, dst.Y, dst.Z-1

;

Implements essentials.action.Pathing.IPathCostEngine.

         {
             var inBlock = World[dst];
             if (inBlock.Solid)
                 return -1; //Impassible
 
             var onBlock = World[dst.X, dst.Y, dst.Z-1];
             if (!onBlock.Solid && !onBlock.Climbable)
                 return -1; //Can't hover
 
             if (onBlock.DamageInfliction > 0 || inBlock.DamageInfliction > 0)
                 return 16;
             if (onBlock.Climbable || inBlock.Climbable)
                 return 1;
             if (onBlock.IsLiquid || inBlock.IsLiquid)
                 return 4;
             if (src.Z != dst.Z)
                 return 2;
             return 1;
         }

◆ GetHeuristic()

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

virtual

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

Returns: The heuristic.

Parameters

src	Source.
dst	Dst.

Implements essentials.action.Pathing.IPathCostEngine.

         {
             int dx = src.X - dst.X;
             int dy = src.Y - dst.Y;
             return (int)Math.Sqrt(dx*dx + dy*dy) + Math.Abs(dst.Z - src.Z)*2;
         }

Member Data Documentation

◆ World

readonly IWorldReadonly essentials.action.Pathing.DefaultWorldCostEngine.World

protected

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

essentials.action/Pathing/DefaultWorldCostEngine.cs

Public Member Functions

Protected Attributes