net.minecraft.command

Interface ICommand

All Superinterfaces:

java.lang.Comparable<ICommand>

All Known Implementing Classes:

CommandAchievement, CommandBanIp, CommandBanPlayer, CommandBase, CommandBlockData, CommandBroadcast, CommandClearInventory, CommandClone, CommandCompare, CommandDebug, CommandDefaultGameMode, CommandDeOp, CommandDifficulty, CommandEffect, CommandEmote, CommandEnchant, CommandEntityData, CommandExecuteAt, CommandFill, CommandGameMode, CommandGameRule, CommandGive, CommandHelp, CommandKill, CommandListBans, CommandListPlayers, CommandMessage, CommandMessageRaw, CommandOp, CommandPardonIp, CommandPardonPlayer, CommandParticle, CommandPlaySound, CommandPublishLocalServer, CommandReplaceItem, CommandSaveAll, CommandSaveOff, CommandSaveOn, CommandScoreboard, CommandServerKick, CommandSetBlock, CommandSetDefaultSpawnpoint, CommandSetPlayerTimeout, CommandSetSpawnpoint, CommandShowSeed, CommandSpreadPlayers, CommandStats, CommandStop, CommandSummon, CommandTeleport, CommandTestFor, CommandTestForBlock, CommandTime, CommandTitle, CommandToggleDownfall, CommandTrigger, CommandWeather, CommandWhitelist, CommandWorldBorder, CommandXP, ForgeCommand

public interface ICommand
extends java.lang.Comparable<ICommand>

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	addTabCompletionOptions(ICommandSender sender, java.lang.String[] args, BlockPos pos)
boolean	canCommandSenderUseCommand(ICommandSender sender) Returns true if the given command sender is allowed to use this command.
java.util.List<java.lang.String>	getCommandAliases()
java.lang.String	getCommandName() Gets the name of the command
java.lang.String	getCommandUsage(ICommandSender sender) Gets the usage string for the command.
boolean	isUsernameIndex(java.lang.String[] args, int index) Return whether the specified command parameter index is a username parameter.
void	processCommand(ICommandSender sender, java.lang.String[] args) Callback when the command is invoked

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getCommandName

java.lang.String getCommandName()

Gets the name of the command

getCommandUsage

java.lang.String getCommandUsage(ICommandSender sender)

Gets the usage string for the command.

Parameters:

sender - The command sender that executed the command

getCommandAliases

java.util.List<java.lang.String> getCommandAliases()

processCommand

void processCommand(ICommandSender sender,
                    java.lang.String[] args)
             throws CommandException

Callback when the command is invoked

Parameters:

sender - The command sender that executed the command

args - The arguments that were passed

Throws:

CommandException

canCommandSenderUseCommand

boolean canCommandSenderUseCommand(ICommandSender sender)

Returns true if the given command sender is allowed to use this command.

addTabCompletionOptions

java.util.List<java.lang.String> addTabCompletionOptions(ICommandSender sender,
                                                         java.lang.String[] args,
                                                         BlockPos pos)

isUsernameIndex

boolean isUsernameIndex(java.lang.String[] args,
                        int index)

Return whether the specified command parameter index is a username parameter.

Parameters:

args - The arguments that were passed