com.sk89q.minecraft.util.commands

Annotation Type Command

@Retention(value=RUNTIME)
public @interface Command

This annotation indicates a command. Methods should be marked with this annotation to tell CommandsManager that the method is a command. Note that the method name can actually be anything.

Author:

sk89q

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	aliases A list of aliases for the command.
String	desc

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	anyFlags
String	flags Flags allow special processing for flags such as -h in the command, allowing users to easily turn on a flag.
String	help
int	max The maximum number of arguments.
int	min The minimum number of arguments.
String	usage Usage instruction.

Element Detail

aliases

public abstract String[] aliases

A list of aliases for the command. The first alias is the most important -- it is the main name of the command. (The method name is never used for anything).

Returns:

Aliases for a command

desc

public abstract String desc

Returns:

A short description for the command.

usage

public abstract String usage

Usage instruction. Example text for usage could be [-h harps] [name] [message].

Returns:

Usage instructions for a command

Default:

""

min

public abstract int min

The minimum number of arguments. This should be 0 or above.

Returns:

the minimum number of arguments

Default:

0

max

public abstract int max

The maximum number of arguments. Use -1 for an unlimited number of arguments.

Returns:

the maximum number of arguments

Default:

-1

flags

public abstract String flags

Flags allow special processing for flags such as -h in the command, allowing users to easily turn on a flag. This is a string with each character being a flag. Use A-Z and a-z as possible flags. Appending a flag with a : makes the flag character before a value flag, meaning that if it is given it must have a value

Returns:

Flags matching a-zA-Z

Default:

""

help

public abstract String help

Returns:

A long description for the command.

Default:

""

anyFlags

public abstract boolean anyFlags

Returns:

Whether any flag can be provided to the command, even if it is not in flags()

Default:

false