Package baritone.api.command

Interface ICommand

All Superinterfaces:

Helper

All Known Implementing Classes:

Command

public interface ICommand
extends Helper

The base for a command.

Since:

10/7/2019

Author:

Brady

Field Summary

Fields inherited from interface baritone.api.utils.Helper

HELPER, mc, MESSAGE_TAG

Method Summary

Modifier and Type	Method	Description
void	execute(String label, IArgConsumer args)	Called when this command is executed.
List<String>	getLongDesc()
List<String>	getNames()
String	getShortDesc()
default boolean	hiddenFromHelp()
Stream<String>	tabComplete(String label, IArgConsumer args)	Called when the command needs to tab complete.

Methods inherited from interface baritone.api.utils.Helper

logDebug, logDirect, logDirect, logDirect, logDirect, logDirect, logDirect, logNotification, logNotification, logNotificationDirect, logNotificationDirect, logToast, logToast, logToast, logUnhandledException

Method Details

execute

void execute(String label,
 IArgConsumer args)
      throws CommandException

Called when this command is executed.

Throws:

CommandException

tabComplete

Stream<String> tabComplete(String label,
 IArgConsumer args)
                    throws CommandException

Called when the command needs to tab complete. Return a Stream representing the entries to put in the completions list.

Throws:

CommandException

getShortDesc

String getShortDesc()

Returns:

A single-line string containing a short description of this command's purpose.

getLongDesc

List<String> getLongDesc()

Returns:

A list of lines that will be printed by the help command when the user wishes to view them.

getNames

List<String> getNames()

Returns:

A list of the names that can be accepted to have arguments passed to this command

hiddenFromHelp

default boolean hiddenFromHelp()

Returns:

true if this command should be hidden from the help menu