taco.tacoapi.api.command

Class TacoHelpCommand

java.lang.Object

taco.tacoapi.api.command.TacoCommand

taco.tacoapi.api.command.TacoHelpCommand

public abstract class TacoHelpCommand
extends TacoCommand

Represents a help command, most commonly accessed by /command ?. Specific help can be formatted in the following ways:

• Color Codes
• Newlines (\n)

Author:

KILL3RTACO

See Also:

TacoCommandHandler, TacoCommand

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<java.lang.String>	gOutput
protected int	maxElements
protected java.util.HashMap<TacoCommand,java.lang.String>	sOutput

Constructor Summary

Constructors

Constructor and Description
TacoHelpCommand()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract java.lang.String	getCommandName() Gets the command name.
protected abstract void	initGeneral() Used to initiate data entered into the general output.
protected abstract void	initSpecific() Used to initiate data entered into the specific output.
boolean	onConsoleCommand(java.lang.String[] args) Same method from its superclass, TacoCommand.
boolean	onPlayerCommand(org.bukkit.entity.Player player, java.lang.String[] args) Same method from its superclass, TacoCommand.
private void	showHelp(int page, org.bukkit.entity.Player player) Shows general help to the player.
private void	showHelp(java.lang.String command, org.bukkit.entity.Player player) Shows specific help to the player.

Methods inherited from class taco.tacoapi.api.command.TacoCommand

getAliases

Methods inherited from class java.lang.Object

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

Field Detail

sOutput

protected java.util.HashMap<TacoCommand,java.lang.String> sOutput

gOutput

protected java.util.ArrayList<java.lang.String> gOutput

maxElements

protected int maxElements

Constructor Detail

TacoHelpCommand

public TacoHelpCommand()

Method Detail

getCommandName

protected abstract java.lang.String getCommandName()

Gets the command name.

Returns:

The command name

initGeneral

protected abstract void initGeneral()

Used to initiate data entered into the general output. This will be called when a player types /command ?

initSpecific

protected abstract void initSpecific()

Used to initiate data entered into the specific output. This will be called when a player types /command ? &gtsubcommand&lt

onPlayerCommand

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

Same method from its superclass, TacoCommand.

Specified by:

onPlayerCommand in class TacoCommand

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 boolean onConsoleCommand(java.lang.String[] args)

Same method from its superclass, TacoCommand.

Specified by:

onConsoleCommand in class TacoCommand

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.

showHelp

private void showHelp(java.lang.String command,
            org.bukkit.entity.Player player)

Shows specific help to the player.

Parameters:

command - - The subcommand to get help from

player - - The Player to send help to

showHelp

private void showHelp(int page,
            org.bukkit.entity.Player player)

Shows general help to the player.

Parameters:

page - - The page to get help from

player - - The player to send help to