net.minecraftforge.server.command

Class CommandTreeBase

java.lang.Object

net.minecraft.command.CommandBase

net.minecraftforge.server.command.CommandTreeBase

All Implemented Interfaces:

java.lang.Comparable<ICommand>, ICommand

public abstract class CommandTreeBase
extends CommandBase

Base class for commands that has subcommands.

E.g. /team settings set [value] settings is subcommand of team and set is subcommand of settings

Nested Class Summary

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

CommandBase.CoordinateArg

Constructor Summary

Constructors

Constructor and Description
CommandTreeBase()

Method Summary

Modifier and Type	Method and Description
void	addSubcommand(ICommand c)
void	execute(MinecraftServer server, ICommandSender sender, java.lang.String[] args) Callback for when the command is executed
java.util.Map<java.lang.String,ICommand>	getCommandMap()
java.util.List<ICommand>	getSortedCommandList()
java.util.Collection<ICommand>	getSubCommands()
java.util.List<java.lang.String>	getTabCompletions(MinecraftServer server, ICommandSender sender, java.lang.String[] args, BlockPos pos) 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.

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, getRequiredPermissionLevel, 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

Methods inherited from interface net.minecraft.command.ICommand

getName, getUsage

Constructor Detail

CommandTreeBase

public CommandTreeBase()

Method Detail

addSubcommand

public void addSubcommand(ICommand c)

getSubCommands

public java.util.Collection<ICommand> getSubCommands()

getCommandMap

public java.util.Map<java.lang.String,ICommand> getCommandMap()

getSortedCommandList

public java.util.List<ICommand> getSortedCommandList()

getTabCompletions

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

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

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