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, 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 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
static java.lang.String	buildString(java.lang.String[] args, int startPos) Builds a string starting at startPos
boolean	checkPermission(MinecraftServer server, ICommandSender sender) Check if the given ICommandSender has permission to execute this command
int	compareTo(ICommand p_compareTo_1_)
static IBlockState	convertArgToBlockState(Block p_190794_0_, java.lang.String p_190794_1_)
static <any>	convertArgToBlockStatePredicate(Block p_190791_0_, java.lang.String p_190791_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).
protected static NBTTagCompound	entityToNBT(Entity theEntity)
java.util.List<java.lang.String>	getAliases() Get a list of aliases for this command.
static Block	getBlockByText(ICommandSender sender, java.lang.String id) Gets the Block specified by the given text string.
static ITextComponent	getChatComponentFromNthArg(ICommandSender sender, java.lang.String[] args, int index)
static ITextComponent	getChatComponentFromNthArg(ICommandSender sender, java.lang.String[] args, int index, boolean p_147176_3_)
static EntityPlayerMP	getCommandSenderAsPlayer(ICommandSender sender) Returns the given ICommandSender as a EntityPlayer or throw an exception.
static Entity	getEntity(MinecraftServer server, ICommandSender sender, java.lang.String target)
static <T extends Entity> T	getEntity(MinecraftServer server, ICommandSender sender, java.lang.String target, java.lang.Class<? extends T> targetClass)
static java.util.List<Entity>	getEntityList(MinecraftServer server, ICommandSender sender, java.lang.String target)
static java.lang.String	getEntityName(MinecraftServer server, ICommandSender sender, java.lang.String target)
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[] inputArgs, java.util.Collection<?> possibleCompletions)
static java.util.List<java.lang.String>	getListOfStringsMatchingLastWord(java.lang.String[] args, java.lang.String... possibilities) Returns a List of strings (chosen from the given strings) which the last word in the given string array is a beginning-match for.
static EntityPlayerMP	getPlayer(MinecraftServer server, ICommandSender sender, java.lang.String target)
static java.lang.String	getPlayerName(MinecraftServer server, ICommandSender sender, java.lang.String target)
int	getRequiredPermissionLevel() Return the required permission level for this command.
static java.util.List<java.lang.String>	getTabCompletionCoordinate(java.lang.String[] inputArgs, int index, BlockPos pos)
static java.util.List<java.lang.String>	getTabCompletionCoordinateXZ(java.lang.String[] inputArgs, int index, BlockPos lookedPos)
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
boolean	isUsernameIndex(java.lang.String[] args, int index) Return whether the specified command parameter index is a username parameter.
static ITextComponent	join(java.util.List<ITextComponent> 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	notifyCommandListener(ICommandSender sender, ICommand command, int flags, java.lang.String translationKey, java.lang.Object... translationArgs)
static void	notifyCommandListener(ICommandSender sender, ICommand command, java.lang.String translationKey, java.lang.Object... translationArgs)
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 selectorArg, boolean centerBlock)
static CommandBase.CoordinateArg	parseCoordinate(double base, java.lang.String selectorArg, 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	setCommandListener(ICommandListener listener) Sets the command listener responsable for notifying server operators when asked to by commands
protected static SyntaxErrorException	toSyntaxException(JsonParseException e) Convert a JsonParseException into a user-friendly exception

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

execute, getName, getUsage

Constructor Detail

CommandBase

public CommandBase()

Method Detail

toSyntaxException

protected static SyntaxErrorException toSyntaxException(JsonParseException e)

Convert a JsonParseException into a user-friendly exception

entityToNBT

protected static NBTTagCompound entityToNBT(Entity theEntity)

getRequiredPermissionLevel

public int getRequiredPermissionLevel()

Return the required permission level for this command.

getAliases

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

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

Specified by:

getAliases in interface ICommand

checkPermission

public boolean checkPermission(MinecraftServer server,
                               ICommandSender sender)

Check if the given ICommandSender has permission to execute this command

Specified by:

checkPermission in interface ICommand

Parameters:

server - The server instance

sender - The ICommandSender to check permissions on

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

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

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(MinecraftServer server,
                                       ICommandSender sender,
                                       java.lang.String target)
                                throws PlayerNotFoundException,
                                       CommandException

Throws:

PlayerNotFoundException

CommandException

getEntity

public static Entity getEntity(MinecraftServer server,
                               ICommandSender sender,
                               java.lang.String target)
                        throws EntityNotFoundException,
                               CommandException

Throws:

EntityNotFoundException

CommandException

getEntity

public static <T extends Entity> T getEntity(MinecraftServer server,
                                             ICommandSender sender,
                                             java.lang.String target,
                                             java.lang.Class<? extends T> targetClass)
                                      throws EntityNotFoundException,
                                             CommandException

Throws:

EntityNotFoundException

CommandException

getEntityList

public static java.util.List<Entity> getEntityList(MinecraftServer server,
                                                   ICommandSender sender,
                                                   java.lang.String target)
                                            throws EntityNotFoundException,
                                                   CommandException

Throws:

EntityNotFoundException

CommandException

getPlayerName

public static java.lang.String getPlayerName(MinecraftServer server,
                                             ICommandSender sender,
                                             java.lang.String target)
                                      throws PlayerNotFoundException,
                                             CommandException

Throws:

PlayerNotFoundException

CommandException

getEntityName

public static java.lang.String getEntityName(MinecraftServer server,
                                             ICommandSender sender,
                                             java.lang.String target)
                                      throws EntityNotFoundException,
                                             CommandException

Throws:

EntityNotFoundException

CommandException

getChatComponentFromNthArg

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

Throws:

CommandException

PlayerNotFoundException

getChatComponentFromNthArg

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

Throws:

PlayerNotFoundException

CommandException

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 selectorArg,
                                                        boolean centerBlock)
                                                 throws NumberInvalidException

Throws:

NumberInvalidException

parseCoordinate

public static CommandBase.CoordinateArg parseCoordinate(double base,
                                                        java.lang.String selectorArg,
                                                        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

convertArgToBlockState

public static IBlockState convertArgToBlockState(Block p_190794_0_,
                                                 java.lang.String p_190794_1_)
                                          throws NumberInvalidException,
                                                 InvalidBlockStateException

Throws:

NumberInvalidException

InvalidBlockStateException

convertArgToBlockStatePredicate

public static <any> convertArgToBlockStatePredicate(Block p_190791_0_,
                                                    java.lang.String p_190791_1_)
                                             throws InvalidBlockStateException

Throws:

InvalidBlockStateException

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 ITextComponent join(java.util.List<ITextComponent> 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"

getTabCompletionCoordinate

public static java.util.List<java.lang.String> getTabCompletionCoordinate(java.lang.String[] inputArgs,
                                                                          int index,
                                                                          BlockPos pos)

getTabCompletionCoordinateXZ

public static java.util.List<java.lang.String> getTabCompletionCoordinateXZ(java.lang.String[] inputArgs,
                                                                            int index,
                                                                            BlockPos lookedPos)

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)

Returns a List of strings (chosen from the given strings) which the last word in the given string array is a beginning-match for. (Tab completion).

getListOfStringsMatchingLastWord

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

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 of the command invocation

index - The index

notifyCommandListener

public static void notifyCommandListener(ICommandSender sender,
                                         ICommand command,
                                         java.lang.String translationKey,
                                         java.lang.Object... translationArgs)

notifyCommandListener

public static void notifyCommandListener(ICommandSender sender,
                                         ICommand command,
                                         int flags,
                                         java.lang.String translationKey,
                                         java.lang.Object... translationArgs)

setCommandListener

public static void setCommandListener(ICommandListener listener)

Sets the command listener responsable for notifying server operators when asked to by commands

compareTo

public int compareTo(ICommand p_compareTo_1_)

Specified by:

compareTo in interface java.lang.Comparable<ICommand>