Package com.soulfiremc.server.pathfinding.goals

Record Class CloseToPosGoal

java.lang.Object

java.lang.Record

com.soulfiremc.server.pathfinding.goals.CloseToPosGoal

Record Components:

goal - the goal position to get close to

maxRadius - the maximum radius to be close to the goal

All Implemented Interfaces:

GoalScorer

public record CloseToPosGoal(SFVec3i goal, int maxRadius)
extends Record
implements GoalScorer

Goal to get close to a specific position.

Constructor Summary

Constructors

Constructor	Description
CloseToPosGoal(SFVec3i goal, int maxRadius)	Creates an instance of a CloseToPosGoal record class.

Method Summary

Modifier and Type	Method	Description
double	computeScore(MinecraftGraph graph, SFVec3i blockPosition, List<WorldAction> actions)	Calculates the estimated score for a given block position to the goal.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
SFVec3i	goal()	Returns the value of the goal record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	isFinished(MinecraftRouteNode current)	Checks if the given world state indicates that the goal is reached.
int	maxRadius()	Returns the value of the maxRadius record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CloseToPosGoal

public CloseToPosGoal(SFVec3i goal,
 int maxRadius)

Creates an instance of a CloseToPosGoal record class.

Parameters:

goal - the value for the goal record component

maxRadius - the value for the maxRadius record component

Method Details

computeScore

public double computeScore(MinecraftGraph graph,
 SFVec3i blockPosition,
 List<WorldAction> actions)

Description copied from interface: GoalScorer

Calculates the estimated score for a given block position to the goal. Usually this means the distance from achieving the goal.

Specified by:

computeScore in interface GoalScorer

Parameters:

graph - the graph to calculate the score for

blockPosition - the block position to calculate the score for

actions - the actions that have been executed to reach the current state

Returns:

the score for the given world state

isFinished

public boolean isFinished(MinecraftRouteNode current)

Description copied from interface: GoalScorer

Checks if the given world state indicates that the goal is reached.

Specified by:

isFinished in interface GoalScorer

Parameters:

current - the node to check

Returns:

true if the goal is reached, false otherwise

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

goal

public SFVec3i goal()

Returns the value of the goal record component.

Returns:

the value of the goal record component

maxRadius

public int maxRadius()

Returns the value of the maxRadius record component.

Returns:

the value of the maxRadius record component