com.pixelmonmod.pixelmon.api.command

Class PixelmonCommand

java.lang.Object

net.minecraft.command.CommandBase

com.pixelmonmod.pixelmon.api.command.PixelmonCommand

All Implemented Interfaces:

java.lang.Comparable<net.minecraft.command.ICommand>, net.minecraft.command.ICommand

Direct Known Subclasses:

BankTransferCommand, Battle2, BattleCommand, BreedCommand, CatchingCharmCommand, CheckSpawnsCommand, CompleteAllQuestsCommand, DebugCommand, DeepStorageCmd, DevScaleCommand, DoLegendarySpawnCommand, DynamaxBandCommand, EndBattleCommand, ExpCharmCommand, FillDexCommand, FreezeCommand, GetBiomeData, GiveMoneyCommand, GivePixelSpriteCommand, HealCommand, MarkCharmCommand, MegaRingCommand, OvalCharmCommand, PixelTPCommand, PokeGiveCommand, QuestDataCommand, RanchUnlockCommand, RedeemCommand, ReloadCommand, ReloadMoveAnimations, ReloadQuestsCommand, ResetAllQuestsCommand, Save, SetPartyCommand, SetStageCommand, ShinyCharmCommand, SpawnCommand, SpawningCommand, SpectateCommand, Stats, StatsReset, StrucCommand, TeachCommand, TierShow, WarpPlateCommand

public abstract class PixelmonCommand
extends net.minecraft.command.CommandBase

Abstract base for Pixelmon commands. Several helpful utility functions are included inside of this class to shortcut common procedures.

Nested Class Summary

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

net.minecraft.command.CommandBase.CoordinateArg

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<java.lang.String>	aliases
protected java.lang.String	name
protected int	permission
protected java.lang.String	usage

Constructor Summary

Constructors

Modifier	Constructor and Description
	PixelmonCommand()
protected	PixelmonCommand(java.lang.String name, java.lang.String usage, int permissionLevel)

Method Summary

Modifier and Type	Method and Description
static void	endCommand(java.lang.String message, java.lang.Object... data) Terminates the command with a message
protected abstract void	execute(net.minecraft.command.ICommandSender sender, java.lang.String[] args)
void	execute(net.minecraft.server.MinecraftServer server, net.minecraft.command.ICommandSender sender, java.lang.String[] args)
static com.mojang.authlib.GameProfile	findProfile(java.lang.String username)
static net.minecraft.util.text.ITextComponent	format(java.lang.String lang, java.lang.Object... args)
static net.minecraft.util.text.ITextComponent	format(net.minecraft.util.text.TextFormatting color, java.lang.String lang, java.lang.Object... args)
java.util.List<java.lang.String>	getAliases() Get a list of aliases for this command.
static PCStorage	getComputerStorage(net.minecraft.entity.player.EntityPlayerMP player) Shortcut call to IStorageManager.getPCForPlayer(EntityPlayerMP)
static net.minecraft.entity.player.EntityPlayerMP	getEntityPlayer(java.lang.String username) Gets the entityPlayer if they are online else returns null
static net.minecraft.entity.player.EntityPlayerMP	getEntityPlayer(java.util.UUID uuid) Gets the entityPlayer if they are online else returns null
java.lang.String	getName() Gets the name of the command
static net.minecraft.entity.player.EntityPlayerMP	getPlayer(net.minecraft.command.ICommandSender sender, java.lang.String name) Shortcut call to PixelmonPlayerUtils.getUniquePlayerStartingWith(String, ICommandSender).
static net.minecraft.entity.player.EntityPlayerMP	getPlayer(java.lang.String name) Shortcut call to PixelmonPlayerUtils.getUniquePlayerStartingWith(String).
static PlayerPartyStorage	getPlayerStorage(net.minecraft.entity.player.EntityPlayerMP player) Shortcut call to IStorageManager.getParty(EntityPlayerMP).
int	getRequiredPermissionLevel() Return the required permission level for this command.
static net.minecraft.server.MinecraftServer	getServer() Shortcut to FMLCommonHandler.getMinecraftServerInstance().
java.lang.String	getUsage(net.minecraft.command.ICommandSender sender) Gets the usage string for the command.
static <T> T	require(java.util.Optional<T> optional, java.lang.String message, java.lang.Object... data)
static <T> T	require(T obj, java.lang.String message, java.lang.Object... data)
static net.minecraft.entity.player.EntityPlayerMP	requireEntityPlayer(net.minecraft.command.ICommandSender sender) Checks if the commandSender is a player and returns the entityPlayer if true.
static net.minecraft.entity.player.EntityPlayerMP	requireEntityPlayer(java.lang.String username) Checks if the user is online.
static int	requireInt(java.lang.String input, int min, int max, java.lang.String message, java.lang.Object... data)
static int	requireInt(java.lang.String input, java.lang.String message)
protected void	resendWithMultipleTargets(net.minecraft.command.ICommandSender sender, java.lang.String[] args, int playerIndex)
void	sendMessage(net.minecraft.command.ICommandSender sender, java.lang.String string, java.lang.Object... data) Sends a gray message to the given ICommandSender.
void	sendMessage(net.minecraft.command.ICommandSender sender, net.minecraft.util.text.TextFormatting color, java.lang.String string, java.lang.Object... data) Sends a message to the given ICommandSender.
static java.util.List<java.lang.String>	tabComplete(java.lang.String[] args, java.util.Collection options)
static java.util.List<java.lang.String>	tabComplete(java.lang.String[] args, java.lang.String... options)
static java.util.List<java.lang.String>	tabCompletePokemon(java.lang.String[] args) Gets a tab-complete list for Pokémon names.
static java.util.List<java.lang.String>	tabCompleteUsernames(java.lang.String[] args) Gets a tab-complete list for player names.

Methods inherited from class net.minecraft.command.CommandBase

buildString, checkPermission, compareTo, convertArgToBlockState, convertArgToBlockStatePredicate, doesStringStartWith, entityToNBT, getBlockByText, getChatComponentFromNthArg, getChatComponentFromNthArg, getCommandSenderAsPlayer, getEntity, getEntity, getEntityList, getEntityName, getItemByText, getListOfStringsMatchingLastWord, getListOfStringsMatchingLastWord, getPlayer, getPlayerName, getPlayers, getTabCompletionCoordinate, getTabCompletionCoordinateXZ, getTabCompletions, isUsernameIndex, 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

Field Detail

name

protected java.lang.String name

usage

protected java.lang.String usage

permission

protected int permission

aliases

public java.util.List<java.lang.String> aliases

Constructor Detail

PixelmonCommand

public PixelmonCommand()

PixelmonCommand

protected PixelmonCommand(java.lang.String name,
                          java.lang.String usage,
                          int permissionLevel)

Parameters:

name - The name of the command.

usage - The help entry of the command.

permissionLevel - The permission level required to use this command.

Method Detail

execute

protected abstract void execute(net.minecraft.command.ICommandSender sender,
                                java.lang.String[] args)
                         throws net.minecraft.command.CommandException

Throws:

net.minecraft.command.CommandException

getName

public java.lang.String getName()

Gets the name of the command

getUsage

public java.lang.String getUsage(net.minecraft.command.ICommandSender sender)

Gets the usage string for the command.

Parameters:

sender -

execute

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

Throws:

net.minecraft.command.CommandException

getRequiredPermissionLevel

public int getRequiredPermissionLevel()

Return the required permission level for this command.

Overrides:

getRequiredPermissionLevel in class net.minecraft.command.CommandBase

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 net.minecraft.command.ICommand

Overrides:

getAliases in class net.minecraft.command.CommandBase

resendWithMultipleTargets

protected void resendWithMultipleTargets(net.minecraft.command.ICommandSender sender,
                                         java.lang.String[] args,
                                         int playerIndex)
                                  throws net.minecraft.command.CommandException

Throws:

net.minecraft.command.CommandException

requireEntityPlayer

@Nonnull
public static net.minecraft.entity.player.EntityPlayerMP requireEntityPlayer(net.minecraft.command.ICommandSender sender)
                                                                               throws net.minecraft.command.CommandException

Checks if the commandSender is a player and returns the entityPlayer if true. If not, it throws a CommandException

Parameters:

sender - commandSender

Returns:

the sender as EntityPlayerMP

Throws:

net.minecraft.command.CommandException - If the command sender is not a player.

requireEntityPlayer

@Nonnull
public static net.minecraft.entity.player.EntityPlayerMP requireEntityPlayer(java.lang.String username)
                                                                               throws net.minecraft.command.CommandException

Checks if the user is online. If they are it returns the entityPlayer. If not, it throws a CommandException stating the player can not be found.

Parameters:

username - The username or uuid string to check.

Returns:

the EntityPlayerMP

Throws:

net.minecraft.command.CommandException - if the player is not online or cant be found.

getEntityPlayer

public static net.minecraft.entity.player.EntityPlayerMP getEntityPlayer(java.lang.String username)

Gets the entityPlayer if they are online else returns null

Parameters:

username - The username or uuid string to lookup

Returns:

EntityPlayerMP or null if they are not online

Throws:

java.lang.IllegalArgumentException - if we cant parse the UUID

getEntityPlayer

public static net.minecraft.entity.player.EntityPlayerMP getEntityPlayer(java.util.UUID uuid)

Gets the entityPlayer if they are online else returns null

Parameters:

uuid - The uuid of the player to lookup

Returns:

EntityPlayerMP or null if they are not online

findProfile

public static com.mojang.authlib.GameProfile findProfile(java.lang.String username)

requireInt

public static int requireInt(java.lang.String input,
                             java.lang.String message)
                      throws net.minecraft.command.CommandException

Throws:

net.minecraft.command.CommandException

requireInt

public static int requireInt(java.lang.String input,
                             int min,
                             int max,
                             java.lang.String message,
                             java.lang.Object... data)
                      throws net.minecraft.command.CommandException

Throws:

net.minecraft.command.CommandException

require

@Nonnull
public static <T> T require(java.util.Optional<T> optional,
                                     java.lang.String message,
                                     java.lang.Object... data)
                              throws net.minecraft.command.CommandException

Throws:

net.minecraft.command.CommandException

require

@Nonnull
public static <T> T require(T obj,
                                     java.lang.String message,
                                     java.lang.Object... data)
                              throws net.minecraft.command.CommandException

Throws:

net.minecraft.command.CommandException

endCommand

public static void endCommand(java.lang.String message,
                              java.lang.Object... data)
                       throws net.minecraft.command.CommandException

Terminates the command with a message

Parameters:

message - The message to send to the player.

Throws:

net.minecraft.command.CommandException - 99.9% of the time.

getPlayer

@Nullable
public static net.minecraft.entity.player.EntityPlayerMP getPlayer(java.lang.String name)

Shortcut call to PixelmonPlayerUtils.getUniquePlayerStartingWith(String).

getPlayer

@Nullable
public static net.minecraft.entity.player.EntityPlayerMP getPlayer(net.minecraft.command.ICommandSender sender,
                                                                             java.lang.String name)

Shortcut call to PixelmonPlayerUtils.getUniquePlayerStartingWith(String, ICommandSender).

getPlayerStorage

@Nullable
public static PlayerPartyStorage getPlayerStorage(net.minecraft.entity.player.EntityPlayerMP player)

Shortcut call to IStorageManager.getParty(EntityPlayerMP).

getComputerStorage

public static PCStorage getComputerStorage(net.minecraft.entity.player.EntityPlayerMP player)

Shortcut call to IStorageManager.getPCForPlayer(EntityPlayerMP)

getServer

public static net.minecraft.server.MinecraftServer getServer()

Shortcut to FMLCommonHandler.getMinecraftServerInstance().

tabComplete

public static java.util.List<java.lang.String> tabComplete(java.lang.String[] args,
                                                           java.lang.String... options)

tabComplete

public static java.util.List<java.lang.String> tabComplete(java.lang.String[] args,
                                                           java.util.Collection options)

tabCompleteUsernames

public static java.util.List<java.lang.String> tabCompleteUsernames(java.lang.String[] args)

Gets a tab-complete list for player names.

Parameters:

args - - The command arguments

Returns:

- A list of all player names that begin with the last argument.

tabCompletePokemon

public static java.util.List<java.lang.String> tabCompletePokemon(java.lang.String[] args)

Gets a tab-complete list for Pokémon names.

Parameters:

args - - The command arguments

Returns:

- A list of all Pokémon names that begin with the last argument.

format

public static net.minecraft.util.text.ITextComponent format(net.minecraft.util.text.TextFormatting color,
                                                            java.lang.String lang,
                                                            java.lang.Object... args)

format

public static net.minecraft.util.text.ITextComponent format(java.lang.String lang,
                                                            java.lang.Object... args)

sendMessage

public void sendMessage(net.minecraft.command.ICommandSender sender,
                        net.minecraft.util.text.TextFormatting color,
                        java.lang.String string,
                        java.lang.Object... data)

Sends a message to the given ICommandSender.

Parameters:

sender - - The ICommandSender to send the message to.

color - - The color of the text.

string - - The message itself or the translation key.

data - - Any relevant translation information to substitute '%s' placeholders.

sendMessage

public void sendMessage(net.minecraft.command.ICommandSender sender,
                        java.lang.String string,
                        java.lang.Object... data)

Sends a gray message to the given ICommandSender.

Parameters:

sender - - The ICommandSender to send the message to.

string - - The message itself or the translation key.

data - - Any relevant translation information to substitute '%s' placeholders.