org.bukkit.command

クラス SimpleCommandMap

java.lang.Object

org.bukkit.command.SimpleCommandMap

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

CommandMap

public class SimpleCommandMap
extends Object
implements CommandMap

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected Map<String,Command>	knownCommands

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

コンストラクタ

コンストラクタと説明
SimpleCommandMap(Server server)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	clearCommands() Clears all registered commands.
boolean	dispatch(CommandSender sender, String commandLine) Looks for the requested command and executes it if found.
Command	getCommand(String name) Gets the command registered to the specified name
Collection<Command>	getCommands()
boolean	register(String fallbackPrefix, Command command) Registers a command.
boolean	register(String label, String fallbackPrefix, Command command) Registers a command.
void	registerAll(String fallbackPrefix, List<Command> commands) Registers all the commands belonging to a certain plugin.
void	registerServerAliases()
void	setFallbackCommands()
List<String>	tabComplete(CommandSender sender, String cmdLine) Looks for the requested command and executes an appropriate tab-completer if found.

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

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

フィールドの詳細

knownCommands

protected final Map<String,Command> knownCommands

コンストラクタの詳細

SimpleCommandMap

public SimpleCommandMap(Server server)

メソッドの詳細

setFallbackCommands

public void setFallbackCommands()

registerAll

public void registerAll(String fallbackPrefix,
                        List<Command> commands)

Registers all the commands belonging to a certain plugin.

Caller can use:-

• command.getName() to determine the label registered for this command
• command.getAliases() to determine the aliases which where registered

定義:

registerAll インタフェース内 CommandMap

パラメータ:

fallbackPrefix - a prefix which is prepended to each command with a ':' one or more times to make the command unique

commands - a list of commands to register

register

public boolean register(String fallbackPrefix,
                        Command command)

Registers a command. Returns true on success; false if name is already taken and fallback had to be used.

Caller can use:-

• command.getName() to determine the label registered for this command
• command.getAliases() to determine the aliases which where registered

定義:

register インタフェース内 CommandMap

パラメータ:

fallbackPrefix - a prefix which is prepended to the command with a ':' one or more times to make the command unique

command - the command to register, from which label is determined from the command name

戻り値:

true if command was registered with the passed in label, false otherwise, which indicates the fallbackPrefix was used one or more times

register

public boolean register(String label,
                        String fallbackPrefix,
                        Command command)

Registers a command. Returns true on success; false if name is already taken and fallback had to be used.

Caller can use:-

• command.getName() to determine the label registered for this command
• command.getAliases() to determine the aliases which where registered

定義:

register インタフェース内 CommandMap

パラメータ:

label - the label of the command, without the '/'-prefix.

fallbackPrefix - a prefix which is prepended to the command with a ':' one or more times to make the command unique

command - the command to register

戻り値:

true if command was registered with the passed in label, false otherwise, which indicates the fallbackPrefix was used one or more times

dispatch

public boolean dispatch(CommandSender sender,
                        String commandLine)
                 throws CommandException

Looks for the requested command and executes it if found.

定義:

dispatch インタフェース内 CommandMap

パラメータ:

sender - The command's sender

commandLine - command + arguments. Example: "/test abc 123"

戻り値:

returns false if no target is found, true otherwise.

例外:

CommandException - Thrown when the executor for the given command fails with an unhandled exception

clearCommands

public void clearCommands()

インタフェースからコピーされた説明: CommandMap

Clears all registered commands.

定義:

clearCommands インタフェース内 CommandMap

getCommand

public Command getCommand(String name)

インタフェースからコピーされた説明: CommandMap

Gets the command registered to the specified name

定義:

getCommand インタフェース内 CommandMap

パラメータ:

name - Name of the command to retrieve

戻り値:

Command with the specified name or null if a command with that label doesn't exist

tabComplete

public List<String> tabComplete(CommandSender sender,
                                String cmdLine)

インタフェースからコピーされた説明: CommandMap

Looks for the requested command and executes an appropriate tab-completer if found. This method will also tab-complete partial commands.

定義:

tabComplete インタフェース内 CommandMap

パラメータ:

sender - The command's sender.

cmdLine - The entire command string to tab-complete, excluding initial slash.

戻り値:

a list of possible tab-completions. This list may be immutable. Will be null if no matching command of which sender has permission.

getCommands

public Collection<Command> getCommands()

registerServerAliases

public void registerServerAliases()