org.bukkit.command

クラス PluginCommand

java.lang.Object

org.bukkit.command.Command

org.bukkit.command.PluginCommand

すべての実装されたインタフェース:

PluginIdentifiableCommand

public final class PluginCommand
extends Command
implements PluginIdentifiableCommand

Represents a Command belonging to a plugin

フィールドのサマリー

クラスから継承されたフィールド org.bukkit.command.Command

description, timings, usageMessage

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	PluginCommand(String name, Plugin owner)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	execute(CommandSender sender, String commandLabel, String[] args) Executes the command, returning its success
CommandExecutor	getExecutor() Gets the CommandExecutor associated with this command
Plugin	getPlugin() Gets the owner of this PluginCommand
TabCompleter	getTabCompleter() Gets the TabCompleter associated with this command.
void	setExecutor(CommandExecutor executor) Sets the CommandExecutor to run when parsing this command
void	setTabCompleter(TabCompleter completer) Sets the TabCompleter to run when tab-completing this command.
List<String>	tabComplete(CommandSender sender, String alias, String[] args) Executed on tab completion for this command, returning a list of options the player can tab through.
String	toString()

クラスから継承されたメソッド org.bukkit.command.Command

broadcastCommandMessage, broadcastCommandMessage, getAliases, getDescription, getLabel, getName, getPermission, getPermissionMessage, getUsage, isRegistered, register, setAliases, setDescription, setLabel, setName, setPermission, setPermissionMessage, setUsage, tabComplete, testPermission, testPermissionSilent, unregister

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

PluginCommand

protected PluginCommand(String name,
                        Plugin owner)

メソッドの詳細

execute

public boolean execute(CommandSender sender,
                       String commandLabel,
                       String[] args)

Executes the command, returning its success

定義:

execute クラス内 Command

パラメータ:

sender - Source object which is executing this command

commandLabel - The alias of the command used

args - All arguments passed to the command, split via ' '

戻り値:

true if the command was successful, otherwise false

setExecutor

public void setExecutor(CommandExecutor executor)

Sets the CommandExecutor to run when parsing this command

パラメータ:

executor - New executor to run

getExecutor

public CommandExecutor getExecutor()

Gets the CommandExecutor associated with this command

戻り値:

CommandExecutor object linked to this command

setTabCompleter

public void setTabCompleter(TabCompleter completer)

Sets the TabCompleter to run when tab-completing this command.

If no TabCompleter is specified, and the command's executor implements TabCompleter, then the executor will be used for tab completion.

パラメータ:

completer - New tab completer

getTabCompleter

public TabCompleter getTabCompleter()

Gets the TabCompleter associated with this command.

戻り値:

TabCompleter object linked to this command

getPlugin

public Plugin getPlugin()

Gets the owner of this PluginCommand

定義:

getPlugin インタフェース内 PluginIdentifiableCommand

戻り値:

Plugin that owns this command

tabComplete

public List<String> tabComplete(CommandSender sender,
                                String alias,
                                String[] args)
                         throws CommandException,
                                IllegalArgumentException

Executed on tab completion for this command, returning a list of options the player can tab through.

Delegates to the tab completer if present.

If it is not present or returns null, will delegate to the current command executor if it implements TabCompleter. If a non-null list has not been found, will default to standard player name completion in Command.tabComplete(CommandSender, String, String[]).

This method does not consider permissions.

オーバーライド:

tabComplete クラス内 Command

パラメータ:

sender - Source object which is executing this command

alias - the alias being used

args - All arguments passed to the command, split via ' '

戻り値:

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

例外:

CommandException - if the completer or executor throw an exception during the process of tab-completing.

IllegalArgumentException - if sender, alias, or args is null

toString

public String toString()

オーバーライド:

toString クラス内 Command