Record Class RouteFinder

java.lang.Object

java.lang.Record

com.soulfiremc.server.pathfinding.RouteFinder

public record RouteFinder(MinecraftGraph baseGraph, GoalScorer scorer)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RouteFinder.FoundRouteResult	A full route found to the target
static final record	RouteFinder.NoRouteFoundResult	No route found to the target
static final record	RouteFinder.PartialRouteResult	This is the best route we found before reaching the edge of view distance
static interface	RouteFinder.RouteSearchResult	The result of a route search
static final record	RouteFinder.SearchExpiredResult	The search expired before finding a route
static final record	RouteFinder.SearchInterruptedResult	The search was interrupted before finding a route

Constructor Summary

Constructors

Constructor	Description
RouteFinder(MinecraftGraph baseGraph, GoalScorer scorer)	Creates an instance of a RouteFinder record class.

Method Summary

Modifier and Type	Method	Description
MinecraftGraph	baseGraph()	Returns the value of the baseGraph record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
CompletableFuture<RouteFinder.RouteSearchResult>	findRouteFuture(NodeState from)
CompletableFuture<RouteFinder.RouteSearchResult>	findRouteFutureSingle(MinecraftGraph graph, NodeState from, CancellationToken cancellationToken)
final int	hashCode()	Returns a hash code value for this object.
GoalScorer	scorer()	Returns the value of the scorer record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

RouteFinder

public RouteFinder(MinecraftGraph baseGraph,
 GoalScorer scorer)

Creates an instance of a RouteFinder record class.

Parameters:

baseGraph - the value for the baseGraph record component

scorer - the value for the scorer record component

Method Details

findRouteFuture

public CompletableFuture<RouteFinder.RouteSearchResult> findRouteFuture(NodeState from)

findRouteFutureSingle

public CompletableFuture<RouteFinder.RouteSearchResult> findRouteFutureSingle(MinecraftGraph graph,
 NodeState from,
 CancellationToken cancellationToken)

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

baseGraph

public MinecraftGraph baseGraph()

Returns the value of the baseGraph record component.

Returns:

the value of the baseGraph record component

scorer

public GoalScorer scorer()

Returns the value of the scorer record component.

Returns:

the value of the scorer record component