NobleSteeds Developer API

package com.rismr1.noblesteeds.api;

import java.util.UUID;

public final class ApiViews {
    private ApiViews() { }
    public record Listing(UUID listingId, UUID mountId, UUID seller, String name, double money, String itemPrice, String description) { }
    public record ShopEntry(UUID entryId, MountTemplate mount, double money, String itemPrice, boolean enabled) { }
    public record Payout(UUID transactionId, UUID seller, String state, double money, String itemPrice, long createdAt, String mailId, String queueId) { }
    public record Stable(String name, String world, double x, double y, double z) { }
    public record Parent(UUID mountId, String name, Double breedingQuality) { }
    public record Lineage(Parent mother, Parent father) { }
}

package com.rismr1.noblesteeds.api;

public enum MountDestination { ACTIVE, STORED }

package com.rismr1.noblesteeds.api;

import java.util.List;
import java.util.UUID;

public record MountSnapshot(UUID mountId, UUID entityId, UUID ownerId, int slot, String name,
                            String type, String variant, String status, String rarity,
                            double speed, double jump, double health, Double breedingQuality,
                            String world, double x, double y, double z, List<String> history) {
    public MountSnapshot { history = List.copyOf(history); }
}

package com.rismr1.noblesteeds.api;

import java.util.Objects;

public record MountTemplate(String type, String variant, String name, double speed,
                            double jump, double health, Double breedingQuality) {
    public MountTemplate {
        Objects.requireNonNull(type); Objects.requireNonNull(name);
        type = type.toUpperCase(java.util.Locale.ROOT);
        variant = variant == null ? "BROWN" : variant.toUpperCase(java.util.Locale.ROOT);
    }
}

package com.rismr1.noblesteeds.api;

import org.bukkit.entity.Player;
import org.bukkit.plugin.Plugin;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;

public interface NobleSteedsApi {
    String API_VERSION = "1.0";
    enum Menu { ACTIVE, STORAGE, MARKET, SHOP, REWARDS }
    String version();
    Set<String> capabilities();
    Optional<MountSnapshot> mount(UUID mountId);
    List<MountSnapshot> mounts(UUID owner);
    List<PendingMountReward> pendingRewards(UUID owner);
    List<ApiViews.Listing> listings();
    List<ApiViews.ShopEntry> shopEntries();
    List<ApiViews.Payout> payouts(UUID owner);
    List<ApiViews.Stable> stables(UUID owner);
    Optional<ApiViews.Lineage> lineage(UUID mountId);
    CompletableFuture<OperationResult> grantMount(Plugin source, RewardRequest request);
    CompletableFuture<OperationResult> claimReward(Player player, UUID rewardId, MountDestination destination);
    CompletableFuture<OperationResult> rename(Player player, UUID mountId, String name);
    CompletableFuture<OperationResult> call(Player player, UUID mountId);
    CompletableFuture<OperationResult> sendToStable(Player player, UUID mountId);
    CompletableFuture<OperationResult> store(Player player, UUID mountId);
    CompletableFuture<OperationResult> restore(Player player, UUID mountId);
    CompletableFuture<OperationResult> openMenu(Player player, Menu menu);
    String placeholder(UUID player, String parameter);
}

package com.rismr1.noblesteeds.api;

import org.bukkit.Bukkit;
import java.util.Optional;

public final class NobleSteedsApiProvider {
    private NobleSteedsApiProvider() { }
    public static Optional<NobleSteedsApi> get() {
        return Optional.ofNullable(Bukkit.getServicesManager().load(NobleSteedsApi.class));
    }
}

package com.rismr1.noblesteeds.api;

import java.util.UUID;

public record OperationResult(UUID operationId, Status status, UUID mountId, UUID rewardId) {
    public enum Status {
        SUCCESS, ALREADY_GRANTED, PENDING_CAPACITY, LIMIT_REACHED, QUEUE_FULL,
        INVALID_STATS, INVALID_REQUEST, REQUEST_CONFLICT, NOT_FOUND, NOT_OWNER,
        NO_PERMISSION, BUSY, DISABLED, CANCELLED, FAILED, REVIEW_REQUIRED
    }
    public boolean delivered() { return status == Status.SUCCESS || status == Status.ALREADY_GRANTED; }
}

package com.rismr1.noblesteeds.api;

import java.util.UUID;

public record PendingMountReward(UUID rewardId, UUID recipient, String source, MountTemplate mount,
                                 MountDestination requestedDestination, String state, long createdAt) { }

package com.rismr1.noblesteeds.api;

import java.util.Objects;
import java.util.UUID;

public record RewardRequest(String rewardKey, UUID recipient, MountTemplate mount,
                            MountDestination destination, String sourceLabel) {
    public RewardRequest {
        Objects.requireNonNull(rewardKey); Objects.requireNonNull(recipient);
        Objects.requireNonNull(mount); Objects.requireNonNull(destination);
        sourceLabel = sourceLabel == null ? "" : sourceLabel;
    }
}

package com.rismr1.noblesteeds.api.event;

import org.bukkit.event.Cancellable;
import org.bukkit.event.Event;
import org.bukkit.event.HandlerList;
import java.util.UUID;

public final class MountActionEvent extends Event implements Cancellable {
    public enum Action { GRANT, CLAIM, RENAME, RELOCATE, STORE, RESTORE }
    private static final HandlerList HANDLERS = new HandlerList();
    private final UUID mountId;
    private final UUID actor;
    private final Action action;
    private boolean cancelled;
    public MountActionEvent(UUID mountId, UUID actor, Action action) {
        this.mountId = mountId; this.actor = actor; this.action = action;
    }
    public UUID getMountId() { return mountId; }
    public UUID getActor() { return actor; }
    public Action getAction() { return action; }
    public boolean isCancelled() { return cancelled; }
    public void setCancelled(boolean cancelled) { this.cancelled = cancelled; }
    public HandlerList getHandlers() { return HANDLERS; }
    public static HandlerList getHandlerList() { return HANDLERS; }
}

package com.rismr1.noblesteeds.api.event;

import com.rismr1.noblesteeds.api.MountSnapshot;
import org.bukkit.event.Event;
import org.bukkit.event.HandlerList;

public final class MountChangedEvent extends Event {
    private static final HandlerList HANDLERS = new HandlerList();
    private final MountSnapshot mount;
    private final String action;
    public MountChangedEvent(MountSnapshot mount, String action) { this.mount = mount; this.action = action; }
    public MountSnapshot getMount() { return mount; }
    public String getAction() { return action; }
    public HandlerList getHandlers() { return HANDLERS; }
    public static HandlerList getHandlerList() { return HANDLERS; }
}

package com.rismr1.noblesteeds.api.event;

import com.rismr1.noblesteeds.api.OperationResult;
import org.bukkit.event.Event;
import org.bukkit.event.HandlerList;

public final class MountOperationCompletedEvent extends Event {
    public enum Action { GRANT, CLAIM, RENAME, CALL, STABLE, STORE, RESTORE, OPEN_MENU }
    private static final HandlerList HANDLERS = new HandlerList();
    private final Action action;
    private final OperationResult result;
    public MountOperationCompletedEvent(Action action, OperationResult result) { this.action = action; this.result = result; }
    public Action getAction() { return action; }
    public OperationResult getResult() { return result; }
    public HandlerList getHandlers() { return HANDLERS; }
    public static HandlerList getHandlerList() { return HANDLERS; }
}