Package de.metaphoriker.pathetic.api.pathing.result

Enum PathState

java.lang.Object

java.lang.Enum<PathState>

de.metaphoriker.pathetic.api.pathing.result.PathState

All Implemented Interfaces:

Serializable, Comparable<PathState>, java.lang.constant.Constable

public enum PathState
extends Enum<PathState>

The state of a finished pathfinding process. Finished does not mean successful, it just means that the pathfinding process has ended.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABORTED	The pathfinding process was aborted
FAILED	The Path wasn't found, either it reached its max search depth or it couldn't find more positions
FALLBACK	Signifies that the pathfinder fell back during the pathfinding attempt
FOUND	The Path was successfully found
INITIALLY_FAILED	Pathing failed to start, typically due to an invalid start or end position.
LENGTH_LIMITED	Signifies that the pathfinder reached its length limit
MAX_ITERATIONS_REACHED	Signifies that the pathfinder reached its iteration limit

Method Summary

Modifier and Type	Method	Description
static PathState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PathState[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ABORTED

public static final PathState ABORTED

The pathfinding process was aborted

INITIALLY_FAILED

public static final PathState INITIALLY_FAILED

Pathing failed to start, typically due to an invalid start or end position.

FOUND

public static final PathState FOUND

The Path was successfully found

FAILED

public static final PathState FAILED

The Path wasn't found, either it reached its max search depth or it couldn't find more positions

FALLBACK

public static final PathState FALLBACK

Signifies that the pathfinder fell back during the pathfinding attempt

LENGTH_LIMITED

public static final PathState LENGTH_LIMITED

Signifies that the pathfinder reached its length limit

MAX_ITERATIONS_REACHED

public static final PathState MAX_ITERATIONS_REACHED

Signifies that the pathfinder reached its iteration limit

Method Details

values

public static PathState[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PathState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null