Package baritone.api.pathing.movement

Enum Class MovementStatus

java.lang.Object

java.lang.Enum<MovementStatus>

baritone.api.pathing.movement.MovementStatus

All Implemented Interfaces:

Serializable, Comparable<MovementStatus>, Constable

public enum MovementStatus
extends Enum<MovementStatus>

Since:

10/8/2018

Author:

Brady

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
CANCELED	"Unused"
FAILED	Unused
PREPPING	We are preparing the movement to be executed.
RUNNING	The movement is currently in progress, after WAITING
SUCCESS	The movement has been completed and we are at our destination
UNREACHABLE	There was a change in state between calculation and actual movement execution, and the movement has now become impossible.
WAITING	We are waiting for the movement to begin, after PREPPING.

Method Summary

Modifier and Type	Method	Description
final boolean	isComplete()
static MovementStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MovementStatus[]	values()	Returns an array containing the constants of this enum class, 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

PREPPING

public static final MovementStatus PREPPING

We are preparing the movement to be executed. This is when any blocks obstructing the destination are broken.

WAITING

public static final MovementStatus WAITING

We are waiting for the movement to begin, after PREPPING.

RUNNING

public static final MovementStatus RUNNING

The movement is currently in progress, after WAITING

SUCCESS

public static final MovementStatus SUCCESS

The movement has been completed and we are at our destination

UNREACHABLE

public static final MovementStatus UNREACHABLE

There was a change in state between calculation and actual movement execution, and the movement has now become impossible.

FAILED

public static final MovementStatus FAILED

Unused

CANCELED

public static final MovementStatus CANCELED

"Unused"

Method Details

values

public static MovementStatus[] values()

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

Returns:

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

valueOf

public static MovementStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isComplete

public final boolean isComplete()