net.minecraftforge.server.command

Class CommandTreeHelp

java.lang.Object

net.minecraft.command.CommandBase

net.minecraftforge.server.command.CommandTreeBase

net.minecraftforge.server.command.CommandTreeHelp

All Implemented Interfaces:

java.lang.Comparable<ICommand>, ICommand

public class CommandTreeHelp
extends CommandTreeBase

Add help for parent and all its children. Must be added to parent after all other commands.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandTreeHelp.HelpSubCommand

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

CommandBase.CoordinateArg

Constructor Summary

Constructors

Constructor and Description
CommandTreeHelp(CommandTreeBase parent)

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.lang.String	getUsage(ICommandSender sender) Gets the usage string for the command.

Methods inherited from class net.minecraftforge.server.command.CommandTreeBase

addSubcommand, getCommandMap, getSortedCommandList, getSubCommand, getSubCommands, getTabCompletions, isUsernameIndex

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

CommandTreeHelp

public CommandTreeHelp(CommandTreeBase parent)

Method Detail

getRequiredPermissionLevel

public int getRequiredPermissionLevel()

Return the required permission level for this command.

Overrides:

getRequiredPermissionLevel in class CommandBase

getName

public java.lang.String getName()

Gets the name of the command

getUsage

public java.lang.String getUsage(ICommandSender sender)

Gets the usage string for the command.

execute

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

Callback for when the command is executed

Specified by:

execute in interface ICommand

Overrides:

execute in class CommandTreeBase

Throws:

CommandException