PixelmonCommandUtils (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- com.pixelmonmod.pixelmon.api.command.PixelmonCommandUtils

public class PixelmonCommandUtils
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.List<java.lang.String>`	`PARTY_SLOTS`
`static java.util.List<java.lang.String>`	`REMOVE_ARGUMENT`
`static java.util.List<java.lang.String>`	`SPEC_REQUIREMENTS`
`static java.util.List<java.lang.String>`	`TARGET_SELECTORS`
`static ThreadPool`	`THREAD_POOL`

Constructor Summary

Constructors
Constructor and Description

PixelmonCommandUtils()

Constructors
Constructor and Description
`PixelmonCommandUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`applySpecs(Pokemon pokemon, java.lang.String[] specList)` Applies a list of specs to a specified pokemon
`static boolean`	`doesStringStartWith(java.lang.String original, java.lang.String region)` Checks if the original begins with region ignoring case
`static void`	`endCommand(java.lang.String message, java.lang.Object... data)` Terminates the command with a message
`static com.mojang.authlib.GameProfile`	`findProfile(java.lang.String username)` Finds the game profile of the player with the given username.
`static net.minecraft.util.text.IFormattableTextComponent`	`format(net.minecraft.util.text.Color color, java.lang.String lang, java.lang.Object... args)` Converts the language file link to the converted `IFormattableTextComponent` with the given color
`static net.minecraft.util.text.IFormattableTextComponent`	`format(java.lang.String lang, java.lang.Object... args)` Translates the lang to `IFormattableTextComponent` using GRAY color
`static net.minecraft.util.text.IFormattableTextComponent`	`format(net.minecraft.util.text.TextFormatting color, java.lang.String lang, java.util.function.Consumer<net.minecraft.util.text.IFormattableTextComponent> formatting, java.lang.Object... args)` Converts the language file link to the converted `IFormattableTextComponent` with the given color
`static net.minecraft.util.text.IFormattableTextComponent`	`format(net.minecraft.util.text.TextFormatting color, java.lang.String lang, java.lang.Object... args)` Converts the language file link to the converted `IFormattableTextComponent` with the given color
`static PCStorage`	`getComputerStorage(net.minecraft.entity.player.ServerPlayerEntity player)` Shortcut call to `StorageManager.getPCForPlayer(ServerPlayerEntity)`
`static net.minecraft.entity.player.ServerPlayerEntity`	`getEntityPlayer(java.lang.String username)` Gets the `ServerPlayerEntity` if they are online else returns null
`static net.minecraft.entity.player.ServerPlayerEntity`	`getEntityPlayer(java.util.UUID uuid)` Gets the `ServerPlayerEntity` if they are online else returns null
`static net.minecraft.command.arguments.EntitySelector`	`getEntitySelector(java.lang.String username)`
`static net.minecraft.command.CommandException`	`getException(net.minecraft.util.text.IFormattableTextComponent translation)` Gets the exception for the translation and the data to be given to the translation
`static net.minecraft.command.CommandException`	`getException(java.lang.String translation, java.lang.Object... data)` Gets the exception for the translation and the data to be given to the translation
`static PlayerPartyStorage`	`getPlayerStorage(net.minecraft.entity.player.ServerPlayerEntity player)` Shortcut call to `StorageManager.getParty(ServerPlayerEntity)`.
`static net.minecraft.world.server.ServerWorld`	`getWorld(java.lang.String[] args, net.minecraft.command.CommandSource sender)`
`static boolean`	`hasPermission(net.minecraft.command.CommandSource source, java.lang.String permission)` If the `CommandSource` is a player then it will check if they have access to the given permission Otherwise, return true
`static void`	`notifyCommandListener(net.minecraft.command.CommandSource sender, PixelCommand command, int i, java.lang.String translatedText, java.lang.Object... values)`
`static void`	`require(boolean boo, java.lang.String message, java.lang.Object... data)` Requires the given boolean to be true otherwise the error message is thrown
`static <T> T`	`require(java.util.Optional<T> optional, java.lang.String message, java.lang.Object... data)` Requires the optional to have a value otherwise the error will be thrown
`static <T> T`	`require(T obj, java.lang.String message, java.lang.Object... data)` Requires the object to be neither null, false or empty otherwise error message is sent
`static net.minecraft.entity.player.ServerPlayerEntity`	`requireEntityPlayer(net.minecraft.command.CommandSource source)`
`static net.minecraft.entity.player.ServerPlayerEntity`	`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)` Requires the input to be an Integer within the min and max boundsotherwise it will throw a `CommandException` with the given message
`static int`	`requireInt(java.lang.String input, java.lang.String message)` Requires the input to be an Integer otherwise it will throw a `CommandException` with the given message
`static void`	`sendMessage(net.minecraft.command.CommandSource sender, java.lang.String string, java.util.function.Consumer<net.minecraft.util.text.IFormattableTextComponent> formatting, java.lang.Object... data)` Sends a gray message to the given `CommandSource`.
`static void`	`sendMessage(net.minecraft.command.CommandSource sender, java.lang.String string, java.lang.Object... data)` Sends a gray message to the given `CommandSource`.
`static void`	`sendMessage(net.minecraft.command.CommandSource sender, net.minecraft.util.text.TextFormatting color, java.lang.String string, java.util.function.Consumer<net.minecraft.util.text.IFormattableTextComponent> formatting, java.lang.Object... data)` Sends a message to the given `CommandSource`.
`static void`	`sendMessage(net.minecraft.command.CommandSource sender, net.minecraft.util.text.TextFormatting color, java.lang.String string, java.lang.Object... data)` Sends a message to the given `CommandSource`.
`static void`	`sendMessage(net.minecraft.entity.player.ServerPlayerEntity sender, java.lang.String string, java.lang.Object... data)`
`static void`	`sendMessage(net.minecraft.entity.player.ServerPlayerEntity target, net.minecraft.util.text.TextFormatting color, java.lang.String string, java.lang.Object... data)` Sends a message to the given `ServerPlayerEntity`.
`static java.lang.String[]`	`setupCommandTargets(PixelCommand command, net.minecraft.command.CommandSource sender, java.lang.String[] args, int playerIndex)` Manage the command argument with Mojang Selectors or with putting the sender as target when the target is missing in the arguments.
`static java.util.List<java.lang.String>`	`tabCompletePokemon()` Gets a tab-complete list for Pokémon names.
`static java.util.List<java.lang.String>`	`tabCompleteUsernames()` Gets a tab-complete list for player names.
`static java.util.List<java.lang.String>`	`tabCompleteWorld()` Gets a tab-complete list for world IDs.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - THREAD_POOL
```
public static final ThreadPool THREAD_POOL
```
  - PARTY_SLOTS
```
public static final java.util.List<java.lang.String> PARTY_SLOTS
```
  - SPEC_REQUIREMENTS
```
public static final java.util.List<java.lang.String> SPEC_REQUIREMENTS
```
  - REMOVE_ARGUMENT
```
public static final java.util.List<java.lang.String> REMOVE_ARGUMENT
```
  - TARGET_SELECTORS
```
public static final java.util.List<java.lang.String> TARGET_SELECTORS
```
- Constructor Detail
  - PixelmonCommandUtils
```
public PixelmonCommandUtils()
```
- Method Detail
  - notifyCommandListener
```
public static void notifyCommandListener(net.minecraft.command.CommandSource sender,
                                         PixelCommand command,
                                         int i,
                                         java.lang.String translatedText,
                                         java.lang.Object... values)
```
  - setupCommandTargets
```
public static java.lang.String[] setupCommandTargets(PixelCommand command,
                                                     net.minecraft.command.CommandSource sender,
                                                     java.lang.String[] args,
                                                     int playerIndex)
                                              throws net.minecraft.command.CommandException,
                                                     com.mojang.brigadier.exceptions.CommandSyntaxException
```
    Manage the command argument with Mojang Selectors or with putting the sender as target when the target is missing in the arguments.
    
    Parameters:
    
    command - The command that the targets are being set up for.
    
    sender - The command executor.
    
    args - the command arguments.
    
    playerIndex - the index of the player argument in the args.
    
    Returns:
    
    the original arguments or the sender squashed inside the original args.
    
    Throws:
    
    com.mojang.brigadier.exceptions.CommandSyntaxException - default possible exception when executing a command
    
    net.minecraft.command.CommandException
  - getEntitySelector
```
public static net.minecraft.command.arguments.EntitySelector getEntitySelector(java.lang.String username)
                                                                        throws com.mojang.brigadier.exceptions.CommandSyntaxException
```
    Throws:
    
    com.mojang.brigadier.exceptions.CommandSyntaxException
  - requireEntityPlayer
```
@Nonnull
public static net.minecraft.entity.player.ServerPlayerEntity 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 ServerPlayerEntity
    
    Throws:
    
    net.minecraft.command.CommandException - if the player is not online or cant be found.
  - requireEntityPlayer
```
public static net.minecraft.entity.player.ServerPlayerEntity requireEntityPlayer(net.minecraft.command.CommandSource source)
                                                                          throws net.minecraft.command.CommandException
```
    Throws:
    
    net.minecraft.command.CommandException
  - getEntityPlayer
```
@Nullable
public static net.minecraft.entity.player.ServerPlayerEntity getEntityPlayer(java.lang.String username)
```
    Gets the ServerPlayerEntity if they are online else returns null
    
    Parameters:
    
    username - The username or uuid string to lookup
    
    Returns:
    
    ServerPlayerEntity or null if they are not online
    
    Throws:
    
    java.lang.IllegalArgumentException - if we cant parse the UUID
  - getEntityPlayer
```
public static net.minecraft.entity.player.ServerPlayerEntity getEntityPlayer(java.util.UUID uuid)
```
    Gets the ServerPlayerEntity if they are online else returns null
    
    Parameters:
    
    uuid - The uuid of the player to lookup
    
    Returns:
    
    ServerPlayerEntity or null if they are not online
  - findProfile
```
public static com.mojang.authlib.GameProfile findProfile(java.lang.String username)
```
    Finds the game profile of the player with the given username. If the player is online then it will return the cached game profile from the ServerPlayerEntity If a UUID is provided it will convert the username to a UUID and search the server's cache using that If it's of length 32 then it will bit shift the integer to the right by 64 to get the most significant bits and use the rest as the least significant bits of the UUID Finally, if none of the above are true it will search the cache for the game profile but NOT lookup to Mojang's servers
    Will return null if cannot be found in cache
    
    Parameters:
    
    username - The username, UUID, or bits for the user of the GameProfile
    
    Returns:
    
    GameProfile of the user
  - requireInt
```
public static int requireInt(java.lang.String input,
                             java.lang.String message)
                      throws net.minecraft.command.CommandException
```
    Requires the input to be an Integer otherwise it will throw a CommandException with the given message
    
    Parameters:
    
    input - the string - potential integer
    
    message - the error message
    
    Returns:
    
    The integer found
    
    Throws:
    
    net.minecraft.command.CommandException - Thrown if string isn't an integer
  - 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
```
    Requires the input to be an Integer within the min and max boundsotherwise it will throw a CommandException with the given message
    
    Parameters:
    
    input - The string - potential integer
    
    min - The min value of the integer (inclusive)
    
    max - The max value of the integer (inclusive)
    
    message - The error message
    
    data - The data to fill any args in the error message
    
    Returns:
    
    The integer parsed
    
    Throws:
    
    net.minecraft.command.CommandException - Thrown if the string isn't an integer
  - require
```
public static void require(boolean boo,
                           java.lang.String message,
                           java.lang.Object... data)
                    throws net.minecraft.command.CommandException
```
    Requires the given boolean to be true otherwise the error message is thrown
    
    Parameters:
    
    boo - The boolean
    
    message - The error message
    
    data - The args for the error message
    
    Throws:
    
    net.minecraft.command.CommandException - Thrown if boo is false
  - 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
```
    Requires the optional to have a value otherwise the error will be thrown
    
    Type Parameters:
    
    T - The type stored in the optional
    
    Parameters:
    
    optional - The optional
    
    message - The error message
    
    data - The data for the error message
    
    Returns:
    
    The value stored in the optional
    
    Throws:
    
    net.minecraft.command.CommandException - The error thrown if the optional isn't present
  - require
```
@Nonnull
public static <T> T require(T obj,
                                     java.lang.String message,
                                     java.lang.Object... data)
                              throws net.minecraft.command.CommandException
```
    Requires the object to be neither null, false or empty otherwise error message is sent
    
    Type Parameters:
    
    T - The type of the object
    
    Parameters:
    
    obj - The object
    
    message - The error message
    
    data - The data for the error message to parse
    
    Returns:
    
    The object that is 100% not null, false or empty
    
    Throws:
    
    net.minecraft.command.CommandException - Thrown if any of the initial conditions are not met
  - 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.
  - getException
```
public static net.minecraft.command.CommandException getException(java.lang.String translation,
                                                                  java.lang.Object... data)
```
    Gets the exception for the translation and the data to be given to the translation
    
    Parameters:
    
    translation - The message to translate
    
    data - The data to populate the placeholders with
    
    Returns:
    
    The exception with Throwable.fillInStackTrace() returning itself (remove the stack)
  - getException
```
public static net.minecraft.command.CommandException getException(net.minecraft.util.text.IFormattableTextComponent translation)
```
    Gets the exception for the translation and the data to be given to the translation
    
    Parameters:
    
    translation - The message to translate
    
    Returns:
    
    The exception with Throwable.fillInStackTrace() returning itself (remove the stack)
  - getPlayerStorage
```
@Nullable
public static PlayerPartyStorage getPlayerStorage(net.minecraft.entity.player.ServerPlayerEntity player)
```
    Shortcut call to StorageManager.getParty(ServerPlayerEntity).
    
    Parameters:
    
    player - The player you're getting the party of
    
    Returns:
    
    The player's party
  - getComputerStorage
```
public static PCStorage getComputerStorage(net.minecraft.entity.player.ServerPlayerEntity player)
```
    Shortcut call to StorageManager.getPCForPlayer(ServerPlayerEntity)
    
    Parameters:
    
    player - The player you're getting the PC of
    
    Returns:
    
    the player's pc
  - tabCompleteUsernames
```
public static java.util.List<java.lang.String> tabCompleteUsernames()
```
    Gets a tab-complete list for player names.
    
    Returns:
    
    - A list of all player names that begin with the last argument.
  - tabCompletePokemon
```
public static java.util.List<java.lang.String> tabCompletePokemon()
```
    Gets a tab-complete list for Pokémon names.
    
    Returns:
    
    - A list of all Pokémon names that begin with the last argument.
  - tabCompleteWorld
```
public static java.util.List<java.lang.String> tabCompleteWorld()
```
    Gets a tab-complete list for world IDs.
    
    Returns:
    
    - A list of all world IDs that begin with the last argument.
  - getWorld
```
public static net.minecraft.world.server.ServerWorld getWorld(java.lang.String[] args,
                                                              net.minecraft.command.CommandSource sender)
```
  - doesStringStartWith
```
public static boolean doesStringStartWith(java.lang.String original,
                                          java.lang.String region)
```
    Checks if the original begins with region ignoring case
    
    Parameters:
    
    original - The string to check
    
    region - The potential begging
    
    Returns:
    
    True if matches the start
  - format
```
public static net.minecraft.util.text.IFormattableTextComponent format(net.minecraft.util.text.TextFormatting color,
                                                                       java.lang.String lang,
                                                                       java.lang.Object... args)
```
    Converts the language file link to the converted IFormattableTextComponent with the given color
    
    Parameters:
    
    color - The color of the message
    
    lang - The message to be translated
    
    args - The args for the translation
    
    Returns:
    
    Translated coloured message
  - format
```
public static net.minecraft.util.text.IFormattableTextComponent format(net.minecraft.util.text.TextFormatting color,
                                                                       java.lang.String lang,
                                                                       java.util.function.Consumer<net.minecraft.util.text.IFormattableTextComponent> formatting,
                                                                       java.lang.Object... args)
```
    Converts the language file link to the converted IFormattableTextComponent with the given color
    
    Parameters:
    
    color - The color of the message
    
    lang - The message to be translated
    
    args - The args for the translation
    
    Returns:
    
    Translated coloured message
  - format
```
public static net.minecraft.util.text.IFormattableTextComponent format(net.minecraft.util.text.Color color,
                                                                       java.lang.String lang,
                                                                       java.lang.Object... args)
```
    Converts the language file link to the converted IFormattableTextComponent with the given color
    
    Parameters:
    
    color - The color of the message
    
    lang - The message to be translated
    
    args - The args for the translation
    
    Returns:
    
    Translated coloured message
  - format
```
public static net.minecraft.util.text.IFormattableTextComponent format(java.lang.String lang,
                                                                       java.lang.Object... args)
```
    Translates the lang to IFormattableTextComponent using GRAY color
    
    Parameters:
    
    lang - The message to be translated
    
    args - The args for the translation
    
    Returns:
    
    Translated message
  - sendMessage
```
public static void sendMessage(net.minecraft.entity.player.ServerPlayerEntity target,
                               net.minecraft.util.text.TextFormatting color,
                               java.lang.String string,
                               java.lang.Object... data)
```
    Sends a message to the given ServerPlayerEntity.
    
    Parameters:
    
    target - - The ServerPlayerEntity 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 static void sendMessage(net.minecraft.command.CommandSource sender,
                               net.minecraft.util.text.TextFormatting color,
                               java.lang.String string,
                               java.lang.Object... data)
```
    Sends a message to the given CommandSource.
    
    Parameters:
    
    sender - - The CommandSource 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 static void sendMessage(net.minecraft.command.CommandSource sender,
                               net.minecraft.util.text.TextFormatting color,
                               java.lang.String string,
                               java.util.function.Consumer<net.minecraft.util.text.IFormattableTextComponent> formatting,
                               java.lang.Object... data)
```
    Sends a message to the given CommandSource.
    
    Parameters:
    
    sender - - The CommandSource 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 static void sendMessage(net.minecraft.command.CommandSource sender,
                               java.lang.String string,
                               java.lang.Object... data)
```
    Sends a gray message to the given CommandSource.
    
    Parameters:
    
    sender - - The CommandSource to send the message to.
    
    string - - The message itself or the translation key.
    
    data - - Any relevant translation information to substitute '%s' placeholders.
  - sendMessage
```
public static void sendMessage(net.minecraft.command.CommandSource sender,
                               java.lang.String string,
                               java.util.function.Consumer<net.minecraft.util.text.IFormattableTextComponent> formatting,
                               java.lang.Object... data)
```
    Sends a gray message to the given CommandSource.
    
    Parameters:
    
    sender - - The CommandSource to send the message to.
    
    string - - The message itself or the translation key.
    
    data - - Any relevant translation information to substitute '%s' placeholders.
  - sendMessage
```
public static void sendMessage(net.minecraft.entity.player.ServerPlayerEntity sender,
                               java.lang.String string,
                               java.lang.Object... data)
```
  - hasPermission
```
public static boolean hasPermission(net.minecraft.command.CommandSource source,
                                    java.lang.String permission)
```
    If the CommandSource is a player then it will check if they have access to the given permission Otherwise, return true
    
    Parameters:
    
    source - The command source
    
    permission - The permission to check
    
    Returns:
    
    If they have permission
  - applySpecs
```
public static void applySpecs(Pokemon pokemon,
                              java.lang.String[] specList)
```
    Applies a list of specs to a specified pokemon
    
    Parameters:
    
    pokemon - the pokemon to apply the specList to
    
    specList - the list of specs to apply to the pokemon

Class PixelmonCommandUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

THREAD_POOL

PARTY_SLOTS

SPEC_REQUIREMENTS

REMOVE_ARGUMENT

TARGET_SELECTORS

Constructor Detail

PixelmonCommandUtils

Method Detail

notifyCommandListener

setupCommandTargets

getEntitySelector

requireEntityPlayer

requireEntityPlayer

getEntityPlayer

getEntityPlayer

findProfile

requireInt

requireInt

require

require

require

endCommand

getException

getException

getPlayerStorage

getComputerStorage

tabCompleteUsernames

tabCompletePokemon

tabCompleteWorld

getWorld

doesStringStartWith

format

format

format

format

sendMessage

sendMessage

sendMessage

sendMessage

sendMessage

sendMessage

hasPermission

applySpecs