net.minecraft.command

Class CommandEffect

java.lang.Object

net.minecraft.command.CommandBase

net.minecraft.command.CommandEffect

All Implemented Interfaces:

java.lang.Comparable<ICommand>, ICommand

public class CommandEffect
extends CommandBase

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.command.CommandBase

CommandBase.CoordinateArg

Constructor Summary

Constructors

Constructor and Description
CommandEffect()

Method Summary

Modifier and Type	Method and Description
void	execute(MinecraftServer server, ICommandSender sender, java.lang.String[] args) Callback for when the command is executed
java.lang.String	getName() Gets the name of the command
int	getRequiredPermissionLevel() Return the required permission level for this 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 class net.minecraft.command.CommandBase

buildString, checkPermission, compareTo, convertArgToBlockState, convertArgToBlockStatePredicate, doesStringStartWith, entityToNBT, getAliases, getBlockByText, getChatComponentFromNthArg, getChatComponentFromNthArg, getCommandSenderAsPlayer, getEntity, getEntity, getEntityList, getEntityName, getItemByText, getListOfStringsMatchingLastWord, getListOfStringsMatchingLastWord, getPlayer, getPlayerName, getTabCompletionCoordinate, getTabCompletionCoordinateXZ, join, joinNiceString, joinNiceStringFromCollection, notifyCommandListener, notifyCommandListener, parseBlockPos, parseBoolean, parseCoordinate, parseCoordinate, parseDouble, parseDouble, parseDouble, parseDouble, parseDouble, parseInt, parseInt, parseInt, parseLong, parseLong, setCommandListener, toSyntaxException

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandEffect

public CommandEffect()

Method Detail

getName

public java.lang.String getName()

Gets the name of the command

getRequiredPermissionLevel

public int getRequiredPermissionLevel()

Return the required permission level for this command.

Overrides:

getRequiredPermissionLevel in class CommandBase

getUsage

public java.lang.String getUsage(ICommandSender sender)

Gets the usage string for the command.

Parameters:

sender - The ICommandSender who is requesting usage details

execute

public 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

getTabCompletions

public 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

Specified by:

getTabCompletions in interface ICommand

Overrides:

getTabCompletions in class CommandBase

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

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

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

Specified by:

isUsernameIndex in interface ICommand

Overrides:

isUsernameIndex in class CommandBase

Parameters:

args - The arguments of the command invocation

index - The index