PlayerPartyStorage (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- com.pixelmonmod.pixelmon.api.storage.PokemonStorage
- - com.pixelmonmod.pixelmon.api.storage.PartyStorage
  - - com.pixelmonmod.pixelmon.api.storage.PlayerPartyStorage

All Implemented Interfaces:: BankAccount, RarityTweak

public class PlayerPartyStorage
extends PartyStorage
implements BankAccount, RarityTweak

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`battleEnabled` Whether the owner of the storage can battle.
`boolean`	`guiOpened` Whether the player is looking at a GUI.
`protected BattleLog`	`lastBattle`
`boolean`	`oldGen` Whether the player is in Mega/Z mode or not.
`PlayerData`	`playerData`
`protected java.lang.String`	`playerName` The name of the player whose storage this is.
`PlayerPokedex`	`playerPokedex` The player's Pokédex.
`protected java.math.BigDecimal`	`pokeDollars` The amount of money the player has.
`boolean`	`starterPicked` Whether the player has picked a starter yet
`PlayerStats`	`stats` The player's battle stats.
`TeleportPosition`	`teleportPos` The player's current teleport position with the Teleport/Fly external moves.
`EnumTrainerCardColor`	`trainerCardColor` The color of the players Trainer Card.
`TransientData`	`transientData`

Fields inherited from class com.pixelmonmod.pixelmon.api.storage.PartyStorage
cachePosition, MAX_PARTY, party, tempParty, tempPartyColor

Fields inherited from class com.pixelmonmod.pixelmon.api.storage.PokemonStorage
hasChanged, shouldSendUpdates, uuid

Constructor Summary

Constructors
Constructor and Description

PlayerPartyStorage(java.util.UUID uuid)

PlayerPartyStorage(java.util.UUID uuid, boolean shouldSendUpdates)

Constructors
Constructor and Description
`PlayerPartyStorage(java.util.UUID uuid)`
`PlayerPartyStorage(java.util.UUID uuid, boolean shouldSendUpdates)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(java.math.BigDecimal amount)` Adds the amount to the current balance Returns false if the transaction fails for any given reason (check console logs) DO NOT PASS NEGATIVE VALUES
`boolean`	`add(Pokemon pokemon)` Adds the given Pokemon to this storage in the first available position.
`TriBoolean`	`addSilently(Pokemon pokemon)` Advanced method for adding Pokémon to player storage.
`BattleEndTaskResult`	`addTaskForBattleEnd(BattleEndTaskType type, java.util.function.Consumer<java.util.Optional<BattleController>> consumer)` Add a task to be executed once the client has left the battle UI.
`boolean`	`canEquipMegaItem()`
`void`	`checkPokerus()` NOTE: I could probably make this more optimized, thanks to the new storage
`void`	`closeBattleSafely()` Safely shuts down battles on the client.
`void`	`deregisterKeyListener()`
`void`	`dropLureInLureSlot(net.minecraft.entity.player.ServerPlayerEntity player)` If the player has a lure in their lureSlot make it drop from their inventory.
`void`	`fillEntireCurryDex(int curryDexRating)` Fills in the entire curry dex with the given rating.
`void`	`fillOneCurryDexFlavor(int curryDexPage, int curryDexFlavor, int curryDexRating)` Fills in one flavor entry for one curry dish with the given rating.
`void`	`fillOneCurryDexPage(int curryDexPage, int curryDexRating)` Fills in one page of the curry dex with the given rating.
`java.math.BigDecimal`	`getBalance()` Gets balance of the account
`EnumFeatureState`	`getCatchingCharm()`
`int[]`	`getCurryData()`
`PlayerDayCare`	`getDayCare()`
`EnumFeatureState`	`getExpCharm()`
`EnumFeatureState`	`getHweenRobe()` Deprecated.
`java.util.UUID`	`getIdentifier()` Gets the unique identifier of the given entity
`BattleLog`	`getLastBattle()`
`LureItem`	`getLure()`
`net.minecraft.item.ItemStack`	`getLureStack()`
`EnumFeatureState`	`getMarkCharm()`
`EnumMegaItem`	`getMegaItem()`
`EnumMegaItemsUnlocked`	`getMegaItemsUnlocked()`
`float`	`getMultiplier(AbstractSpawner spawner, SpawnInfo spawnInfo, float sum, float rarity)`
`EnumFeatureState`	`getOvalCharm()`
`net.minecraft.entity.player.ServerPlayerEntity`	`getPlayer()`
`java.lang.String`	`getPlayerName()`
`java.util.List<net.minecraft.entity.player.ServerPlayerEntity>`	`getPlayersToUpdate()`
`java.util.UUID`	`getPlayerUUID()`
`QuestData`	`getQuestData()`
`QuestData`	`getQuestData(boolean update)` Quest storage getter.
`Pokemon`	`getSelectedPokemon()`
`int`	`getSelectedSlot()`
`java.util.Set<ServerCosmetics>`	`getServerCosmetics()`
`EnumFeatureState`	`getShinyCharm()`
`boolean`	`getShouldSave()`
`int`	`getTicksTillEncounter()` Gets the number of ticks until Pixelmon grass spawns a Pokémon against the player.
`void`	`grantServerCosmetics(ServerCosmetics... cosmetics)`
`boolean`	`hasBalance(java.math.BigDecimal amount)` Checks if the account has more than the given amount
`boolean`	`isMegaItemObtained(Species pokemon, Stats form)`
`void`	`lockDynamax()`
`void`	`lockMega()`
`void`	`obtainedItem(Species pokemon, Stats form, net.minecraft.entity.player.ServerPlayerEntity player)`
`void`	`queryResourceLocationExistence(net.minecraft.util.ResourceLocation resource, java.util.function.Consumer<java.lang.Boolean> result)` Query existence of a ResourceLocation on the client.
`PlayerPartyStorage`	`readFromNBT(net.minecraft.nbt.CompoundNBT nbt)`
`void`	`receiveKeyInput(int keyCode, int scanCode, int modifiers)`
`void`	`receiveResourceLocationQueryResult(java.util.UUID query, boolean result)`
`void`	`registerKeyListener(java.lang.Object instance, java.lang.reflect.Method callback)`
`void`	`resetQuestData()`
`void`	`revokeServerCosmetics(ServerCosmetics... cosmetics)`
`void`	`sendClientUpdatePacket()`
`void`	`sendClientUpdateSelectedPacket()`
`void`	`set(StoragePosition position, Pokemon pokemon)`
`void`	`setBalance(java.math.BigDecimal amount)` Sets the balance of the account
`void`	`setCatchingCharm(EnumFeatureState catchingCharm)`
`void`	`setDayCare(PlayerDayCare dayCare)`
`void`	`setExpCharm(EnumFeatureState expCharm)`
`void`	`setHweenRobe(EnumFeatureState hweenRobe)` Deprecated.
`void`	`setLastBattle(BattleLog lastBattle)`
`void`	`setLure(LureItem lure)`
`void`	`setLureStack(net.minecraft.item.ItemStack stack)`
`void`	`setMarkCharm(EnumFeatureState markCharm)`
`void`	`setMegaItem(EnumMegaItem megaItem, boolean giveChoice)`
`void`	`setMegaItemsUnlocked(EnumMegaItemsUnlocked megaItemsUnlocked)`
`void`	`setOvalCharm(EnumFeatureState ovalCharm)`
`void`	`setSelectedSlot(int selectedSlot)`
`void`	`setSelectedSlot(int selectedSlot, boolean sendPacket)`
`void`	`setServerCosmetics(java.util.Set<ServerCosmetics> cosmetics)`
`void`	`setShinyCharm(EnumFeatureState shinyCharm)`
`boolean`	`take(java.math.BigDecimal amount)` Take the amount to the current balance Returns false if the transaction fails for any given reason (check console logs) DO NOT PASS NEGATIVE VALUES
`void`	`tryUpdatePlayerName()`
`void`	`unlockDynamax()`
`void`	`unlockMega()`
`void`	`updatePartyCache()` Updates the cache of pokemonLevel data in the storage.
`void`	`updateSingleCurryData(EnumCurryKey curryKey, EnumBerryFlavor cookingFlavor, EnumCurryRating rating)`
`void`	`updateTicksTillEncounter()` Ticks the number of ticks until Pixelmon grass spawns a Pokémon against the player.
`net.minecraft.nbt.CompoundNBT`	`writeToNBT(net.minecraft.nbt.CompoundNBT nbt)`

Methods inherited from class com.pixelmonmod.pixelmon.api.storage.PartyStorage
copyToTemporaryMode, countAblePokemon, enterTemporaryMode, enterTemporaryMode, get, get, get, getAll, getAndSendOutFirstAblePokemon, getAverageLevel, getFile, getFirstAblePokemon, getFirstBattleReadyPokemon, getFirstEmptyPosition, getHighestLevel, getLowestLevel, getOriginalParty, getPosition, getSlot, getSlot, getTeam, getTempPartyColor, heal, inTemporaryMode, isOldGen, set, setInTemporaryMode, setInTemporaryModeClient, setOriginal, setOriginal, setTempPartyColor, swap, swap

Methods inherited from class com.pixelmonmod.pixelmon.api.storage.PokemonStorage
canTransfer, countAll, countEggs, countPokemon, doWithoutSendingUpdates, find, findAll, findAll, findOne, findOne, getShouldSendUpdates, hasSpace, notifyListener, notifyListeners, retrieveAll, setHasChanged, setNeedsSaving, toString, transfer, validate

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

Methods inherited from interface com.pixelmonmod.pixelmon.api.economy.BankAccount
add, add, add, hasBalance, hasBalance, hasBalance, setBalance, setBalance, setBalance, take, take, take, updatePlayer, updatePlayer

Field Detail
- playerName
```
protected java.lang.String playerName
```
  The name of the player whose storage this is.
- trainerCardColor
```
public EnumTrainerCardColor trainerCardColor
```
  The color of the players Trainer Card.
- teleportPos
```
public TeleportPosition teleportPos
```
  The player's current teleport position with the Teleport/Fly external moves.
- pokeDollars
```
protected java.math.BigDecimal pokeDollars
```
  The amount of money the player has.
- playerPokedex
```
public PlayerPokedex playerPokedex
```
  The player's Pokédex.
- stats
```
public PlayerStats stats
```
  The player's battle stats.
- guiOpened
```
public boolean guiOpened
```
  Whether the player is looking at a GUI.
- battleEnabled
```
public boolean battleEnabled
```
  Whether the owner of the storage can battle.
- starterPicked
```
public boolean starterPicked
```
  Whether the player has picked a starter yet
- oldGen
```
public boolean oldGen
```
  Whether the player is in Mega/Z mode or not.
- playerData
```
public PlayerData playerData
```
- lastBattle
```
protected BattleLog lastBattle
```
- transientData
```
public transient TransientData transientData
```

Constructor Detail

PlayerPartyStorage

public PlayerPartyStorage(java.util.UUID uuid,
                          boolean shouldSendUpdates)

PlayerPartyStorage

public PlayerPartyStorage(java.util.UUID uuid)

Method Detail

getIdentifier
```
public java.util.UUID getIdentifier()
```
Description copied from interface: BankAccount

Gets the unique identifier of the given entity

Specified by:

getIdentifier in interface BankAccount

Returns:

The identifier

add
```
public boolean add(Pokemon pokemon)
```
Description copied from class: PokemonStorage

Adds the given Pokemon to this storage in the first available position. If the storage is full, then in the case that it is a PlayerPartyStorage then it will attempt to add to the PC and pass back the return value from there.

Overrides:

add in class PokemonStorage

Parameters:

pokemon - The Pokemon to add to the storage.

Returns:

true if it was able to add to this storage, or in the case of this being a full PlayerPartyStorage, true if there was an empty space in the PC. Otherwise false

addSilently
```
public TriBoolean addSilently(Pokemon pokemon)
```
Advanced method for adding Pokémon to player storage. Returns a tristate enum representing what happened. Does not send any messages to the player, you're expected to handle this yourself here.

Parameters:

pokemon - Pokémon object to add to storage.

Returns:

TRUE = added to party, FALSE = added to PC, NULL = failed to add

tryUpdatePlayerName
```
public void tryUpdatePlayerName()
```

getPlayer

@Nullable
public net.minecraft.entity.player.ServerPlayerEntity getPlayer()

getPlayerName

@Nullable
public java.lang.String getPlayerName()

getPlayerUUID
```
public java.util.UUID getPlayerUUID()
```

set

public void set(StoragePosition position,
                Pokemon pokemon)

Overrides:: set in class PartyStorage

writeToNBT

public net.minecraft.nbt.CompoundNBT writeToNBT(net.minecraft.nbt.CompoundNBT nbt)

Overrides:: writeToNBT in class PartyStorage

readFromNBT

public PlayerPartyStorage readFromNBT(net.minecraft.nbt.CompoundNBT nbt)

Overrides:: readFromNBT in class PartyStorage

getPlayersToUpdate

public java.util.List<net.minecraft.entity.player.ServerPlayerEntity> getPlayersToUpdate()

Overrides:: getPlayersToUpdate in class PartyStorage

getShouldSave
```
public boolean getShouldSave()
```
Overrides:

getShouldSave in class PokemonStorage

getCurryData
```
public int[] getCurryData()
```
Overrides:

getCurryData in class PokemonStorage

updateSingleCurryData

public void updateSingleCurryData(EnumCurryKey curryKey,
                                  EnumBerryFlavor cookingFlavor,
                                  EnumCurryRating rating)

Overrides:: updateSingleCurryData in class PokemonStorage

fillOneCurryDexFlavor
```
public void fillOneCurryDexFlavor(int curryDexPage,
                                  int curryDexFlavor,
                                  int curryDexRating)
```
Fills in one flavor entry for one curry dish with the given rating.

Parameters:

curryDexPage - The page number the desired curry dish is on.

curryDexFlavor - The position of the desired flavor on a page.

curryDexRating - The rating to be given to the desired flavor.

fillOneCurryDexPage
```
public void fillOneCurryDexPage(int curryDexPage,
                                int curryDexRating)
```
Fills in one page of the curry dex with the given rating.

Parameters:

curryDexPage - The page number of the curry dish to be filled in.

curryDexRating - The rating to be given to the entire page.

fillEntireCurryDex
```
public void fillEntireCurryDex(int curryDexRating)
```
Fills in the entire curry dex with the given rating.

Parameters:

curryDexRating - The rating to be given to the entire dex.

isMegaItemObtained

public boolean isMegaItemObtained(Species pokemon,
                                  Stats form)

obtainedItem

public void obtainedItem(Species pokemon,
                         Stats form,
                         net.minecraft.entity.player.ServerPlayerEntity player)

setMegaItem

public void setMegaItem(EnumMegaItem megaItem,
                        boolean giveChoice)

unlockMega
```
public void unlockMega()
```

lockMega
```
public void lockMega()
```

unlockDynamax
```
public void unlockDynamax()
```

lockDynamax
```
public void lockDynamax()
```

setMegaItemsUnlocked

public void setMegaItemsUnlocked(EnumMegaItemsUnlocked megaItemsUnlocked)

setShinyCharm

public void setShinyCharm(EnumFeatureState shinyCharm)

setOvalCharm

public void setOvalCharm(EnumFeatureState ovalCharm)

setExpCharm

public void setExpCharm(EnumFeatureState expCharm)

setCatchingCharm

public void setCatchingCharm(EnumFeatureState catchingCharm)

setMarkCharm

public void setMarkCharm(EnumFeatureState markCharm)

setHweenRobe

@Deprecated
public void setHweenRobe(EnumFeatureState hweenRobe)

Deprecated.

canEquipMegaItem
```
public boolean canEquipMegaItem()
```

getMegaItem
```
public EnumMegaItem getMegaItem()
```

getMegaItemsUnlocked

public EnumMegaItemsUnlocked getMegaItemsUnlocked()

getShinyCharm

public EnumFeatureState getShinyCharm()

getOvalCharm

public EnumFeatureState getOvalCharm()

getExpCharm
```
public EnumFeatureState getExpCharm()
```

getCatchingCharm

public EnumFeatureState getCatchingCharm()

getMarkCharm

public EnumFeatureState getMarkCharm()

getHweenRobe

@Deprecated
public EnumFeatureState getHweenRobe()

Deprecated.

getServerCosmetics

public java.util.Set<ServerCosmetics> getServerCosmetics()

setServerCosmetics

public void setServerCosmetics(java.util.Set<ServerCosmetics> cosmetics)

grantServerCosmetics

public void grantServerCosmetics(ServerCosmetics... cosmetics)

revokeServerCosmetics

public void revokeServerCosmetics(ServerCosmetics... cosmetics)

getLureStack

public net.minecraft.item.ItemStack getLureStack()

getLure
```
@Nullable
public LureItem getLure()
```

setLureStack

public void setLureStack(net.minecraft.item.ItemStack stack)

setLure
```
public void setLure(LureItem lure)
```

dropLureInLureSlot
```
public void dropLureInLureSlot(net.minecraft.entity.player.ServerPlayerEntity player)
```
If the player has a lure in their lureSlot make it drop from their inventory.

hasBalance
```
public boolean hasBalance(java.math.BigDecimal amount)
```
Description copied from interface: BankAccount

Checks if the account has more than the given amount

Specified by:

hasBalance in interface BankAccount

Parameters:

amount - Amount to check

Returns:

True if the account has more

getBalance
```
public java.math.BigDecimal getBalance()
```
Description copied from interface: BankAccount

Gets balance of the account

Specified by:

getBalance in interface BankAccount

Returns:

The amount of money

setBalance
```
public void setBalance(java.math.BigDecimal amount)
```
Description copied from interface: BankAccount

Sets the balance of the account

Specified by:

setBalance in interface BankAccount

Parameters:

amount - The new balance

add
```
public boolean add(java.math.BigDecimal amount)
```
Description copied from interface: BankAccount

Adds the amount to the current balance Returns false if the transaction fails for any given reason (check console logs) DO NOT PASS NEGATIVE VALUES

Specified by:

add in interface BankAccount

Parameters:

amount - The amount being added

Returns:

true if successful

take
```
public boolean take(java.math.BigDecimal amount)
```
Description copied from interface: BankAccount

Take the amount to the current balance Returns false if the transaction fails for any given reason (check console logs) DO NOT PASS NEGATIVE VALUES

Specified by:

take in interface BankAccount

Parameters:

amount - The amount being taken

Returns:

true if successful

updatePartyCache
```
public void updatePartyCache()
```
Updates the cache of pokemonLevel data in the storage.

getTicksTillEncounter
```
public int getTicksTillEncounter()
```
Gets the number of ticks until Pixelmon grass spawns a Pokémon against the player.

Returns:

The number of ticks until Pixelmon grass spawns a Pokémon against the player.

updateTicksTillEncounter
```
public void updateTicksTillEncounter()
```
Ticks the number of ticks until Pixelmon grass spawns a Pokémon against the player. Resets the counter if it reaches 1.

checkPokerus
```
public void checkPokerus()
```
NOTE: I could probably make this more optimized, thanks to the new storage

getMultiplier

public float getMultiplier(AbstractSpawner spawner,
                           SpawnInfo spawnInfo,
                           float sum,
                           float rarity)

Specified by:: getMultiplier in interface RarityTweak

getQuestData

public QuestData getQuestData(boolean update)

Quest storage getter.

getQuestData
```
public QuestData getQuestData()
```

resetQuestData
```
public void resetQuestData()
```

closeBattleSafely
```
public void closeBattleSafely()
```
Safely shuts down battles on the client.

addTaskForBattleEnd

public BattleEndTaskResult addTaskForBattleEnd(BattleEndTaskType type,
                                               java.util.function.Consumer<java.util.Optional<BattleController>> consumer)

Add a task to be executed once the client has left the battle UI. Careful, the battle controller may be null!

queryResourceLocationExistence
```
public void queryResourceLocationExistence(net.minecraft.util.ResourceLocation resource,
                                           java.util.function.Consumer<java.lang.Boolean> result)
```
Query existence of a ResourceLocation on the client.

Parameters:

resource - ResourceLocation to be queried.

result - Consumer to be executed with the result of the query.

receiveResourceLocationQueryResult

public void receiveResourceLocationQueryResult(java.util.UUID query,
                                               boolean result)

registerKeyListener

public void registerKeyListener(java.lang.Object instance,
                                java.lang.reflect.Method callback)

receiveKeyInput

public void receiveKeyInput(int keyCode,
                            int scanCode,
                            int modifiers)

deregisterKeyListener
```
public void deregisterKeyListener()
```

getSelectedSlot
```
public int getSelectedSlot()
```

setSelectedSlot

public void setSelectedSlot(int selectedSlot)

setSelectedSlot

public void setSelectedSlot(int selectedSlot,
                            boolean sendPacket)

getSelectedPokemon
```
public Pokemon getSelectedPokemon()
```

sendClientUpdatePacket
```
public void sendClientUpdatePacket()
```

sendClientUpdateSelectedPacket

public void sendClientUpdateSelectedPacket()

getDayCare
```
public PlayerDayCare getDayCare()
```

setDayCare

public void setDayCare(PlayerDayCare dayCare)

getLastBattle
```
public BattleLog getLastBattle()
```

setLastBattle

public void setLastBattle(BattleLog lastBattle)

Class PlayerPartyStorage

Field Summary

Fields inherited from class com.pixelmonmod.pixelmon.api.storage.PartyStorage

Fields inherited from class com.pixelmonmod.pixelmon.api.storage.PokemonStorage

Constructor Summary

Method Summary

Methods inherited from class com.pixelmonmod.pixelmon.api.storage.PartyStorage

Methods inherited from class com.pixelmonmod.pixelmon.api.storage.PokemonStorage

Methods inherited from class java.lang.Object

Methods inherited from interface com.pixelmonmod.pixelmon.api.economy.BankAccount

Field Detail

playerName

trainerCardColor

teleportPos

pokeDollars

playerPokedex

stats

guiOpened

battleEnabled

starterPicked

oldGen

playerData

lastBattle

transientData

Constructor Detail

PlayerPartyStorage

PlayerPartyStorage

Method Detail

getIdentifier

add

addSilently

tryUpdatePlayerName

getPlayer

getPlayerName

getPlayerUUID

set

writeToNBT

readFromNBT

getPlayersToUpdate

getShouldSave

getCurryData

updateSingleCurryData

fillOneCurryDexFlavor

fillOneCurryDexPage

fillEntireCurryDex

isMegaItemObtained

obtainedItem

setMegaItem

unlockMega

lockMega

unlockDynamax

lockDynamax

setMegaItemsUnlocked

setShinyCharm

setOvalCharm

setExpCharm

setCatchingCharm

setMarkCharm

setHweenRobe

canEquipMegaItem

getMegaItem

getMegaItemsUnlocked

getShinyCharm

getOvalCharm

getExpCharm

getCatchingCharm

getMarkCharm

getHweenRobe

getServerCosmetics

setServerCosmetics

grantServerCosmetics

revokeServerCosmetics

getLureStack

getLure

setLureStack

setLure

dropLureInLureSlot

hasBalance

getBalance

setBalance