com.cliffblaster.game.commands
Class HelpCommand

java.lang.Object
  extended by com.cliffblaster.game.Command
      extended by com.cliffblaster.game.commands.HelpCommand

public class HelpCommand
extends Command


Field Summary
 int MAX_PAGE_SIZE
           
 
Constructor Summary
HelpCommand()
           
 
Method Summary
 boolean execute(java.lang.String[] arguments, ServerHandler caller)
          Executes the command, arguments[0] is the command, args[1] is the first argument Caller is null if the caller is the console
 java.lang.String getHelpDesc()
           
 boolean hasPermission(java.lang.String[] arguments, ServerHandler caller)
          Called to check whether the caller has permission to execute that command Caller is null if the caller is the console Must return true if the caller has permission
 void printHelpPage(int page, ServerHandler caller)
           
 void printUsage(java.lang.String[] arguments, ServerHandler caller)
           
 
Methods inherited from class com.cliffblaster.game.Command
getHandle, getPluginManager, getRegisteredHandler, getServer, requestPermission, sendMessage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MAX_PAGE_SIZE

public int MAX_PAGE_SIZE
Constructor Detail

HelpCommand

public HelpCommand()
Method Detail

hasPermission

public boolean hasPermission(java.lang.String[] arguments,
                             ServerHandler caller)
Description copied from class: Command
Called to check whether the caller has permission to execute that command Caller is null if the caller is the console Must return true if the caller has permission

Specified by:
hasPermission in class Command

printHelpPage

public void printHelpPage(int page,
                          ServerHandler caller)

execute

public boolean execute(java.lang.String[] arguments,
                       ServerHandler caller)
Description copied from class: Command
Executes the command, arguments[0] is the command, args[1] is the first argument Caller is null if the caller is the console

Specified by:
execute in class Command

getHelpDesc

public java.lang.String getHelpDesc()
Specified by:
getHelpDesc in class Command

printUsage

public void printUsage(java.lang.String[] arguments,
                       ServerHandler caller)
Specified by:
printUsage in class Command