Package com.onarandombox.MultiverseCore.commands

Class HelpCommand

java.lang.Object

com.pneumaticraft.commandhandler.Command

com.onarandombox.MultiverseCore.commands.PaginatedCommand<T>

com.onarandombox.MultiverseCore.commands.PaginatedCoreCommand<com.pneumaticraft.commandhandler.Command>

com.onarandombox.MultiverseCore.commands.HelpCommand

public class HelpCommand
extends PaginatedCoreCommand<com.pneumaticraft.commandhandler.Command>

Displays a nice help menu.

Nested Class Summary

Nested classes/interfaces inherited from class com.onarandombox.MultiverseCore.commands.PaginatedCommand

PaginatedCommand.FilterObject

Field Summary

Fields inherited from class com.onarandombox.MultiverseCore.commands.PaginatedCoreCommand

plugin

Fields inherited from class com.onarandombox.MultiverseCore.commands.PaginatedCommand

itemsPerPage

Constructor Summary

Constructors

Constructor	Description
HelpCommand(MultiverseCore plugin)

Method Summary

Modifier and Type	Method	Description
protected java.util.List<com.pneumaticraft.commandhandler.Command>	getFilteredItems(java.util.List<com.pneumaticraft.commandhandler.Command> availableItems, java.lang.String filter)	Gets filtered items.
protected java.lang.String	getItemText(com.pneumaticraft.commandhandler.Command item)	Converts an item into a string.
void	runCommand(org.bukkit.command.CommandSender sender, java.util.List<java.lang.String> args)

Methods inherited from class com.onarandombox.MultiverseCore.commands.PaginatedCommand

cleanFilter, getPageAndFilter, setItemsPerPage, showPage, stitchThisString

Methods inherited from class com.pneumaticraft.commandhandler.Command

addAdditonalPermission, addCommandExample, addKey, addKey, checkArgLength, getAllPermissionStrings, getCommandDesc, getCommandExamples, getCommandName, getCommandUsage, getKey, getKeys, getKeyStrings, getMaxArgs, getMinArgs, getNumKeyArgs, getPermission, getPermissionString, getPlugin, isOpRequired, removeKeyArgs, setArgRange, setCommandUsage, setName, setPermission, setPermission, showHelp

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpCommand

public HelpCommand(MultiverseCore plugin)

Method Detail

getFilteredItems

protected java.util.List<com.pneumaticraft.commandhandler.Command> getFilteredItems(java.util.List<com.pneumaticraft.commandhandler.Command> availableItems,
                                                                                    java.lang.String filter)

Description copied from class: PaginatedCommand

Gets filtered items.

Specified by:

getFilteredItems in class PaginatedCommand<com.pneumaticraft.commandhandler.Command>

Parameters:

availableItems - All available items.

filter - The filter-String.

Returns:

A list of items that match the filter.

getItemText

protected java.lang.String getItemText(com.pneumaticraft.commandhandler.Command item)

Description copied from class: PaginatedCommand

Converts an item into a string.

Specified by:

getItemText in class PaginatedCommand<com.pneumaticraft.commandhandler.Command>

Parameters:

item - The item.

Returns:

A String.

runCommand

public void runCommand(org.bukkit.command.CommandSender sender,
                       java.util.List<java.lang.String> args)

Specified by:

runCommand in class com.pneumaticraft.commandhandler.Command