Package com.zetaplugins.cookieclickerz.storage

Class Storage

java.lang.Object
com.zetaplugins.cookieclickerz.storage.Storage
Direct Known Subclasses:
SQLStorage
public abstract class Storage extends Object

  • Constructor Details

  • Method Details

    • getPlugin

      protected CookieClickerZ getPlugin()

    • shouldUsePlayerCache

      protected boolean shouldUsePlayerCache()

    • getMaxCacheSize

      protected int getMaxCacheSize()

    • init

      public abstract void init()
      Initialize the storage system.

    • save

      public abstract void save(PlayerData playerData)
      Save a player data object to the storage system.
      Parameters:
      playerData - The player data object to save.

    • load

      public PlayerData load(String uuid)
      Load a player data object from the storage system.
      Parameters:
      uuid - The UUID of the player.
      Returns:
      The player data object.

    • load

      public abstract PlayerData load(UUID uuid)
      Load a player data object from the storage system.
      Parameters:
      uuid - The UUID of the player.
      Returns:
      The player data object.

    • export

      public abstract String export(String fileName)
      Export the player data to a file.

    • importData

      public abstract void importData(String fileName)
      Import player data from a file.
      Parameters:
      fileName - The name of the file to import from.

    • getAllPlayers

      public abstract List<PlayerData> getAllPlayers()
      Get a List of all players in the storage system.
      Returns:
      A List of all players. PlayerData does not contain achievements and upgrades.

    • getTopCookiesPlayers

      public abstract List<LeaderBoardEntry> getTopCookiesPlayers(int limit)
      Get a List of the top players by total cookies.
      Parameters:
      limit - The maximum number of players to return.
      Returns:
      A List of the top players. PlayerData does not contain achievements and upgrades.

    • getTopCpcPlayers

      public abstract List<LeaderBoardEntry> getTopCpcPlayers(int limit)
      Get a List of the top players by cookies per click.
      Parameters:
      limit - The maximum number of players to return.
      Returns:
      A List of the top players. PlayerData does not contain achievements and upgrades.

    • saveAllCachedData

      public abstract void saveAllCachedData()
      Save all cached data to the storage system.