1.5

Updated AutoSellAPI to support SellRegions

Author: Jan Kluka

src/main/java/dev/drawethree/xprison/api/autosell/XPrisonAutoSellAPI.java

@@ -1,10 +1,13 @@
 package dev.drawethree.xprison.api.autosell;
 
 import com.cryptomorin.xseries.XMaterial;
+import dev.drawethree.xprison.api.autosell.model.SellRegion;
+import org.bukkit.Location;
 import org.bukkit.block.Block;
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.ItemStack;
 
+import java.util.Collection;
 import java.util.List;
 
 /**
@@ -15,15 +18,15 @@ public interface XPrisonAutoSellAPI {
 
 
 	/**
-	 * Gets the price of a specific item
+	 * Gets the global price of a specific item
 	 *
 	 * @param item   the item to get the price for
 	 * @return the price of the item
 	 */
 	double getPriceForItem(ItemStack item);
 
 	/**
-	 * Gets the price for a given block.
+	 * Gets the global price for a given block.
 	 *
 	 * @param block the block to get the price for
 	 * @return the price of the block
@@ -47,25 +50,49 @@ public interface XPrisonAutoSellAPI {
 	boolean hasAutoSellEnabled(Player p);
 
 	/**
-	 * Adds or updates the sell price for a specific material
+	 * Adds or updates the global sell price for a specific material
 	 *
 	 * @param material the material to set the sell price for
 	 * @param price    the price at which the material will be sold
 	 */
 	void addSellPrice(XMaterial material, double price);
 
 	/**
-	 * Removes a material from being sellable in this region.
+	 * Removes a material from being sellable globally.
 	 *
 	 * @param material the material to remove from the sell price list
 	 */
 	void removeSellPrice(XMaterial material);
 
 	/**
-	 * Gets the sell price for a specific material in this region.
+	 * Gets the global sell price for a specific material.
 	 *
 	 * @param material the material to get the price for
 	 * @return the sell price of the material, or 0 if not sellable
 	 */
 	double getSellPriceForMaterial(XMaterial material);
+
+    /**
+     * Gets the price of a specific item in a given sell region.
+     *
+     * @param region the sell region to check pricing in
+     * @param item   the item to get the price for
+     * @return the price of the item in the specified region
+     */
+    double getPriceForItem(SellRegion region, ItemStack item);
+
+    /**
+     * Gets a collection of all loaded and active sell regions.
+     *
+     * @return a collection of all sell regions
+     */
+    Collection<SellRegion> getSellRegions();
+
+    /**
+     * Gets the sell region at a specified location.
+     *
+     * @param location the location to check
+     * @return the sell region at the given location, or {@code null} if none exists there
+     */
+    SellRegion getSellRegionAtLocation(Location location);
 }

src/main/java/dev/drawethree/xprison/api/autosell/events/XPrisonAutoSellEvent.java

@@ -1,13 +1,15 @@
 package dev.drawethree.xprison.api.autosell.events;
 
 import dev.drawethree.xprison.api.autosell.model.AutoSellItemStack;
+import dev.drawethree.xprison.api.autosell.model.SellRegion;
 import dev.drawethree.xprison.api.shared.events.player.XPrisonPlayerEvent;
 import lombok.Getter;
 import lombok.Setter;
 import org.bukkit.entity.Player;
 import org.bukkit.event.Cancellable;
 import org.bukkit.event.HandlerList;
 
+import javax.annotation.Nullable;
 import java.util.Map;
 
 /**
@@ -22,6 +24,8 @@ public final class XPrisonAutoSellEvent extends XPrisonPlayerEvent implements Ca
 
     @Setter
     private Map<AutoSellItemStack, Double> itemsToSell;
+    @Nullable
+    private final SellRegion region;
 
     @Setter
     private boolean cancelled;
@@ -31,11 +35,13 @@ public final class XPrisonAutoSellEvent extends XPrisonPlayerEvent implements Ca
      *
      * @param player      The player who mined the blocks and triggered auto-sell
      * @param itemsToSell A map of items to be sold with their respective prices
+     * @param region         The sell region where the blocks were mined, can be null
      */
-    public XPrisonAutoSellEvent(Player player, Map<AutoSellItemStack, Double> itemsToSell) {
+    public XPrisonAutoSellEvent(Player player, Map<AutoSellItemStack, Double> itemsToSell, @Nullable SellRegion region) {
         super(player);
         this.player = player;
         this.itemsToSell = itemsToSell;
+        this.region = region;
     }
 
     /**

src/main/java/dev/drawethree/xprison/api/autosell/events/XPrisonSellAllEvent.java

@@ -1,13 +1,15 @@
 package dev.drawethree.xprison.api.autosell.events;
 
 import dev.drawethree.xprison.api.autosell.model.AutoSellItemStack;
+import dev.drawethree.xprison.api.autosell.model.SellRegion;
 import dev.drawethree.xprison.api.shared.events.player.XPrisonPlayerEvent;
 import lombok.Getter;
 import lombok.Setter;
 import org.bukkit.entity.Player;
 import org.bukkit.event.Cancellable;
 import org.bukkit.event.HandlerList;
 
+import javax.annotation.Nullable;
 import java.util.Map;
 
 /**
@@ -24,7 +26,10 @@ public final class XPrisonSellAllEvent extends XPrisonPlayerEvent implements Can
 	@Setter
 	private Map<AutoSellItemStack, Double> itemsToSell;
 
-	@Getter
+    @Nullable
+    private final SellRegion region;
+
+    @Getter
 	@Setter
 	private boolean cancelled;
 
@@ -33,12 +38,14 @@ public final class XPrisonSellAllEvent extends XPrisonPlayerEvent implements Can
 	 *
 	 * @param player      The player performing the sell-all
 	 * @param itemsToSell A map of items to sell and their respective prices
+     * @param region         The sell region where the blocks were mined, can be null
 	 */
-	public XPrisonSellAllEvent(Player player, Map<AutoSellItemStack, Double> itemsToSell) {
+	public XPrisonSellAllEvent(Player player, Map<AutoSellItemStack, Double> itemsToSell, @Nullable SellRegion region) {
 		super(player);
 		this.player = player;
 		this.itemsToSell = itemsToSell;
-	}
+        this.region = region;
+    }
 
 	/**
 	 * Gets the list of event handlers.

src/main/java/dev/drawethree/xprison/api/autosell/model/SellRegion.java

@@ -0,0 +1,75 @@
+package dev.drawethree.xprison.api.autosell.model;
+
+import com.cryptomorin.xseries.XMaterial;
+import org.bukkit.Location;
+import org.bukkit.World;
+import org.bukkit.entity.Player;
+import org.codemc.worldguardwrapper.region.IWrappedRegion;
+
+/**
+ * Represents a region where auto-selling blocks or items is allowed.
+ * Contains methods to manage sell prices and permissions within the region.
+ */
+public interface SellRegion {
+
+    /**
+     * Gets the WorldGuard region this SellRegion represents.
+     *
+     * @return the wrapped WorldGuard region
+     */
+    IWrappedRegion getRegion();
+
+    /**
+     * Gets the {@link World} where this region is located.
+     *
+     * @return the world of the region
+     */
+    World getWorld();
+
+    /**
+     * Gets the permission node required for a player to sell items in this region.
+     *
+     * @return the required permission string
+     */
+    String getRequiredPermission();
+
+    /**
+     * Adds or updates the sell price for a specific material in this region.
+     *
+     * @param material the material to set the sell price for
+     * @param price    the price at which the material will be sold
+     */
+    void addSellPrice(XMaterial material, double price);
+
+    /**
+     * Removes a material from being sellable in this region.
+     *
+     * @param material the material to remove from the sell price list
+     */
+    void removeSellPrice(XMaterial material);
+
+    /**
+     * Gets the sell price for a specific material in this region.
+     *
+     * @param material the material to get the price for
+     * @return the sell price of the material, or 0 if not sellable
+     */
+    double getSellPriceForMaterial(XMaterial material);
+
+    /**
+     * Checks whether a given {@link Location} is inside this sell region.
+     *
+     * @param location the location to check
+     * @return true if the location is inside the region, false otherwise
+     */
+    boolean contains(Location location);
+
+    /**
+     * Checks if the given player has permission to sell in this region.
+     * This is based on {@link SellRegion#getRequiredPermission()}.
+     *
+     * @param player the player to check
+     * @return true if the player can sell in the region, false otherwise
+     */
+    boolean canPlayerSellInRegion(Player player);
+}