net.minecraft.command

Interface ICommand

All Superinterfaces:

java.lang.Comparable<ICommand>

All Known Subinterfaces:

IClientCommand

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, CommandLocate, CommandMessage, CommandMessageRaw, CommandOp, CommandPardonIp, CommandPardonPlayer, CommandParticle, CommandPlaySound, CommandPublishLocalServer, CommandReplaceItem, CommandSaveAll, CommandSaveOff, CommandSaveOn, CommandScoreboard, CommandServerKick, CommandSetBlock, CommandSetDefaultSpawnpoint, CommandSetPlayerTimeout, CommandSetSpawnpoint, CommandShowSeed, CommandSpreadPlayers, CommandStats, CommandStop, CommandStopSound, CommandSummon, CommandTeleport, CommandTestFor, CommandTestForBlock, CommandTime, CommandTitle, CommandToggleDownfall, CommandTP, CommandTreeBase, CommandTrigger, CommandWeather, CommandWhitelist, CommandWorldBorder, CommandXP, ForgeCommand

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

Method Summary

Modifier and Type	Method and Description
boolean	checkPermission(MinecraftServer server, ICommandSender sender) Check if the given ICommandSender has permission to execute this command
void	execute(MinecraftServer server, ICommandSender sender, java.lang.String[] args) Callback for when the command is executed
java.util.List<java.lang.String>	getAliases() Get a list of aliases for this command.
java.lang.String	getName() Gets the name of the command
java.util.List<java.lang.String>	getTabCompletions(MinecraftServer server, ICommandSender sender, java.lang.String[] args, BlockPos targetPos) Get a list of options for when the user presses the TAB key
java.lang.String	getUsage(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.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

java.lang.String getName()

Gets the name of the command

getUsage

java.lang.String getUsage(ICommandSender sender)

Gets the usage string for the command.

Parameters:

sender - The ICommandSender who is requesting usage details

getAliases

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

Get a list of aliases for this command. Never return null!

execute

void execute(MinecraftServer server,
             ICommandSender sender,
             java.lang.String[] args)
      throws CommandException

Callback for when the command is executed

Parameters:

server - The server instance

sender - The sender who executed the command

args - The arguments that were passed

Throws:

CommandException

checkPermission

boolean checkPermission(MinecraftServer server,
                        ICommandSender sender)

Check if the given ICommandSender has permission to execute this command

Parameters:

server - The server instance

sender - The ICommandSender to check permissions on

getTabCompletions

java.util.List<java.lang.String> getTabCompletions(MinecraftServer server,
                                                   ICommandSender sender,
                                                   java.lang.String[] args,
                                                   BlockPos targetPos)

Get a list of options for when the user presses the TAB key

Parameters:

server - The server instance

sender - The ICommandSender to get tab completions for

args - Any arguments that were present when TAB was pressed

targetPos - The block that the player's mouse is over, null if the mouse is not over a block

isUsernameIndex

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

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

Parameters:

args - The arguments of the command invocation

index - The index