Class PlanetPlayer

java.lang.Object
ua.mcchickenstudio.opencreative.planets.PlanetPlayer
public class PlanetPlayer extends Object

PlanetPlayer

This class represents a Player in planet, he has saved purchases, inventory, own ender chest and other required parameters. Saved data stores in planet's world as /playersData/UUID.json.

  • Constructor Details

    • PlanetPlayer

      public PlanetPlayer(@NotNull @NotNull Planet currentPlanet, @NotNull @NotNull org.bukkit.entity.Player player)

  • Method Details

    • setWorldSize

      public void setWorldSize(@Nullable @Nullable Double worldSize)

    • getWorldSize

      @Nullable public @Nullable Double getWorldSize()

    • getCurrentPlanet

      @NotNull public @NotNull Planet getCurrentPlanet()
      Returns planet, where player is registered.
      Returns:
      associated planet.

    • getPlayer

      @NotNull public @NotNull org.bukkit.entity.Player getPlayer()
      Returns Bukkit's player.
      Returns:
      World player as Bukkit's player.

    • getSavedInventory

      public org.bukkit.inventory.ItemStack[] getSavedInventory()

    • getSavedEnderChest

      public org.bukkit.inventory.ItemStack[] getSavedEnderChest()

    • saveInventory

      public void saveInventory(org.bukkit.inventory.ItemStack[] items)
      Saves items array as inventory. Used in player action "Save Inventory".
      Parameters:
      items - Array of ItemStacks to save.

    • saveEnderChest

      public void saveEnderChest(org.bukkit.inventory.ItemStack[] items)
      Saves items array as items in ender chest. Used for saving player's own ender chest.
      Parameters:
      items - Array of ItemStacks to save.

    • load

      public boolean load()
      Loads saved player data from JSON file, that stored in planet's folder as /playerData/UUID.json.
      Returns:
      True - if successfully loaded, false - if failed to load.

    • save

      public boolean save()
      Saves some required player data into JSON file in planet's folder as /playerData/UUID.json.
      Returns:
      True - if successfully saved, false - if failed to save.

    • getPurchases

      @NotNull public @NotNull Set<String> getPurchases()
      Returns set of saved purchases IDs.
      Returns:
      set of saved purchases IDs.

    • addPurchase

      public void addPurchase(String id)
      Adds purchase ID into set of saved player's purchases.
      Parameters:
      id - ID of purchase.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object