buildcraft.core.lib.commands

Class CommandHelpers

java.lang.Object

buildcraft.core.lib.commands.CommandHelpers

public final class CommandHelpers
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static java.lang.String[]	getPlayers()
static net.minecraft.world.World	getWorld(net.minecraft.command.ICommandSender sender, IModCommand command)
static net.minecraft.world.World	getWorld(net.minecraft.command.ICommandSender sender, IModCommand command, java.lang.String[] args, int worldArgIndex)
static boolean	matches(java.lang.String commandName, IModCommand command)
static void	printHelp(net.minecraft.command.ICommandSender sender, IModCommand command)
static void	processChildCommand(net.minecraft.command.ICommandSender sender, SubCommand child, java.lang.String[] args)
static boolean	processStandardCommands(net.minecraft.command.ICommandSender sender, IModCommand 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, net.minecraft.util.ChatStyle chatStyle, java.lang.String locTag, java.lang.Object... args)
static void	sendLocalizedChatMessage(net.minecraft.command.ICommandSender sender, java.lang.String locTag, java.lang.Object... args)
static void	throwWrongUsage(net.minecraft.command.ICommandSender sender, IModCommand command)

Methods inherited from class java.lang.Object

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

Method Detail

getWorld

public static net.minecraft.world.World getWorld(net.minecraft.command.ICommandSender sender,
                                                 IModCommand command,
                                                 java.lang.String[] args,
                                                 int worldArgIndex)

getWorld

public static net.minecraft.world.World getWorld(net.minecraft.command.ICommandSender sender,
                                                 IModCommand command)

getPlayers

public static java.lang.String[] getPlayers()

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.ChatStyle 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.

Parameters:

sender -

message -

throwWrongUsage

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

Throws:

net.minecraft.command.WrongUsageException

processChildCommand

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

printHelp

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

processStandardCommands

public static boolean processStandardCommands(net.minecraft.command.ICommandSender sender,
                                              IModCommand command,
                                              java.lang.String[] args)

matches

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