simple.client.action.SlashAction Maven / Gradle / Ivy
The newest version!
package simple.client.action;
/*
* Eventually move these out from inner classes, then make them
* dynamically configurable/loadable.
*/
/**
* A chat command.
*/
public interface SlashAction {
/**
* Execute a chat command.
*
* @param params
* The formal parameters.
* @param remainder
* Line content after parameters.
*
* @return true if command was handled.
*/
boolean execute(String[] params, String remainder);
/**
* Get the maximum number of formal parameters.
*
* @return The parameter count.
*/
int getMaximumParameters();
/**
* Get the minimum number of formal parameters.
*
* @return The parameter count.
*/
int getMinimumParameters();
/**
* Display usage for this command.
*
* @param command The command usage is for.
* @param detailed Show detailed help, otherwise
* just 1-line synopsis.
*/
public void usage(boolean detailed);
}