Package dev.drawethree.xprison.api.pickaxelevels

Interface XPrisonPickaxeLevelsAPI

public interface XPrisonPickaxeLevelsAPI
API for managing pickaxe levels in XPrison.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<PickaxeLevel>
    getPickaxeLevel(int level)
    Gets the pickaxe level by its numeric level.
    Optional<PickaxeLevel>
    getPickaxeLevel(org.bukkit.entity.Player player)
    Gets the pickaxe level of a specific player.
    Optional<PickaxeLevel>
    getPickaxeLevel(org.bukkit.inventory.ItemStack item)
    Gets the pickaxe level associated with the given item stack.
    String
    getProgressBar(org.bukkit.entity.Player player)
    Gets the progress bar string representing the player's pickaxe level progress.
    void
    setPickaxeLevel(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack item, int level)
    Sets the pickaxe level on an item stack for a player by level number.
    void
    setPickaxeLevel(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack item, PickaxeLevel level)
    Sets the pickaxe level on an item stack for a player.

  • Method Details

    • getPickaxeLevel

      Optional<PickaxeLevel> getPickaxeLevel(org.bukkit.inventory.ItemStack item)
      Gets the pickaxe level associated with the given item stack.
      Parameters:
      item - the ItemStack to check
      Returns:
      an Optional containing the PickaxeLevel if present, otherwise empty

    • getPickaxeLevel

      Optional<PickaxeLevel> getPickaxeLevel(org.bukkit.entity.Player player)
      Gets the pickaxe level of a specific player.
      Parameters:
      player - the player whose pickaxe level to get
      Returns:
      an Optional containing the PickaxeLevel if present, otherwise empty

    • getPickaxeLevel

      Optional<PickaxeLevel> getPickaxeLevel(int level)
      Gets the pickaxe level by its numeric level.
      Parameters:
      level - the level to retrieve
      Returns:
      an Optional containing the PickaxeLevel if found, otherwise empty

    • setPickaxeLevel

      void setPickaxeLevel(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack item, PickaxeLevel level)
      Sets the pickaxe level on an item stack for a player.
      Parameters:
      player - the player owning the item
      item - the ItemStack to modify
      level - the PickaxeLevel to set

    • setPickaxeLevel

      void setPickaxeLevel(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack item, int level)
      Sets the pickaxe level on an item stack for a player by level number.
      Parameters:
      player - the player owning the item
      item - the ItemStack to modify
      level - the numeric level to set

    • getProgressBar

      String getProgressBar(org.bukkit.entity.Player player)
      Gets the progress bar string representing the player's pickaxe level progress.
      Parameters:
      player - the player to get the progress bar for
      Returns:
      a string representing the progress bar