net.minecraft.command

Class CommandBase

java.lang.Object

net.minecraft.command.CommandBase

All Implemented Interfaces:

java.lang.Comparable<ICommand>, ICommand

Direct Known Subclasses:

CommandAchievement, CommandBanIp, CommandBanPlayer, CommandBlockData, CommandBroadcast, CommandClearInventory, CommandClone, CommandCompare, CommandDebug, 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 abstract class CommandBase
extends java.lang.Object
implements ICommand

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandBase.CoordinateArg

Constructor Summary

Constructors

Constructor and Description
CommandBase()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	addTabCompletionOptions(ICommandSender sender, java.lang.String[] args, BlockPos pos)
static java.lang.String	buildString(java.lang.String[] args, int startPos) Builds a string starting at startPos
boolean	canCommandSenderUseCommand(ICommandSender sender) Returns true if the given command sender is allowed to use this command.
int	compareTo(ICommand p_compareTo_1_)
static boolean	doesStringStartWith(java.lang.String original, java.lang.String region) Returns true if the given substring is exactly equal to the start of the given string (case insensitive).
static java.util.List<Entity>	func_175763_c(ICommandSender p_175763_0_, java.lang.String p_175763_1_)
static Entity	func_175768_b(ICommandSender p_175768_0_, java.lang.String p_175768_1_)
static java.util.List<java.lang.String>	func_175771_a(java.lang.String[] p_175771_0_, int p_175771_1_, BlockPos p_175771_2_)
static java.util.List<java.lang.String>	func_181043_b(java.lang.String[] p_181043_0_, int p_181043_1_, BlockPos p_181043_2_)
static Block	getBlockByText(ICommandSender sender, java.lang.String id) Gets the Block specified by the given text string.
static IChatComponent	getChatComponentFromNthArg(ICommandSender sender, java.lang.String[] args, int p_147178_2_)
static IChatComponent	getChatComponentFromNthArg(ICommandSender sender, java.lang.String[] args, int index, boolean p_147176_3_)
java.util.List<java.lang.String>	getCommandAliases()
static EntityPlayerMP	getCommandSenderAsPlayer(ICommandSender sender) Returns the given ICommandSender as a EntityPlayer or throw an exception.
static <T extends Entity> T	getEntity(ICommandSender commandSender, java.lang.String p_175759_1_, java.lang.Class<? extends T> p_175759_2_)
static java.lang.String	getEntityName(ICommandSender p_175758_0_, java.lang.String p_175758_1_) Attempts to retrieve an entity's name, first assuming that the entity is a player, and then exhausting all other possibilities.
static Item	getItemByText(ICommandSender sender, java.lang.String id) Gets the Item specified by the given text string.
static java.util.List<java.lang.String>	getListOfStringsMatchingLastWord(java.lang.String[] p_175762_0_, java.util.Collection<?> p_175762_1_)
static java.util.List<java.lang.String>	getListOfStringsMatchingLastWord(java.lang.String[] args, java.lang.String... possibilities)
static EntityPlayerMP	getPlayer(ICommandSender sender, java.lang.String username)
static java.lang.String	getPlayerName(ICommandSender sender, java.lang.String query)
int	getRequiredPermissionLevel() Return the required permission level for this command.
boolean	isUsernameIndex(java.lang.String[] args, int index) Return whether the specified command parameter index is a username parameter.
static IChatComponent	join(java.util.List<IChatComponent> components)
static java.lang.String	joinNiceString(java.lang.Object[] elements) Creates a linguistic series joining the input objects together.
static java.lang.String	joinNiceStringFromCollection(java.util.Collection<java.lang.String> strings) Creates a linguistic series joining together the elements of the given collection.
static void	notifyOperators(ICommandSender sender, ICommand command, int p_152374_2_, java.lang.String msgFormat, java.lang.Object... msgParams)
static void	notifyOperators(ICommandSender sender, ICommand command, java.lang.String msgFormat, java.lang.Object... msgParams)
static BlockPos	parseBlockPos(ICommandSender sender, java.lang.String[] args, int startIndex, boolean centerBlock)
static boolean	parseBoolean(java.lang.String input)
static CommandBase.CoordinateArg	parseCoordinate(double base, java.lang.String p_175770_2_, boolean centerBlock)
static CommandBase.CoordinateArg	parseCoordinate(double p_175767_0_, java.lang.String p_175767_2_, int min, int max, boolean centerBlock)
static double	parseDouble(double base, java.lang.String input, boolean centerBlock)
static double	parseDouble(double base, java.lang.String input, int min, int max, boolean centerBlock)
static double	parseDouble(java.lang.String input)
static double	parseDouble(java.lang.String input, double min)
static double	parseDouble(java.lang.String input, double min, double max)
static int	parseInt(java.lang.String input)
static int	parseInt(java.lang.String input, int min)
static int	parseInt(java.lang.String input, int min, int max)
static long	parseLong(java.lang.String input)
static long	parseLong(java.lang.String input, long min, long max)
static void	setAdminCommander(IAdminCommand command) Sets the static IAdminCommander.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.command.ICommand

getCommandName, getCommandUsage, processCommand

Constructor Detail

CommandBase

public CommandBase()

Method Detail

getRequiredPermissionLevel

public int getRequiredPermissionLevel()

Return the required permission level for this command.

getCommandAliases

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

Specified by:

getCommandAliases in interface ICommand

canCommandSenderUseCommand

public boolean canCommandSenderUseCommand(ICommandSender sender)

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

Specified by:

canCommandSenderUseCommand in interface ICommand

addTabCompletionOptions

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

Specified by:

addTabCompletionOptions in interface ICommand

parseInt

public static int parseInt(java.lang.String input)
                    throws NumberInvalidException

Throws:

NumberInvalidException

parseInt

public static int parseInt(java.lang.String input,
                           int min)
                    throws NumberInvalidException

Throws:

NumberInvalidException

parseInt

public static int parseInt(java.lang.String input,
                           int min,
                           int max)
                    throws NumberInvalidException

Throws:

NumberInvalidException

parseLong

public static long parseLong(java.lang.String input)
                      throws NumberInvalidException

Throws:

NumberInvalidException

parseLong

public static long parseLong(java.lang.String input,
                             long min,
                             long max)
                      throws NumberInvalidException

Throws:

NumberInvalidException

parseBlockPos

public static BlockPos parseBlockPos(ICommandSender sender,
                                     java.lang.String[] args,
                                     int startIndex,
                                     boolean centerBlock)
                              throws NumberInvalidException

Throws:

NumberInvalidException

parseDouble

public static double parseDouble(java.lang.String input)
                          throws NumberInvalidException

Throws:

NumberInvalidException

parseDouble

public static double parseDouble(java.lang.String input,
                                 double min)
                          throws NumberInvalidException

Throws:

NumberInvalidException

parseDouble

public static double parseDouble(java.lang.String input,
                                 double min,
                                 double max)
                          throws NumberInvalidException

Throws:

NumberInvalidException

parseBoolean

public static boolean parseBoolean(java.lang.String input)
                            throws CommandException

Throws:

CommandException

getCommandSenderAsPlayer

public static EntityPlayerMP getCommandSenderAsPlayer(ICommandSender sender)
                                               throws PlayerNotFoundException

Returns the given ICommandSender as a EntityPlayer or throw an exception.

Throws:

PlayerNotFoundException

getPlayer

public static EntityPlayerMP getPlayer(ICommandSender sender,
                                       java.lang.String username)
                                throws PlayerNotFoundException

Throws:

PlayerNotFoundException

func_175768_b

public static Entity func_175768_b(ICommandSender p_175768_0_,
                                   java.lang.String p_175768_1_)
                            throws EntityNotFoundException

Throws:

EntityNotFoundException

getEntity

public static <T extends Entity> T getEntity(ICommandSender commandSender,
                                             java.lang.String p_175759_1_,
                                             java.lang.Class<? extends T> p_175759_2_)
                                      throws EntityNotFoundException

Throws:

EntityNotFoundException

func_175763_c

public static java.util.List<Entity> func_175763_c(ICommandSender p_175763_0_,
                                                   java.lang.String p_175763_1_)
                                            throws EntityNotFoundException

Throws:

EntityNotFoundException

getPlayerName

public static java.lang.String getPlayerName(ICommandSender sender,
                                             java.lang.String query)
                                      throws PlayerNotFoundException

Throws:

PlayerNotFoundException

getEntityName

public static java.lang.String getEntityName(ICommandSender p_175758_0_,
                                             java.lang.String p_175758_1_)
                                      throws EntityNotFoundException

Attempts to retrieve an entity's name, first assuming that the entity is a player, and then exhausting all other possibilities.

Throws:

EntityNotFoundException

getChatComponentFromNthArg

public static IChatComponent getChatComponentFromNthArg(ICommandSender sender,
                                                        java.lang.String[] args,
                                                        int p_147178_2_)
                                                 throws CommandException,
                                                        PlayerNotFoundException

Throws:

CommandException

PlayerNotFoundException

getChatComponentFromNthArg

public static IChatComponent getChatComponentFromNthArg(ICommandSender sender,
                                                        java.lang.String[] args,
                                                        int index,
                                                        boolean p_147176_3_)
                                                 throws PlayerNotFoundException

Throws:

PlayerNotFoundException

buildString

public static java.lang.String buildString(java.lang.String[] args,
                                           int startPos)

Builds a string starting at startPos

parseCoordinate

public static CommandBase.CoordinateArg parseCoordinate(double base,
                                                        java.lang.String p_175770_2_,
                                                        boolean centerBlock)
                                                 throws NumberInvalidException

Throws:

NumberInvalidException

parseCoordinate

public static CommandBase.CoordinateArg parseCoordinate(double p_175767_0_,
                                                        java.lang.String p_175767_2_,
                                                        int min,
                                                        int max,
                                                        boolean centerBlock)
                                                 throws NumberInvalidException

Throws:

NumberInvalidException

parseDouble

public static double parseDouble(double base,
                                 java.lang.String input,
                                 boolean centerBlock)
                          throws NumberInvalidException

Throws:

NumberInvalidException

parseDouble

public static double parseDouble(double base,
                                 java.lang.String input,
                                 int min,
                                 int max,
                                 boolean centerBlock)
                          throws NumberInvalidException

Throws:

NumberInvalidException

getItemByText

public static Item getItemByText(ICommandSender sender,
                                 java.lang.String id)
                          throws NumberInvalidException

Gets the Item specified by the given text string. First checks the item registry, then tries by parsing the string as an integer ID (deprecated). Warns the sender if we matched by parsing the ID. Throws if the item wasn't found. Returns the item if it was found.

Throws:

NumberInvalidException

getBlockByText

public static Block getBlockByText(ICommandSender sender,
                                   java.lang.String id)
                            throws NumberInvalidException

Gets the Block specified by the given text string. First checks the block registry, then tries by parsing the string as an integer ID (deprecated). Warns the sender if we matched by parsing the ID. Throws if the block wasn't found. Returns the block if it was found.

Throws:

NumberInvalidException

joinNiceString

public static java.lang.String joinNiceString(java.lang.Object[] elements)

Creates a linguistic series joining the input objects together. Examples: 1) {} --> "", 2) {"Steve"} --> "Steve", 3) {"Steve", "Phil"} --> "Steve and Phil", 4) {"Steve", "Phil", "Mark"} --> "Steve, Phil and Mark"

join

public static IChatComponent join(java.util.List<IChatComponent> components)

joinNiceStringFromCollection

public static java.lang.String joinNiceStringFromCollection(java.util.Collection<java.lang.String> strings)

Creates a linguistic series joining together the elements of the given collection. Examples: 1) {} --> "", 2) {"Steve"} --> "Steve", 3) {"Steve", "Phil"} --> "Steve and Phil", 4) {"Steve", "Phil", "Mark"} --> "Steve, Phil and Mark"

func_175771_a

public static java.util.List<java.lang.String> func_175771_a(java.lang.String[] p_175771_0_,
                                                             int p_175771_1_,
                                                             BlockPos p_175771_2_)

func_181043_b

public static java.util.List<java.lang.String> func_181043_b(java.lang.String[] p_181043_0_,
                                                             int p_181043_1_,
                                                             BlockPos p_181043_2_)

doesStringStartWith

public static boolean doesStringStartWith(java.lang.String original,
                                          java.lang.String region)

Returns true if the given substring is exactly equal to the start of the given string (case insensitive).

getListOfStringsMatchingLastWord

public static java.util.List<java.lang.String> getListOfStringsMatchingLastWord(java.lang.String[] args,
                                                                                java.lang.String... possibilities)

getListOfStringsMatchingLastWord

public static java.util.List<java.lang.String> getListOfStringsMatchingLastWord(java.lang.String[] p_175762_0_,
                                                                                java.util.Collection<?> p_175762_1_)

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

Parameters:

args - The arguments that were passed

notifyOperators

public static void notifyOperators(ICommandSender sender,
                                   ICommand command,
                                   java.lang.String msgFormat,
                                   java.lang.Object... msgParams)

notifyOperators

public static void notifyOperators(ICommandSender sender,
                                   ICommand command,
                                   int p_152374_2_,
                                   java.lang.String msgFormat,
                                   java.lang.Object... msgParams)

setAdminCommander

public static void setAdminCommander(IAdminCommand command)

Sets the static IAdminCommander.

compareTo

public int compareTo(ICommand p_compareTo_1_)

Specified by:

compareTo in interface java.lang.Comparable<ICommand>