Package com.minecolonies.core.entity.pathfinding.pathjobs

Class PathJobFindWater

java.lang.Object

com.minecolonies.core.entity.pathfinding.pathjobs.AbstractPathJob

com.minecolonies.core.entity.pathfinding.pathjobs.PathJobFindWater

All Implemented Interfaces:

IPathJob, ISearchPathJob, Callable<net.minecraft.world.level.pathfinder.Path>

public class PathJobFindWater
extends AbstractPathJob
implements ISearchPathJob

Find and return a path to the nearest water. Created: March 25, 2016

Field Summary

Fields inherited from class com.minecolonies.core.entity.pathfinding.pathjobs.AbstractPathJob

cachedBlockLookup, debugDrawEnabled, debugNodesExtra, debugNodesNotVisited, debugNodesOrgPath, debugNodesPath, debugNodesVisited, debugNodesVisitedLater, entity, extraNodes, heuristicMod, MAX_NODES, maxNodes, result, start, tempWorldPos, totalNodesVisited, world

Constructor Summary

Constructors

Constructor	Description
PathJobFindWater(net.minecraft.world.level.Level world, @NotNull net.minecraft.core.BlockPos start, net.minecraft.core.BlockPos home, int range, @NotNull List<Tuple<net.minecraft.core.BlockPos,net.minecraft.core.BlockPos>> ponds, net.minecraft.world.entity.Mob entity)	AbstractPathJob constructor.

Method Summary

Modifier and Type	Method	Description
protected double	computeHeuristic(int x, int y, int z)	Compute the heuristic cost ('h' value) of a given position x,y,z.
double	getEndNodeScore(MNode n)	Calculates a score for potential points where the path may end given no destination By default the heuristic for the closest node is used
@NotNull WaterPathResult	getResult()	Get the path result holder for this job
protected boolean	isAtDestination(@NotNull MNode n)	Return true if the given node is a viable final destination, and the path should generate to here.
protected double	modifyCost(double cost, MNode parent, boolean swimstart, boolean swimming, int x, int y, int z, net.minecraft.world.level.block.state.BlockState state, net.minecraft.world.level.block.state.BlockState below)	Modifies costs if needed for a node
void	setPathingOptions(PathingOptions pathingOptions)	Sets the pathing options

Methods inherited from class com.minecolonies.core.entity.pathfinding.pathjobs.AbstractPathJob

call, computeCost, exploreInDirection, getActualWorld, getEntity, getGroundHeight, getPathingOptions, getStart, handleDebugOptions, initDebug, isPassable, isPassable, search, stopOnNodeLimit, syncDebug, toString, visitNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

PathJobFindWater

public PathJobFindWater(net.minecraft.world.level.Level world,
 @NotNull
 @NotNull net.minecraft.core.BlockPos start,
 net.minecraft.core.BlockPos home,
 int range,
 @NotNull
 @NotNull List<Tuple<net.minecraft.core.BlockPos,net.minecraft.core.BlockPos>> ponds,
 net.minecraft.world.entity.Mob entity)

AbstractPathJob constructor.

Parameters:

world - the world within which to path.

start - the start position from which to path from.

home - the position of the worker hut.

range - maximum path range.

ponds - already visited fishing places.

entity - the entity.

Method Details

getResult

@NotNull
public @NotNull WaterPathResult getResult()

Description copied from interface: IPathJob

Get the path result holder for this job

Specified by:

getResult in interface IPathJob

Overrides:

getResult in class AbstractPathJob

Returns:

computeHeuristic

protected double computeHeuristic(int x,
 int y,
 int z)

Description copied from class: AbstractPathJob

Compute the heuristic cost ('h' value) of a given position x,y,z.

Returning a value of 0 performs a breadth-first search. Returning a value less than actual possible cost to goal guarantees shortest path, but at computational expense. Returning a value exactly equal to the cost to the goal guarantees shortest path and least expense (but generally. only works when path is straight and unblocked). Returning a value greater than the actual cost to goal produces good, but not perfect paths, and is fast. Returning a very high value (such that 'h' is very high relative to 'g') then only 'h' (the heuristic) matters as the search will be a very fast greedy best-first-search, ignoring cost weighting and distance.

Specified by:

computeHeuristic in class AbstractPathJob

Returns:

the heuristic.

isAtDestination

protected boolean isAtDestination(@NotNull
 @NotNull MNode n)

Description copied from class: AbstractPathJob

Return true if the given node is a viable final destination, and the path should generate to here.

Specified by:

isAtDestination in class AbstractPathJob

Parameters:

n - Node to test.

Returns:

true if the node is a viable destination.

modifyCost

protected double modifyCost(double cost,
 MNode parent,
 boolean swimstart,
 boolean swimming,
 int x,
 int y,
 int z,
 net.minecraft.world.level.block.state.BlockState state,
 net.minecraft.world.level.block.state.BlockState below)

Description copied from class: AbstractPathJob

Modifies costs if needed for a node

Overrides:

modifyCost in class AbstractPathJob

Returns:

setPathingOptions

public void setPathingOptions(PathingOptions pathingOptions)

Description copied from class: AbstractPathJob

Sets the pathing options

Overrides:

setPathingOptions in class AbstractPathJob

Parameters:

pathingOptions - the pathing options to set.

getEndNodeScore

public double getEndNodeScore(MNode n)

Description copied from class: AbstractPathJob

Calculates a score for potential points where the path may end given no destination By default the heuristic for the closest node is used

Specified by:

getEndNodeScore in interface ISearchPathJob

Overrides:

getEndNodeScore in class AbstractPathJob

Parameters:

n - Node to test.

Returns:

score for the node, lower is better