Bukkit  1.4.7-R1.0
 All Classes Namespaces Files Functions Variables Enumerator Pages
org.bukkit.command.defaults.BukkitCommand Class Reference
+ Inheritance diagram for org.bukkit.command.defaults.BukkitCommand:
+ Collaboration diagram for org.bukkit.command.defaults.BukkitCommand:

Protected Member Functions

 BukkitCommand (String name)
 
 BukkitCommand (String name, String description, String usageMessage, List< String > aliases)
 
- Protected Member Functions inherited from org.bukkit.command.Command
 Command (String name)
 
 Command (String name, String description, String usageMessage, List< String > aliases)
 

Additional Inherited Members

- Public Member Functions inherited from org.bukkit.command.Command
abstract boolean execute (CommandSender sender, String commandLabel, String[] args)
 Executes the command, returning its success.
 
List< String > tabComplete (CommandSender sender, String[] args)
 
List< String > tabComplete (CommandSender sender, String alias, String[] args) throws IllegalArgumentException
 Executed on tab completion for this command, returning a list of options the player can tab through.
 
String getName ()
 Returns the name of this command.
 
String getPermission ()
 Gets the permission required by users to be able to perform this command.
 
void setPermission (String permission)
 Sets the permission required by users to be able to perform this command.
 
boolean testPermission (CommandSender target)
 Tests the given CommandSender to see if they can perform this command.
 
boolean testPermissionSilent (CommandSender target)
 Tests the given CommandSender to see if they can perform this command.
 
String getLabel ()
 Returns the current lable for this command.
 
boolean setLabel (String name)
 Sets the label of this command If the command is currently registered the label change will only take effect after its been reregistered e.g.
 
boolean register (CommandMap commandMap)
 Registers this command to a CommandMap Once called it only allows changes the registered CommandMap.
 
boolean unregister (CommandMap commandMap)
 Unregisters this command from the passed CommandMap applying any outstanding changes.
 
boolean isRegistered ()
 Returns the current registered state of this command.
 
List< String > getAliases ()
 Returns a list of active aliases of this command.
 
String getPermissionMessage ()
 Returns a message to be displayed on a failed permission check for this command.
 
String getDescription ()
 Gets a brief description of this command.
 
String getUsage ()
 Gets an example usage of this command.
 
Command setAliases (List< String > aliases)
 Sets the list of aliases to request on registration for this command.
 
Command setDescription (String description)
 Sets a brief description of this command.
 
Command setPermissionMessage (String permissionMessage)
 Sets the message sent when a permission check fails.
 
Command setUsage (String usage)
 Sets the example usage of this command.
 
String toString ()
 
- Static Public Member Functions inherited from org.bukkit.command.Command
static void broadcastCommandMessage (CommandSender source, String message)
 
static void broadcastCommandMessage (CommandSender source, String message, boolean sendToSource)
 
- Protected Attributes inherited from org.bukkit.command.Command
String description = ""
 
String usageMessage
 

Detailed Description

Definition at line 7 of file BukkitCommand.java.

Constructor & Destructor Documentation

org.bukkit.command.defaults.BukkitCommand.BukkitCommand ( String  name)
protected

Definition at line 8 of file BukkitCommand.java.

org.bukkit.command.defaults.BukkitCommand.BukkitCommand ( String  name,
String  description,
String  usageMessage,
List< String >  aliases 
)
protected

Definition at line 12 of file BukkitCommand.java.


The documentation for this class was generated from the following file: