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

Class PathJobMoveCloseToXNearY

java.lang.Object

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

com.minecolonies.core.entity.pathfinding.pathjobs.PathJobMoveCloseToXNearY

All Implemented Interfaces:

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

public class PathJobMoveCloseToXNearY
extends AbstractPathJob
implements IDestinationPathJob

Job that handles moving close to a position near another

Field Summary

Fields

Modifier and Type	Field	Description
final net.minecraft.core.BlockPos	desiredPosition	Position to go close to
final int	distToDesired	Required distance to reach
final net.minecraft.core.BlockPos	nearbyPosition	Position to stay nearby

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
PathJobMoveCloseToXNearY(net.minecraft.world.level.Level world, net.minecraft.core.BlockPos desiredPosition, net.minecraft.core.BlockPos nearbyPosition, int distToDesired, net.minecraft.world.entity.Mob entity)

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.
net.minecraft.core.BlockPos	getDestination()	Return the destination
protected double	getEndNodeScore(@NotNull 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
protected boolean	isAtDestination(@NotNull MNode n)	Return true if the given node is a viable final destination, and the path should generate to here.
static boolean	isJobFor(AbstractPathJob job, net.minecraft.core.BlockPos desiredPosition, net.minecraft.core.BlockPos nearbyPosition, int distance)	Helper to compare if the given move close to X near Y job matches the input parameters
protected boolean	stopOnNodeLimit(int totalNodesVisited, MNode bestNode, int nodesSinceEndNode)	Stops the pathjob when hitting a node limit

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

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

Methods inherited from class java.lang.Object

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

Field Details

desiredPosition

public final net.minecraft.core.BlockPos desiredPosition

Position to go close to

nearbyPosition

public final net.minecraft.core.BlockPos nearbyPosition

Position to stay nearby

distToDesired

public final int distToDesired

Required distance to reach

Constructor Details

PathJobMoveCloseToXNearY

public PathJobMoveCloseToXNearY(net.minecraft.world.level.Level world,
 net.minecraft.core.BlockPos desiredPosition,
 net.minecraft.core.BlockPos nearbyPosition,
 int distToDesired,
 net.minecraft.world.entity.Mob entity)

Method Details

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.

getEndNodeScore

protected double getEndNodeScore(@NotNull
 @NotNull 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

Overrides:

getEndNodeScore in class AbstractPathJob

Parameters:

n - Node to test.

Returns:

score for the node, lower is better

stopOnNodeLimit

protected boolean stopOnNodeLimit(int totalNodesVisited,
 MNode bestNode,
 int nodesSinceEndNode)

Description copied from class: AbstractPathJob

Stops the pathjob when hitting a node limit

Overrides:

stopOnNodeLimit in class AbstractPathJob

Returns:

getDestination

public net.minecraft.core.BlockPos getDestination()

Description copied from interface: IDestinationPathJob

Return the destination

Specified by:

getDestination in interface IDestinationPathJob

Returns:

destination

isJobFor

public static boolean isJobFor(AbstractPathJob job,
 net.minecraft.core.BlockPos desiredPosition,
 net.minecraft.core.BlockPos nearbyPosition,
 int distance)

Helper to compare if the given move close to X near Y job matches the input parameters

Returns:

true if the given job is the same