package me.jet315.prisonmines;


public class JetsPrisonMinesAPI {

    /**
     *
     * @return All current active mines
     */
    Collection<Mine> getMines();

    /**
     *
     * @param block The block at the location you are searching for mines for
     * @return A mine arraylist of mines that contain this block location
     */
    ArrayList<Mine> getMinesByBlock(Block block);

    /**
     *
     * @param loc The location at which you are searching for mines for
     * @return A mine arraylist of mines that contain this location
     */
    ArrayList<Mine> getMinesByLocation(Location loc);

    /**
     * @param mineName The mine you are trying to get
     * @return The mine object, or null if it does not exist
     */
   Mine getMineByName(String mineName);

    /**
     * This method should be called if you are removing a block from a certain/possible mine (it will locate the mine automatically)
     * @param block The block that is being broken
     */
   void blockBreak(Block block);

    /**
     * This method should be called if you are placing a block to a certain/possible mine (it will locate the mine automatically)
     * @param block The block that is being placed
     */
   void blockPlace(Block block);
}