Package dev.drawethree.xprison.api.mines

Interface XPrisonMinesAPI

public interface XPrisonMinesAPI
API for interacting with mines in the XPrison plugin.

  • Method Details

    • getMines

      Collection<Mine> getMines()
      Gets all mines
      Returns:
      The collection of Mine

    • getMineByName

      Mine getMineByName(String name)
      Gets a mine by its name.
      Parameters:
      name - The name of the mine
      Returns:
      The Mine instance matching the given name, or null if no such mine exists

    • getMineAtLocation

      Mine getMineAtLocation(org.bukkit.Location loc)
      Gets the mine located at a specific location.
      Parameters:
      loc - The Location to check
      Returns:
      The Mine containing the given location, or null if none is found

    • createMine

      Mine createMine(MineSelection mineSelection, String name)
      Creates a new mine with the specified selection boundaries and name.
      Parameters:
      mineSelection - The MineSelection defining the mine boundaries
      name - The name of the new mine
      Returns:
      The created Mine instance

    • deleteMine

      boolean deleteMine(Mine mine)
      Deletes the specified mine.
      Parameters:
      mine - The Mine to delete
      Returns:
      true if the mine was successfully deleted, false otherwise

    • resetMine

      void resetMine(Mine mine)
      Resets the contents of the given mine.
      Parameters:
      mine - The Mine to reset