net.minecraft.command

Class CommandHandler

java.lang.Object

net.minecraft.command.CommandHandler

All Implemented Interfaces:

ICommandManager

Direct Known Subclasses:

ClientCommandHandler, ServerCommandManager

public abstract class CommandHandler
extends java.lang.Object
implements ICommandManager

Constructor Summary

Constructors

Constructor and Description
CommandHandler()

Method Summary

Modifier and Type	Method and Description
int	executeCommand(ICommandSender sender, java.lang.String rawCommand) Attempt to execute a command.
java.util.Map<java.lang.String,ICommand>	getCommands() Get a Map of all the name to command pairs stored in this command manager.
java.util.List<ICommand>	getPossibleCommands(ICommandSender sender) Get a list of commands that the given command sender has access to execute.
protected abstract MinecraftServer	getServer()
java.util.List<java.lang.String>	getTabCompletions(ICommandSender sender, java.lang.String input, BlockPos pos) Get a list of possible completion options for when the TAB key is pressed.
ICommand	registerCommand(ICommand command) adds the command and any aliases it has to the internal map of available commands
protected boolean	tryExecute(ICommandSender sender, java.lang.String[] args, ICommand command, java.lang.String input)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandHandler

public CommandHandler()

Method Detail

executeCommand

public int executeCommand(ICommandSender sender,
                          java.lang.String rawCommand)

Attempt to execute a command. This method should return the number of times that the command was executed. If the command does not exist or if the player does not have permission, 0 will be returned. A number greater than 1 can be returned if a player selector is used.

Specified by:

executeCommand in interface ICommandManager

Parameters:

sender - The source of the command invocation

rawCommand - The raw string that was typed

tryExecute

protected boolean tryExecute(ICommandSender sender,
                             java.lang.String[] args,
                             ICommand command,
                             java.lang.String input)

getServer

protected abstract MinecraftServer getServer()

registerCommand

public ICommand registerCommand(ICommand command)

adds the command and any aliases it has to the internal map of available commands

getTabCompletions

public java.util.List<java.lang.String> getTabCompletions(ICommandSender sender,
                                                          java.lang.String input,
                                                          BlockPos pos)

Get a list of possible completion options for when the TAB key is pressed. This can be a list of commands if no command is specified or a partial command is specified. It could also be a list of arguments for the command that is specified.

Specified by:

getTabCompletions in interface ICommandManager

getPossibleCommands

public java.util.List<ICommand> getPossibleCommands(ICommandSender sender)

Get a list of commands that the given command sender has access to execute.

Specified by:

getPossibleCommands in interface ICommandManager

getCommands

public java.util.Map<java.lang.String,ICommand> getCommands()

Get a Map of all the name to command pairs stored in this command manager.

Specified by:

getCommands in interface ICommandManager