java.lang.Object

com.pixelmonmod.pixelmon.api.storage.PixelmonStorageManager

All Implemented Interfaces:: BankAccountManager, StorageManager

public class PixelmonStorageManager extends Object implements StorageManager, BankAccountManager

The default StorageManager for Pixelmon. Alternative implementations that are not extensions of this class are only necessary in exceedingly rare cases.

Since:: September 9, 2018 (Pixelmon 7.0.0)

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

PixelmonStorageManager.PlayerDataLoading
Field Summary

Fields

Modifier and Type

Field

Description

protected final Map<UUID,PlayerPartyStorage>

parties

protected final Map<UUID,PCStorage>

pcs

protected final Map<UUID,PixelmonStorageManager.PlayerDataLoading>

waitingToLoad
Constructor Summary

Constructors

Constructor

Description

PixelmonStorageManager()
Method Summary

Modifier and Type

Method

Description

void

clearAll()

Clears the cache of all storages

Iterable<PokemonStorage>

getAllCachedStorages()

Gets all the cached PokemonStorage this implementation is storing

CompletableFuture<? extends BankAccount>

getBankAccount(UUID uuid)

Attempts to get the bank account for the given UUID, presumably a player's UUID

CompletableFuture<? extends BankAccount>

getBankAccount(net.minecraft.server.level.ServerPlayer player)

Attempts to get the bank account for the given ServerPlayer

CompletableFuture<PlayerPartyStorage>

getParty(UUID uuid)

Gets the player's party waiting until it is loaded from the file if necessary

CompletableFuture<PCStorage>

getPCForPlayer(UUID uuid)

Gets the PC for the player waiting until it is loaded from file, if necessary

void

invalidateCache(PokemonStorage storage)

Removes the cache of the given storage

protected PixelmonStorageManager.PlayerDataLoading

loadData(UUID uuid, boolean party, boolean pc)

void

onPlayerLogin(net.minecraftforge.event.entity.player.PlayerEvent.LoadFromFile event)

void

onPlayerLogin(net.minecraftforge.event.entity.player.PlayerEvent.PlayerLoggedInEvent event)

void

onPlayerLogout(net.minecraftforge.event.entity.player.PlayerEvent.PlayerLoggedOutEvent event)

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

Methods inherited from interface com.pixelmonmod.pixelmon.api.economy.BankAccountManager
getBankAccountNow, getBankAccountNow

Methods inherited from interface com.pixelmonmod.pixelmon.api.storage.StorageManager
getParty, getPartyNow, getPartyNow, getPC, getPCForPlayer, getPCForPlayerNow, getPCForPlayerNow, getPCNow, getPokemon, getStorage, getStorageNow

Field Details
- parties
  
  protected final Map<UUID,PlayerPartyStorage> parties
- pcs
  
  protected final Map<UUID,PCStorage> pcs
- waitingToLoad
  
  protected final Map<UUID,PixelmonStorageManager.PlayerDataLoading> waitingToLoad
Constructor Details
- PixelmonStorageManager
  
  public PixelmonStorageManager()
Method Details
- invalidateCache
  
  public void invalidateCache(PokemonStorage storage)
  
  Description copied from interface: StorageManager
  
  Removes the cache of the given storage
  
  Specified by:
  
  invalidateCache in interface StorageManager
  
  Parameters:
  
  storage - The storage to remove
- getParty
  
  public CompletableFuture<PlayerPartyStorage> getParty(UUID uuid)
  
  Description copied from interface: StorageManager
  
  Gets the player's party waiting until it is loaded from the file if necessary
  
  Specified by:
  
  getParty in interface StorageManager
  
  Parameters:
  
  uuid - The player
  
  Returns:
  
  The future party
- getPCForPlayer
  
  public CompletableFuture<PCStorage> getPCForPlayer(UUID uuid)
  
  Description copied from interface: StorageManager
  
  Gets the PC for the player waiting until it is loaded from file, if necessary
  
  Specified by:
  
  getPCForPlayer in interface StorageManager
  
  Parameters:
  
  uuid - The UUID of the player
  
  Returns:
  
  The future PC storage
- getAllCachedStorages
  
  public Iterable<PokemonStorage> getAllCachedStorages()
  
  Description copied from interface: StorageManager
  
  Gets all the cached PokemonStorage this implementation is storing
  
  Specified by:
  
  getAllCachedStorages in interface StorageManager
  
  Returns:
  
  The cached storages
- clearAll
  
  public void clearAll()
  
  Description copied from interface: StorageManager
  
  Clears the cache of all storages
  
  Specified by:
  
  clearAll in interface StorageManager
- getBankAccount
  
  public CompletableFuture<? extends BankAccount> getBankAccount(UUID uuid)
  
  Description copied from interface: BankAccountManager
  
  Attempts to get the bank account for the given UUID, presumably a player's UUID
  
  Specified by:
  
  getBankAccount in interface BankAccountManager
  
  Parameters:
  
  uuid - The owner of the account
  
  Returns:
  
  The future bank account
- getBankAccount
  
  public CompletableFuture<? extends BankAccount> getBankAccount(net.minecraft.server.level.ServerPlayer player)
  
  Description copied from interface: BankAccountManager
  
  Attempts to get the bank account for the given ServerPlayer
  
  Specified by:
  
  getBankAccount in interface BankAccountManager
  
  Parameters:
  
  player - The owner of the account
  
  Returns:
  
  The future bank account
- onPlayerLogin
  
  public void onPlayerLogin(net.minecraftforge.event.entity.player.PlayerEvent.PlayerLoggedInEvent event)
- onPlayerLogin
  
  public void onPlayerLogin(net.minecraftforge.event.entity.player.PlayerEvent.LoadFromFile event)
- loadData
  
  protected PixelmonStorageManager.PlayerDataLoading loadData(UUID uuid, boolean party, boolean pc)
- onPlayerLogout
  
  public void onPlayerLogout(net.minecraftforge.event.entity.player.PlayerEvent.PlayerLoggedOutEvent event)

Class PixelmonStorageManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pixelmonmod.pixelmon.api.storage.StorageManager

Field Details

parties

pcs

waitingToLoad

Constructor Details

PixelmonStorageManager

Method Details

invalidateCache

getParty

getPCForPlayer

getAllCachedStorages

clearAll

getBankAccount

getBankAccount

onPlayerLogin

onPlayerLogin

loadData

onPlayerLogout