Package me.hackware.api.command

Class Command

java.lang.Object

me.hackware.api.command.Command

public abstract class Command
extends Object

Abstract base class for all hackware commands.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Command(String name, String description, String usage)

Method Summary

Modifier and Type	Method	Description
protected void	error(String message)	Failure: red TextIcons.Icon.WARNING, message red too.
abstract void	execute(String[] args)	Execute this command with the given arguments.
String	getDescription()
String	getName()
List<String>	getSuggestions(String[] args)	Return tab-completion suggestions for the given partial arguments.
String	getUsage()
protected void	info(String message)	Informational: aqua TextIcons.Icon.INFO.
protected void	print(TextIcons.Icon icon, net.minecraft.ChatFormatting iconColor, String message)	Sends message behind an [icon] prefix, with the icon tinted.
protected void	usage()	Print command usage.
protected void	warn(String message)	Advisory: yellow TextIcons.Icon.WARNING.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Command

protected Command(String name,
 String description,
 String usage)

Method Details

getName

public String getName()

getDescription

public String getDescription()

getUsage

public String getUsage()

execute

public abstract void execute(String[] args)

Execute this command with the given arguments.

Parameters:

args - arguments after the command name, split by whitespace

getSuggestions

public List<String> getSuggestions(String[] args)

Return tab-completion suggestions for the given partial arguments.

Parameters:

args - the current arguments (may be empty or partial)

Returns:

list of suggestion strings

print

protected void print(TextIcons.Icon icon,
 net.minecraft.ChatFormatting iconColor,
 String message)

Sends message behind an [icon] prefix, with the icon tinted.

info

protected void info(String message)

Informational: aqua TextIcons.Icon.INFO.

warn

protected void warn(String message)

Advisory: yellow TextIcons.Icon.WARNING.

error

protected void error(String message)

Failure: red TextIcons.Icon.WARNING, message red too. Use for bad usage and failures.

usage

protected void usage()

Print command usage.