bounty api

The BountyAPI provides methods to manage bounties programmatically.

Getting the API

ZelBountyAPI api = Bukkit.getServicesManager().load(ZelBountyAPI.class);
BountyAPI bountyAPI = api.getBountyAPI();

Methods

addBounty

Add bounty to a player.

CompletableFuture<Double> addBounty(UUID target, UUID adder, double amount)
    throws BountyException;

Parameters:

• target - UUID of the player receiving the bounty

• adder - UUID of the player adding the bounty (can be null for system)

• amount - Amount to add

Returns: CompletableFuture<Double> - New total bounty amount

Example:

UUID target = player.getUniqueId();
UUID adder = sender.getUniqueId();

bountyAPI.addBounty(target, adder, 1000.0)
    .thenAccept(newTotal -> {
        sender.sendMessage("Bounty added! Total: $" + newTotal);
    });

---

removeBounty

Remove bounty from a player.

CompletableFuture<Double> removeBounty(UUID target, UUID remover, double amount)
    throws BountyException;

Parameters:

• target - UUID of the player losing bounty

• remover - UUID of the player removing bounty (can be null)

• amount - Amount to remove

Returns: CompletableFuture<Double> - New total bounty amount

Example:

bountyAPI.removeBounty(targetUUID, adminUUID, 500.0)
    .thenAccept(remaining -> {
        sender.sendMessage("Removed $500. Remaining: $" + remaining);
    });

---

resetBounty

Reset a player's bounty to 0.

CompletableFuture<Void> resetBounty(UUID target, UUID resetter)
    throws BountyException;

Parameters:

• target - UUID of the player to reset

• resetter - UUID of the player performing reset (can be null)

Example:

bountyAPI.resetBounty(targetUUID, adminUUID)
    .thenRun(() -> {
        sender.sendMessage("Bounty reset!");
    });

---

claimBounty

Claim a bounty (typically called when a player is killed).

CompletableFuture<Double> claimBounty(UUID target, UUID claimer)
    throws BountyException;

Parameters:

• target - UUID of the player whose bounty is being claimed

• claimer - UUID of the player claiming the bounty

Returns: CompletableFuture<Double> - Amount claimed

Example:

bountyAPI.claimBounty(victimUUID, killerUUID)
    .thenAccept(amount -> {
        killer.sendMessage("You claimed $" + amount + "!");
    });

---

getBounty

Get the current bounty amount for a player.

double getBounty(UUID target);

Parameters:

• target - UUID of the player

Returns: Current bounty amount (0.0 if none)

Example:

double bounty = bountyAPI.getBounty(playerUUID);
player.sendMessage("Your bounty: $" + bounty);

---

getBountyData

Get full bounty data for a player.

@Nullable IBountyData getBountyData(UUID target);

Parameters:

• target - UUID of the player

Returns: IBountyData object or null if not found

IBountyData Interface:

public interface IBountyData {
    UUID getPlayerUUID();
    double getBountyAmount();
    String getFormattedBounty();      // e.g., "$1,000.00"
    int getTotalBountiesSet();
    int getTotalBountiesClaimed();
    long getLastUpdated();
}

Example:

IBountyData data = bountyAPI.getBountyData(playerUUID);
if (data != null) {
    player.sendMessage("Bounty: " + data.getFormattedBounty());
    player.sendMessage("Bounties set: " + data.getTotalBountiesSet());
    player.sendMessage("Bounties claimed: " + data.getTotalBountiesClaimed());
}

---

getTopBounties

Get a list of players with the highest bounties.

List<IBountyData> getTopBounties(int limit);

Parameters:

• limit - Maximum number of results

Returns: List of IBountyData sorted by bounty amount (descending)

Example:

List<IBountyData> topBounties = bountyAPI.getTopBounties(10);
for (int i = 0; i < topBounties.size(); i++) {
    IBountyData data = topBounties.get(i);
    player.sendMessage((i + 1) + ". " + data.getPlayerUUID() + " - " + data.getFormattedBounty());
}

---

getHistory

Get bounty history for a player.

List<IHistoryEntry> getHistory(UUID target, int limit);

Parameters:

• target - UUID of the player

• limit - Maximum number of results

Returns: List of IHistoryEntry objects

IHistoryEntry Interface:

public interface IHistoryEntry {
    long getId();
    BountyAction getAction();         // ADD, REMOVE, RESET, CLAIM
    @Nullable UUID getPerformerUUID();
    @Nullable String getPerformerName();
    UUID getTargetUUID();
    String getTargetName();
    double getAmount();
    String getFormattedAmount();
    long getTimestamp();
    String getFormattedDate();
}

BountyAction Enum:

public enum BountyAction {
    ADD,
    REMOVE,
    RESET,
    CLAIM
}

Example:

List<IHistoryEntry> history = bountyAPI.getHistory(playerUUID, 5);
for (IHistoryEntry entry : history) {
    String msg = String.format("[%s] %s: $%s by %s",
        entry.getFormattedDate(),
        entry.getAction(),
        entry.getFormattedAmount(),
        entry.getPerformerName()
    );
    player.sendMessage(msg);
}

---

hasBounty

Check if a player has an active bounty.

boolean hasBounty(UUID target);

Parameters:

• target - UUID of the player

Returns: true if player has bounty > 0

Example:

if (bountyAPI.hasBounty(playerUUID)) {
    player.sendMessage("Watch out! You have a bounty on your head!");
}

Complete Example

public class BountyInfoCommand implements CommandExecutor {

    private final BountyAPI bountyAPI;

    public BountyInfoCommand(BountyAPI bountyAPI) {
        this.bountyAPI = bountyAPI;
    }

    @Override
    public boolean onCommand(CommandSender sender, Command cmd, String label, String[] args) {
        if (!(sender instanceof Player)) return false;
        Player player = (Player) sender;

        UUID targetUUID;
        if (args.length > 0) {
            Player target = Bukkit.getPlayer(args[0]);
            if (target == null) {
                player.sendMessage("Player not found!");
                return true;
            }
            targetUUID = target.getUniqueId();
        } else {
            targetUUID = player.getUniqueId();
        }

        IBountyData data = bountyAPI.getBountyData(targetUUID);
        if (data == null || !bountyAPI.hasBounty(targetUUID)) {
            player.sendMessage("No active bounty.");
            return true;
        }

        player.sendMessage("=== Bounty Info ===");
        player.sendMessage("Amount: " + data.getFormattedBounty());
        player.sendMessage("Bounties Set: " + data.getTotalBountiesSet());
        player.sendMessage("Bounties Claimed: " + data.getTotalBountiesClaimed());

        return true;
    }
}