Package dev.drawethree.xprison.api.mines.model

Interface Mine

public interface Mine
Represents a mine area with associated properties and behaviors.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addEffect(org.bukkit.potion.PotionEffectType potionEffectType, int level)
    Adds a potion effect to all players in the mine.
    BlockPalette
    getBlockPalette()
    Gets the block palette associated with the mine.
    int
    getCurrentBlocks()
    Gets the current number of blocks remaining in the mine.
    String
    getName()
    Gets the name of the mine.
    Date
    getNextResetDate()
    Gets the next scheduled reset date/time of the mine.
    Collection<org.bukkit.entity.Player>
    getPlayersInMine()
    Gets all players currently inside the mine.
    me.lucko.helper.serialize.Region
    getRegion()
    Gets the region that defines the boundaries of the mine.
    double
    getResetPercentage()
    Gets the percentage of blocks that trigger a reset of the mine.
    me.lucko.helper.serialize.Point
    getTeleportLocation()
    Gets the teleport location inside the mine.
    int
    getTotalBlocks()
    Gets the total number of blocks in the mine.
    boolean
    isInMine(org.bukkit.Location location)
    Checks if a given location is inside the mine.
    boolean
    isResetting()
    Returns whether the mine is currently resetting.
    void
    removeEffect(org.bukkit.potion.PotionEffectType potionEffectType)
    Removes a potion effect from all players in the mine.

  • Method Details

    • getName

      String getName()
      Gets the name of the mine.
      Returns:
      the name of the mine

    • getRegion

      me.lucko.helper.serialize.Region getRegion()
      Gets the region that defines the boundaries of the mine.
      Returns:
      the Region of the mine

    • getTeleportLocation

      me.lucko.helper.serialize.Point getTeleportLocation()
      Gets the teleport location inside the mine.
      Returns:
      the Point where players are teleported within the mine

    • getBlockPalette

      BlockPalette getBlockPalette()
      Gets the block palette associated with the mine.
      Returns:
      the BlockPalette used for this mine

    • getResetPercentage

      double getResetPercentage()
      Gets the percentage of blocks that trigger a reset of the mine.
      Returns:
      the reset percentage as a double (e.g., 0.2 for 20%)

    • getTotalBlocks

      int getTotalBlocks()
      Gets the total number of blocks in the mine.
      Returns:
      total block count

    • getCurrentBlocks

      int getCurrentBlocks()
      Gets the current number of blocks remaining in the mine.
      Returns:
      current block count

    • isResetting

      boolean isResetting()
      Returns whether the mine is currently resetting.
      Returns:
      true if the mine is resetting, false otherwise

    • getNextResetDate

      Date getNextResetDate()
      Gets the next scheduled reset date/time of the mine.
      Returns:
      the Date when the mine will next reset

    • isInMine

      boolean isInMine(org.bukkit.Location location)
      Checks if a given location is inside the mine.
      Parameters:
      location - the Location to check
      Returns:
      true if the location is inside the mine, false otherwise

    • getPlayersInMine

      Collection<org.bukkit.entity.Player> getPlayersInMine()
      Gets all players currently inside the mine.
      Returns:
      a collection of players inside the mine

    • addEffect

      void addEffect(org.bukkit.potion.PotionEffectType potionEffectType, int level)
      Adds a potion effect to all players in the mine.
      Parameters:
      potionEffectType - the type of potion effect to add
      level - the level (amplifier) of the effect

    • removeEffect

      void removeEffect(org.bukkit.potion.PotionEffectType potionEffectType)
      Removes a potion effect from all players in the mine.
      Parameters:
      potionEffectType - the type of potion effect to remove