Represents a Command, which executes various tasks upon user input. More...

Inheritance diagram for org.bukkit.command.Command:

Public Member Functions
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
static void	broadcastCommandMessage (CommandSender source, String message)

static void	broadcastCommandMessage (CommandSender source, String message, boolean sendToSource)

Protected Member Functions
	Command (String name)

	Command (String name, String description, String usageMessage, List< String > aliases)

Protected Attributes
String	description = ""

String	usageMessage

Detailed Description

Represents a Command, which executes various tasks upon user input.

Definition at line 21 of file Command.java.

Constructor & Destructor Documentation

org.bukkit.command.Command.Command ( String name )

protected

Definition at line 33 of file Command.java.

org.bukkit.command.Command.Command	(	String	name,
		String	description,
		String	usageMessage,
		List< String >	aliases
	)

protected

Definition at line 37 of file Command.java.

References org.bukkit.command.Command.description, and org.bukkit.command.Command.usageMessage.

Member Function Documentation

static void org.bukkit.command.Command.broadcastCommandMessage	(	CommandSender	source,
		String	message
	)

static

Definition at line 328 of file Command.java.

static void org.bukkit.command.Command.broadcastCommandMessage	(	CommandSender	source,
		String	message,
		boolean	sendToSource
	)

static

Definition at line 332 of file Command.java.

References org.bukkit.Server.BROADCAST_CHANNEL_ADMINISTRATIVE, org.bukkit.Bukkit.getConsoleSender(), org.bukkit.command.CommandSender.getName(), org.bukkit.plugin.PluginManager.getPermissionSubscriptions(), org.bukkit.Bukkit.getPluginManager(), org.bukkit.ChatColor.GRAY, org.bukkit.ChatColor.ITALIC, and org.bukkit.command.CommandSender.sendMessage().

abstract boolean org.bukkit.command.Command.execute	(	CommandSender	sender,
		String	commandLabel,
		String[]	args
	)

pure virtual

Executes the command, returning its success.

Parameters

sender	Source object which is executing this command
commandLabel	The alias of the command used
args	All arguments passed to the command, split via ' '

Returns: true if the command was successful, otherwise false

Referenced by org.bukkit.command.SimpleCommandMap.dispatch().

List<String> org.bukkit.command.Command.getAliases ( )

Returns a list of active aliases of this command.

Returns: List of aliases

Definition at line 250 of file Command.java.

Referenced by org.bukkit.help.GenericCommandHelpTopic.GenericCommandHelpTopic().

String org.bukkit.command.Command.getDescription ( )

Gets a brief description of this command.

Returns: Description of this command

Definition at line 268 of file Command.java.

References org.bukkit.command.Command.description.

Referenced by org.bukkit.help.GenericCommandHelpTopic.GenericCommandHelpTopic().

String org.bukkit.command.Command.getLabel ( )

Returns the current lable for this command.

Returns: Label of this command or null if not registered

Definition at line 178 of file Command.java.

Referenced by org.bukkit.help.GenericCommandHelpTopic.GenericCommandHelpTopic().

String org.bukkit.command.Command.getName ( )

Returns the name of this command.

Returns: Name of this command

Definition at line 105 of file Command.java.

Referenced by org.bukkit.command.defaults.BanListCommand.execute(), and org.bukkit.command.defaults.VanillaCommand.matches().

String org.bukkit.command.Command.getPermission ( )

Gets the permission required by users to be able to perform this command.

Returns: Permission name, or null if none

Definition at line 114 of file Command.java.

String org.bukkit.command.Command.getPermissionMessage ( )

Returns a message to be displayed on a failed permission check for this command.

Returns: Permission check failed message

Definition at line 259 of file Command.java.

String org.bukkit.command.Command.getUsage ( )

Gets an example usage of this command.

Returns: One or more example usages

Definition at line 277 of file Command.java.

References org.bukkit.command.Command.usageMessage.

Referenced by org.bukkit.help.GenericCommandHelpTopic.GenericCommandHelpTopic().

boolean org.bukkit.command.Command.isRegistered ( )

Returns the current registered state of this command.

Returns: true if this command is currently registered false otherwise

Definition at line 241 of file Command.java.

Referenced by org.bukkit.help.GenericCommandHelpTopic.canSee(), org.bukkit.command.Command.setAliases(), and org.bukkit.command.Command.setLabel().

boolean org.bukkit.command.Command.register ( CommandMap commandMap )

Registers this command to a CommandMap Once called it only allows changes the registered CommandMap.

Parameters

commandMap the CommandMap to register this command to

Returns: true if the registration was successful (the current registered CommandMap was the passed CommandMap or null) false otherwise

Definition at line 206 of file Command.java.

Command org.bukkit.command.Command.setAliases ( List< String > aliases )

Sets the list of aliases to request on registration for this command.

Parameters

aliases Aliases to register to this command

Returns: This command object, for linking

Definition at line 287 of file Command.java.

References org.bukkit.command.Command.isRegistered().

Referenced by org.bukkit.command.PluginCommandYamlParser.parse(), org.bukkit.command.defaults.PluginsCommand.PluginsCommand(), org.bukkit.command.defaults.ReloadCommand.ReloadCommand(), and org.bukkit.command.defaults.VersionCommand.VersionCommand().

Command org.bukkit.command.Command.setDescription ( String description )

Sets a brief description of this command.

Parameters

description New command description

Returns: This command object, for linking

Definition at line 301 of file Command.java.

References org.bukkit.command.Command.description.

Referenced by org.bukkit.command.PluginCommandYamlParser.parse().

boolean org.bukkit.command.Command.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.

after a /reload

Parameters

name	The command's name

Returns: returns true if the name change happened instantly or false if it was scheduled for reregistration

Definition at line 190 of file Command.java.

References org.bukkit.command.Command.isRegistered().

void org.bukkit.command.Command.setPermission ( String permission )

Sets the permission required by users to be able to perform this command.

Parameters

permission Permission name or null

Definition at line 123 of file Command.java.

Command org.bukkit.command.Command.setPermissionMessage ( String permissionMessage )

Sets the message sent when a permission check fails.

Parameters

permissionMessage New permission message, null to indicate default message, or an empty string to indicate no message

Returns: This command object, for linking

Definition at line 312 of file Command.java.

Referenced by org.bukkit.command.PluginCommandYamlParser.parse().

Command org.bukkit.command.Command.setUsage ( String usage )

Sets the example usage of this command.

Parameters

usage New example usage

Returns: This command object, for linking

Definition at line 323 of file Command.java.

References org.bukkit.command.Command.usageMessage.

Referenced by org.bukkit.command.PluginCommandYamlParser.parse().

List<String> org.bukkit.command.Command.tabComplete	(	CommandSender	sender,
		String[]	args
	)

Deprecated:: This method is not supported and returns null

Definition at line 61 of file Command.java.

Referenced by org.bukkit.command.SimpleCommandMap.tabComplete().

List<String> org.bukkit.command.Command.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.

Parameters

sender	Source object which is executing this command
alias	the alias being used
args	All arguments passed to the command, split via ' '

Returns: a list of tab-completions for the specified arguments. This will never be null. List may be immutable.

Exceptions

IllegalArgumentException if sender, alias, or args is null

Definition at line 75 of file Command.java.

References org.bukkit.entity.Player.canSee(), and org.bukkit.util.StringUtil.startsWithIgnoreCase().

boolean org.bukkit.command.Command.testPermission ( CommandSender target )

Tests the given CommandSender to see if they can perform this command.

If they do not have permission, they will be informed that they cannot do this.

Parameters

target User to test

Returns: true if they can use it, otherwise false

Definition at line 135 of file Command.java.

References org.bukkit.ChatColor.RED, org.bukkit.command.CommandSender.sendMessage(), and org.bukkit.command.Command.testPermissionSilent().

boolean org.bukkit.command.Command.testPermissionSilent ( CommandSender target )

Tests the given CommandSender to see if they can perform this command.

No error is sent to the sender.

Parameters

target User to test

Returns: true if they can use it, otherwise false

Definition at line 159 of file Command.java.

References org.bukkit.permissions.Permissible.hasPermission().

Referenced by org.bukkit.help.GenericCommandHelpTopic.canSee(), org.bukkit.command.SimpleCommandMap.tabComplete(), and org.bukkit.command.Command.testPermission().

String org.bukkit.command.Command.toString ( )

Definition at line 361 of file Command.java.

boolean org.bukkit.command.Command.unregister ( CommandMap commandMap )

Unregisters this command from the passed CommandMap applying any outstanding changes.

Parameters

commandMap the CommandMap to unregister

Returns: true if the unregistration was successfull (the current registered CommandMap was the passed CommandMap or null) false otherwise

Definition at line 221 of file Command.java.

Member Data Documentation

String org.bukkit.command.Command.description = ""

protected

Definition at line 28 of file Command.java.

String org.bukkit.command.Command.usageMessage

protected

Definition at line 29 of file Command.java.

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

org/bukkit/command/Command.java

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation