Package baritone.api.process

Enum Class PathingCommandType

java.lang.Object

java.lang.Enum<PathingCommandType>

baritone.api.process.PathingCommandType

All Implemented Interfaces:

Serializable, Comparable<PathingCommandType>, Constable

public enum PathingCommandType
extends Enum<PathingCommandType>

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
CANCEL_AND_SET_GOAL	Set the goal (regardless of null), and request a cancel of the current path (when safe)
DEFER	Go and ask the next process what to do
FORCE_REVALIDATE_GOAL_AND_PATH	Set the goal and path.
REQUEST_PAUSE	Has no effect on the current goal or path, just requests a pause
REVALIDATE_GOAL_AND_PATH	Set the goal and path.
SET_GOAL_AND_PATH	Set the goal and path.
SET_GOAL_AND_PAUSE	Sets the goal and calculates a path, but pauses instead of immediately starting the path.

Method Summary

Modifier and Type	Method	Description
static PathingCommandType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PathingCommandType[]	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

SET_GOAL_AND_PATH

public static final PathingCommandType SET_GOAL_AND_PATH

Set the goal and path.

If you use this alongside a null goal, it will continue along its current path and current goal.

REQUEST_PAUSE

public static final PathingCommandType REQUEST_PAUSE

Has no effect on the current goal or path, just requests a pause

CANCEL_AND_SET_GOAL

public static final PathingCommandType CANCEL_AND_SET_GOAL

Set the goal (regardless of null), and request a cancel of the current path (when safe)

REVALIDATE_GOAL_AND_PATH

public static final PathingCommandType REVALIDATE_GOAL_AND_PATH

Set the goal and path.

If Settings.cancelOnGoalInvalidation is true, revalidate the current goal, and cancel if it's no longer valid, or if the new goal is null.

FORCE_REVALIDATE_GOAL_AND_PATH

public static final PathingCommandType FORCE_REVALIDATE_GOAL_AND_PATH

Set the goal and path.

Cancel the current path if the goals are not equal

DEFER

public static final PathingCommandType DEFER

Go and ask the next process what to do

SET_GOAL_AND_PAUSE

public static final PathingCommandType SET_GOAL_AND_PAUSE

Sets the goal and calculates a path, but pauses instead of immediately starting the path.

Method Details

values

public static PathingCommandType[] 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 PathingCommandType 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