baritone.api.command.datatypes

Enum ForWaypoints

java.lang.Object

java.lang.Enum<ForWaypoints>

baritone.api.command.datatypes.ForWaypoints

All Implemented Interfaces:

IDatatype, IDatatypeFor<IWaypoint[]>, java.io.Serializable, java.lang.Comparable<ForWaypoints>

public enum ForWaypoints
extends java.lang.Enum<ForWaypoints>
implements IDatatypeFor<IWaypoint[]>

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
IWaypoint[]	get(IDatatypeContext ctx) Consumes the desired amount of arguments from the specified IDatatypeContext, and then returns the parsed value.
static java.lang.String[]	getWaypointNames(IBaritone baritone)
static IWaypoint[]	getWaypoints(IBaritone baritone)
static IWaypoint[]	getWaypointsByName(IBaritone baritone, java.lang.String name)
static IWaypoint[]	getWaypointsByTag(IBaritone baritone, IWaypoint.Tag tag)
java.util.stream.Stream<java.lang.String>	tabComplete(IDatatypeContext ctx) Attempts to complete missing or partial input provided through the IArgConsumer} provided by IDatatypeContext.getConsumer() in order to aide the user in executing commands.
static ForWaypoints	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ForWaypoints[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static IWaypointCollection	waypoints(IBaritone baritone)

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final ForWaypoints INSTANCE

Method Detail

values

public static ForWaypoints[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ForWaypoints c : ForWaypoints.values())
    System.out.println(c);

Returns:

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

valueOf

public static ForWaypoints valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

get

public IWaypoint[] get(IDatatypeContext ctx)
                throws CommandException

Description copied from interface: IDatatypeFor

Consumes the desired amount of arguments from the specified IDatatypeContext, and then returns the parsed value. This method will more than likely return a IllegalArgumentException if the expected input does not conform to a parseable value. As far as a CommandException being thrown is concerned, see the note below for specifics.

Specified by:

get in interface IDatatypeFor<IWaypoint[]>

Parameters:

ctx - The context

Returns:

The parsed data-type

Throws:

CommandException - If there was an issue parsing using another type or arguments could not be polled.

See Also:

IDatatypeContext

tabComplete

public java.util.stream.Stream<java.lang.String> tabComplete(IDatatypeContext ctx)
                                                      throws CommandException

Description copied from interface: IDatatype

Attempts to complete missing or partial input provided through the IArgConsumer} provided by IDatatypeContext.getConsumer() in order to aide the user in executing commands.

One benefit over datatypes over IArgParsers is that instead of each command trying to guess what values the datatype will accept, or simply not tab completing at all, datatypes that support tab completion can provide accurate information using the same methods used to parse arguments in the first place.

Specified by:

tabComplete in interface IDatatype

Parameters:

ctx - The argument consumer to tab complete

Returns:

A stream representing the strings that can be tab completed. DO NOT INCLUDE SPACES IN ANY STRINGS.

Throws:

CommandException

See Also:

IArgConsumer.tabCompleteDatatype(IDatatype)

waypoints

public static IWaypointCollection waypoints(IBaritone baritone)

getWaypoints

public static IWaypoint[] getWaypoints(IBaritone baritone)

getWaypointNames

public static java.lang.String[] getWaypointNames(IBaritone baritone)

getWaypointsByTag

public static IWaypoint[] getWaypointsByTag(IBaritone baritone,
                                            IWaypoint.Tag tag)

getWaypointsByName

public static IWaypoint[] getWaypointsByName(IBaritone baritone,
                                             java.lang.String name)