taco.tacoapi.api.command

Class TacoCommand

java.lang.Object

taco.tacoapi.api.command.TacoCommand

Direct Known Subclasses:

TacoApiPluginsCommand, TacoHelpCommand

public abstract class TacoCommand
extends java.lang.Object

Represents a subcommand. It is easy to confuse this with a command. A subcommand is the first argument in a command (e.g. /im send Notch 46 64) 'send' is the subcommand.

Author:

KILL3RTACO

See Also:

TacoCommandHandler, TacoHelpCommand

Constructor Summary

Constructors

Constructor and Description
TacoCommand()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract java.lang.String[]	getAliases() Use this method to get the aliases for a subcommand.
abstract boolean	onConsoleCommand(java.lang.String[] args) This method is called when someone using the console runs this command (automatic).
abstract boolean	onPlayerCommand(org.bukkit.entity.Player player, java.lang.String[] args) This method is called when a player runs this command (automatic)

Methods inherited from class java.lang.Object

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

Constructor Detail

TacoCommand

public TacoCommand()

Method Detail

onPlayerCommand

public abstract boolean onPlayerCommand(org.bukkit.entity.Player player,
                      java.lang.String[] args)

This method is called when a player runs this command (automatic)

Parameters:

player - The player that typed the command

args - The arguments of the command

Returns:

false by default, if false is returned the player will be given. an {@link InvalidPermissionsMessage InvalidPermissionsMessage}

onConsoleCommand

public abstract boolean onConsoleCommand(java.lang.String[] args)

This method is called when someone using the console runs this command (automatic). This method should return false if this command can't be run from console

Parameters:

args - The arguments of the command

Returns:

false by default, if false is returned a message saying "[PluginName] This can't be run from console" will printed to console.

getAliases

protected abstract java.lang.String[] getAliases()

Use this method to get the aliases for a subcommand. It is important to return a String[] for the command to run, even if the command has no aliases (the class extending the TacoCommand class is being used to execute a command without any arguments), in which case:

        return new String[]{""};
 

Returns:

the aliases to this subcommand