forestry.core.commands

Class CommandHelpers

java.lang.Object

forestry.core.commands.CommandHelpers

public class CommandHelpers
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CommandHelpers()

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.String>	addStandardTabCompletionOptions(net.minecraft.server.MinecraftServer server, IForestryCommand command, net.minecraft.command.ICommandSender sender, java.lang.String[] incomplete, net.minecraft.util.math.BlockPos pos)
static java.util.List<java.lang.String>	getListOfStringsMatchingLastWord(java.lang.String[] strings, java.lang.String... lastWords)
static boolean	matches(java.lang.String commandName, IForestryCommand command)
static void	printHelp(net.minecraft.command.ICommandSender sender, IForestryCommand command)
static void	processChildCommand(net.minecraft.server.MinecraftServer server, net.minecraft.command.ICommandSender sender, SubCommand child, java.lang.String[] args)
static boolean	processStandardCommands(net.minecraft.server.MinecraftServer server, net.minecraft.command.ICommandSender sender, IForestryCommand command, java.lang.String[] args)
static void	sendChatMessage(net.minecraft.command.ICommandSender sender, java.lang.String message) Avoid using this function if at all possible.
static void	sendLocalizedChatMessage(net.minecraft.command.ICommandSender sender, java.lang.String locTag, java.lang.Object... args)
static void	sendLocalizedChatMessage(net.minecraft.command.ICommandSender sender, net.minecraft.util.text.Style chatStyle, java.lang.String locTag, java.lang.Object... args)
static void	throwWrongUsage(net.minecraft.command.ICommandSender sender, IForestryCommand command)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandHelpers

public CommandHelpers()

Method Detail

sendLocalizedChatMessage

public static void sendLocalizedChatMessage(net.minecraft.command.ICommandSender sender,
                                            java.lang.String locTag,
                                            java.lang.Object... args)

sendLocalizedChatMessage

public static void sendLocalizedChatMessage(net.minecraft.command.ICommandSender sender,
                                            net.minecraft.util.text.Style chatStyle,
                                            java.lang.String locTag,
                                            java.lang.Object... args)

sendChatMessage

public static void sendChatMessage(net.minecraft.command.ICommandSender sender,
                                   java.lang.String message)

Avoid using this function if at all possible. Commands are processed on the server, which has no localization information.

StringUtil.localize() is NOT a valid alternative for sendLocalizedChatMessage(). Messages will not be localized properly if you use StringUtil.localize().

throwWrongUsage

public static void throwWrongUsage(net.minecraft.command.ICommandSender sender,
                                   IForestryCommand command)
                            throws net.minecraft.command.WrongUsageException

Throws:

net.minecraft.command.WrongUsageException

processChildCommand

public static void processChildCommand(net.minecraft.server.MinecraftServer server,
                                       net.minecraft.command.ICommandSender sender,
                                       SubCommand child,
                                       java.lang.String[] args)
                                throws net.minecraft.command.CommandException

Throws:

net.minecraft.command.CommandException

printHelp

public static void printHelp(net.minecraft.command.ICommandSender sender,
                             IForestryCommand command)

processStandardCommands

public static boolean processStandardCommands(net.minecraft.server.MinecraftServer server,
                                              net.minecraft.command.ICommandSender sender,
                                              IForestryCommand command,
                                              java.lang.String[] args)
                                       throws net.minecraft.command.CommandException

Throws:

net.minecraft.command.CommandException

matches

public static boolean matches(java.lang.String commandName,
                              IForestryCommand command)

getListOfStringsMatchingLastWord

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

addStandardTabCompletionOptions

public static java.util.List<java.lang.String> addStandardTabCompletionOptions(net.minecraft.server.MinecraftServer server,
                                                                               IForestryCommand command,
                                                                               net.minecraft.command.ICommandSender sender,
                                                                               java.lang.String[] incomplete,
                                                                               @Nullable
                                                                               net.minecraft.util.math.BlockPos pos)