feat(tamer): capture and relocate mobs

src/main/java/games/dmg/spigottyrant/BukkitCapturedMobItemService.java

@@ -0,0 +1,79 @@
+package games.dmg.spigottyrant;
+
+import java.util.Optional;
+import java.util.UUID;
+import org.bukkit.ChatColor;
+import org.bukkit.Material;
+import org.bukkit.NamespacedKey;
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.meta.ItemMeta;
+import org.bukkit.persistence.PersistentDataType;
+import org.bukkit.plugin.Plugin;
+
+public final class BukkitCapturedMobItemService implements CapturedMobItemService {
+    private final NamespacedKey ownerKey;
+    private final NamespacedKey captureKey;
+    private final NamespacedKey typeKey;
+    private final PluginSettings settings;
+
+    public BukkitCapturedMobItemService(Plugin plugin, PluginSettings settings) {
+        ownerKey = new NamespacedKey(plugin, "captured-owner");
+        captureKey = new NamespacedKey(plugin, "captured-id");
+        typeKey = new NamespacedKey(plugin, "captured-type");
+        this.settings = settings;
+    }
+
+    @Override
+    public ItemStack create(UUID ownerId, UUID captureId, String entityType) {
+        Material material = Material.matchMaterial(settings.capturedMobItem().material());
+        if (material == null) {
+            throw new IllegalStateException("Captured mob item material is unavailable");
+        }
+        ItemStack item = new ItemStack(material);
+        ItemMeta meta = item.getItemMeta();
+        meta.setDisplayName(ChatColor.GOLD + settings.capturedMobItem().name()
+            + ": " + entityType);
+        meta.getPersistentDataContainer().set(
+            ownerKey, PersistentDataType.STRING, ownerId.toString()
+        );
+        meta.getPersistentDataContainer().set(
+            captureKey, PersistentDataType.STRING, captureId.toString()
+        );
+        meta.getPersistentDataContainer().set(
+            typeKey, PersistentDataType.STRING, entityType
+        );
+        item.setItemMeta(meta);
+        return item;
+    }
+
+    @Override
+    public boolean isCapturedMob(ItemStack item) {
+        return owner(item).isPresent() && captureId(item).isPresent();
+    }
+
+    @Override
+    public Optional<UUID> owner(ItemStack item) {
+        return uuid(item, ownerKey);
+    }
+
+    @Override
+    public Optional<UUID> captureId(ItemStack item) {
+        return uuid(item, captureKey);
+    }
+
+    private static Optional<UUID> uuid(ItemStack item, NamespacedKey key) {
+        if (item == null || !item.hasItemMeta()) {
+            return Optional.empty();
+        }
+        String value = item.getItemMeta().getPersistentDataContainer()
+            .get(key, PersistentDataType.STRING);
+        if (value == null) {
+            return Optional.empty();
+        }
+        try {
+            return Optional.of(UUID.fromString(value));
+        } catch (IllegalArgumentException exception) {
+            return Optional.empty();
+        }
+    }
+}

src/main/java/games/dmg/spigottyrant/CapturedMobItemService.java

@@ -0,0 +1,15 @@
+package games.dmg.spigottyrant;
+
+import java.util.Optional;
+import java.util.UUID;
+import org.bukkit.inventory.ItemStack;
+
+public interface CapturedMobItemService {
+    ItemStack create(UUID ownerId, UUID captureId, String entityType);
+
+    boolean isCapturedMob(ItemStack item);
+
+    Optional<UUID> owner(ItemStack item);
+
+    Optional<UUID> captureId(ItemStack item);
+}

src/main/java/games/dmg/spigottyrant/CapturedMobService.java

@@ -0,0 +1,53 @@
+package games.dmg.spigottyrant;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.UUID;
+
+public final class CapturedMobService {
+    public PlayerState capture(
+        PlayerState player,
+        UUID captureId,
+        String entityType,
+        String snapshot
+    ) {
+        if (player.tyrantClass() != TyrantClass.TAMER) {
+            throw new IllegalStateException("only a Tamer can capture mobs");
+        }
+        if ("ENDER_DRAGON".equalsIgnoreCase(entityType)) {
+            throw new IllegalArgumentException("Ender Dragons cannot be captured");
+        }
+        List<CapturedMob> mobs = new ArrayList<>(player.capturedMobs());
+        mobs.add(new CapturedMob(entityType, Map.of(
+            "capture-id", captureId.toString(),
+            "snapshot", snapshot
+        )));
+        return copy(player, mobs);
+    }
+
+    public Optional<CapturedMob> find(PlayerState player, UUID captureId) {
+        return player.capturedMobs().stream()
+            .filter(mob -> captureId.toString().equals(mob.data().get("capture-id")))
+            .findFirst();
+    }
+
+    public PlayerState release(PlayerState player, UUID captureId) {
+        if (find(player, captureId).isEmpty()) {
+            return player;
+        }
+        List<CapturedMob> mobs = player.capturedMobs().stream()
+            .filter(mob -> !captureId.toString().equals(mob.data().get("capture-id")))
+            .toList();
+        return copy(player, mobs);
+    }
+
+    private static PlayerState copy(PlayerState player, List<CapturedMob> mobs) {
+        return new PlayerState(
+            player.playerId(), player.latestName(), player.lastLogin(), player.optedOutUntil(),
+            player.tyrantClass(), player.followerOf(), player.cooldownEnds(),
+            player.readyAbilityItems(), mobs
+        );
+    }
+}

src/main/java/games/dmg/spigottyrant/PluginSettings.java

@@ -38,6 +38,7 @@ public record PluginSettings(
     AbilityItemSettings assassinItem,
     AbilityItemSettings fixerItem,
     AbilityItemSettings tamerItem,
+    AbilityItemSettings capturedMobItem,
     String recoveryCommand,
     String inventoryFullMessage,
     boolean freezeTimersWhilePaused
@@ -76,6 +77,7 @@ public record PluginSettings(
         assassinItem = Objects.requireNonNull(assassinItem, "assassinItem");
         fixerItem = Objects.requireNonNull(fixerItem, "fixerItem");
         tamerItem = Objects.requireNonNull(tamerItem, "tamerItem");
+        capturedMobItem = Objects.requireNonNull(capturedMobItem, "capturedMobItem");
         recoveryCommand = requireText(recoveryCommand, "recovery-command");
         inventoryFullMessage = requireText(inventoryFullMessage, "inventory-full-message");
     }
@@ -111,6 +113,7 @@ public record PluginSettings(
             item(values, "assassin-item", new AbilityItemSettings("STICK", "Assassin Cloak")),
             item(values, "fixer-item", new AbilityItemSettings("STICK", "Fixer's Wrench")),
             item(values, "tamer-item", new AbilityItemSettings("FISHING_ROD", "Tamer's Lead")),
+            item(values, "captured-mob-item", new AbilityItemSettings("PAPER", "Captured Mob")),
             string(values, "recovery-command", "/tyrant item"),
             string(
                 values,

src/main/java/games/dmg/spigottyrant/PluginSettingsValidator.java

@@ -11,6 +11,7 @@ public final class PluginSettingsValidator {
         validateItem(settings.assassinItem(), "assassin-item");
         validateItem(settings.fixerItem(), "fixer-item");
         validateItem(settings.tamerItem(), "tamer-item");
+        validateItem(settings.capturedMobItem(), "captured-mob-item");
         for (String entityType : settings.deniedMobTypes()) {
             try {
                 EntityType.valueOf(entityType);

src/main/java/games/dmg/spigottyrant/SpigotTyrantPlugin.java

@@ -53,6 +53,10 @@ public final class SpigotTyrantPlugin extends JavaPlugin {
         FollowerService followers = new FollowerService();
         AbilityReadinessService readiness = new AbilityReadinessService();
         AbilityItemService abilityItems = new BukkitAbilityItemService(this, settings);
+        CapturedMobItemService capturedMobItems = new BukkitCapturedMobItemService(
+            this, settings
+        );
+        CapturedMobService capturedMobs = new CapturedMobService();
         AssassinAbilityService assassinAbilities = new AssassinAbilityService(
             readiness, settings
         );
@@ -125,6 +129,13 @@ public final class SpigotTyrantPlugin extends JavaPlugin {
             new BoundItemListener(abilityItems),
             this
         );
+        getServer().getPluginManager().registerEvents(
+            new TamerListener(
+                stateManager, abilityItems, capturedMobItems, capturedMobs,
+                settings, getServer()
+            ),
+            this
+        );
         getServer().getPluginManager().registerEvents(
             new AssassinItemListener(
                 stateManager, abilityItems, assassinAbilities, settings, clock

src/main/java/games/dmg/spigottyrant/TamerListener.java

@@ -0,0 +1,237 @@
+package games.dmg.spigottyrant;
+
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Optional;
+import java.util.UUID;
+import org.bukkit.ChatColor;
+import org.bukkit.Location;
+import org.bukkit.Server;
+import org.bukkit.entity.Entity;
+import org.bukkit.entity.EntitySnapshot;
+import org.bukkit.entity.LivingEntity;
+import org.bukkit.entity.Player;
+import org.bukkit.entity.Tameable;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
+import org.bukkit.event.Listener;
+import org.bukkit.event.block.Action;
+import org.bukkit.event.block.BlockDispenseEvent;
+import org.bukkit.event.entity.EntityPickupItemEvent;
+import org.bukkit.event.entity.PlayerDeathEvent;
+import org.bukkit.event.inventory.InventoryClickEvent;
+import org.bukkit.event.player.PlayerDropItemEvent;
+import org.bukkit.event.player.PlayerInteractEntityEvent;
+import org.bukkit.event.player.PlayerInteractEvent;
+import org.bukkit.inventory.ItemStack;
+
+public final class TamerListener implements Listener {
+    private final TyrantStateManager stateManager;
+    private final AbilityItemService abilityItems;
+    private final CapturedMobItemService capturedItems;
+    private final CapturedMobService capturedMobs;
+    private final PluginSettings settings;
+    private final Server server;
+
+    public TamerListener(
+        TyrantStateManager stateManager,
+        AbilityItemService abilityItems,
+        CapturedMobItemService capturedItems,
+        CapturedMobService capturedMobs,
+        PluginSettings settings,
+        Server server
+    ) {
+        this.stateManager = stateManager;
+        this.abilityItems = abilityItems;
+        this.capturedItems = capturedItems;
+        this.capturedMobs = capturedMobs;
+        this.settings = settings;
+        this.server = server;
+    }
+
+    @EventHandler(priority = EventPriority.HIGH)
+    public void onCapture(PlayerInteractEntityEvent event) {
+        ItemStack held = event.getPlayer().getInventory().getItem(event.getHand());
+        if (abilityItems.ability(held).filter(Ability.TAMER_CAPTURE::equals).isEmpty()) {
+            return;
+        }
+        event.setCancelled(true);
+        Player player = event.getPlayer();
+        if (abilityItems.owner(held).filter(player.getUniqueId()::equals).isEmpty()) {
+            player.getInventory().setItem(event.getHand(), null);
+            return;
+        }
+        PlayerState state = stateManager.player(player.getUniqueId(), player.getName());
+        Entity target = event.getRightClicked();
+        if (!canCapture(state, target)) {
+            player.sendMessage(ChatColor.RED + "That mob cannot be captured.");
+            return;
+        }
+        EntitySnapshot snapshot = target.createSnapshot();
+        if (snapshot == null) {
+            player.sendMessage(ChatColor.RED + "That mob could not be captured safely.");
+            return;
+        }
+        UUID captureId = UUID.randomUUID();
+        ItemStack capturedItem = capturedItems.create(
+            player.getUniqueId(), captureId, target.getType().name()
+        );
+        Map<Integer, ItemStack> leftovers = player.getInventory().addItem(capturedItem);
+        if (!leftovers.isEmpty()) {
+            player.sendMessage(ChatColor.RED + settings.inventoryFullMessage());
+            return;
+        }
+        PlayerState updated = capturedMobs.capture(
+            state, captureId, target.getType().name(), snapshot.getAsString()
+        );
+        stateManager.updatePlayer(
+            player.getUniqueId(), player.getName(), current -> updated
+        );
+        stateManager.saveIfDirty();
+        target.remove();
+        player.sendMessage(ChatColor.GREEN + "Captured " + target.getType().name() + ".");
+    }
+
+    @EventHandler(priority = EventPriority.HIGH)
+    public void onPlace(PlayerInteractEvent event) {
+        Action action = event.getAction();
+        if (action != Action.RIGHT_CLICK_AIR && action != Action.RIGHT_CLICK_BLOCK) {
+            return;
+        }
+        if (!capturedItems.isCapturedMob(event.getItem())) {
+            return;
+        }
+        event.setCancelled(true);
+        UUID captureId = capturedItems.captureId(event.getItem()).orElseThrow();
+        if (capturedItems.owner(event.getItem())
+                .filter(event.getPlayer().getUniqueId()::equals).isEmpty()) {
+            event.getPlayer().getInventory().setItem(event.getHand(), null);
+            return;
+        }
+        Location location = event.getClickedBlock() == null
+            ? event.getPlayer().getLocation().add(
+                event.getPlayer().getLocation().getDirection().normalize().multiply(2.0)
+            )
+            : event.getClickedBlock().getRelative(event.getBlockFace())
+                .getLocation().add(0.5, 0.0, 0.5);
+        if (spawnAndRelease(event.getPlayer(), captureId, location)) {
+            event.getPlayer().getInventory().setItem(event.getHand(), null);
+        } else {
+            event.getPlayer().sendMessage(ChatColor.RED
+                + "The mob cannot be placed safely there.");
+        }
+    }
+
+    @EventHandler(priority = EventPriority.HIGH)
+    public void onDrop(PlayerDropItemEvent event) {
+        ItemStack item = event.getItemDrop().getItemStack();
+        if (!capturedItems.isCapturedMob(item)) {
+            return;
+        }
+        UUID captureId = capturedItems.captureId(item).orElseThrow();
+        if (capturedItems.owner(item).filter(event.getPlayer().getUniqueId()::equals).isEmpty()
+                || !spawnAndRelease(
+                    event.getPlayer(), captureId, event.getItemDrop().getLocation()
+                )) {
+            event.setCancelled(true);
+            return;
+        }
+        event.getItemDrop().remove();
+    }
+
+    @EventHandler(priority = EventPriority.HIGH)
+    public void onDeath(PlayerDeathEvent event) {
+        Iterator<ItemStack> drops = event.getDrops().iterator();
+        while (drops.hasNext()) {
+            ItemStack item = drops.next();
+            if (!capturedItems.isCapturedMob(item)) {
+                continue;
+            }
+            UUID captureId = capturedItems.captureId(item).orElseThrow();
+            if (spawnAndRelease(event.getEntity(), captureId, event.getEntity().getLocation())) {
+                drops.remove();
+            }
+        }
+    }
+
+    @EventHandler
+    public void onInventoryClick(InventoryClickEvent event) {
+        if (capturedItems.isCapturedMob(event.getCurrentItem())
+                || capturedItems.isCapturedMob(event.getCursor())) {
+            if (!(event.getWhoClicked() instanceof Player player)
+                    || event.getClickedInventory() == null
+                    || !event.getClickedInventory().equals(player.getInventory())) {
+                event.setCancelled(true);
+            }
+        }
+    }
+
+    @EventHandler
+    public void onDispense(BlockDispenseEvent event) {
+        if (capturedItems.isCapturedMob(event.getItem())) {
+            event.setCancelled(true);
+        }
+    }
+
+    @EventHandler
+    public void onPickup(EntityPickupItemEvent event) {
+        if (!(event.getEntity() instanceof Player player)
+                || !capturedItems.isCapturedMob(event.getItem().getItemStack())) {
+            return;
+        }
+        if (capturedItems.owner(event.getItem().getItemStack())
+                .filter(player.getUniqueId()::equals).isEmpty()) {
+            event.setCancelled(true);
+        }
+    }
+
+    private boolean canCapture(PlayerState player, Entity target) {
+        if (stateManager.game().lifecycle() != GameLifecycle.RUNNING
+                || player.tyrantClass() != TyrantClass.TAMER
+                || !(target instanceof LivingEntity)
+                || target instanceof Player
+                || target.getType().name().equals("ENDER_DRAGON")
+                || settings.deniedMobTypes().contains(target.getType().name())
+                || target.getCustomName() != null) {
+            return false;
+        }
+        return !(target instanceof Tameable tameable) || !tameable.isTamed();
+    }
+
+    private boolean spawnAndRelease(Player player, UUID captureId, Location location) {
+        PlayerState state = stateManager.player(player.getUniqueId(), player.getName());
+        Optional<CapturedMob> stored = capturedMobs.find(state, captureId);
+        if (stored.isEmpty() || !safe(location)) {
+            return false;
+        }
+        CapturedMob mob = stored.orElseThrow();
+        if ("ENDER_DRAGON".equals(mob.entityType())
+                || settings.deniedMobTypes().contains(mob.entityType())) {
+            return false;
+        }
+        try {
+            EntitySnapshot snapshot = server.getEntityFactory().createEntitySnapshot(
+                mob.data().get("snapshot")
+            );
+            if (!snapshot.getEntityType().name().equals(mob.entityType())) {
+                return false;
+            }
+            snapshot.createEntity(location);
+        } catch (IllegalArgumentException | IllegalStateException exception) {
+            return false;
+        }
+        PlayerState released = capturedMobs.release(state, captureId);
+        stateManager.updatePlayer(
+            player.getUniqueId(), player.getName(), current -> released
+        );
+        stateManager.saveIfDirty();
+        return true;
+    }
+
+    private static boolean safe(Location location) {
+        return location.getWorld() != null
+            && location.getBlock().isPassable()
+            && location.clone().add(0.0, 1.0, 0.0).getBlock().isPassable()
+            && location.getWorld().getWorldBorder().isInside(location);
+    }
+}

src/main/resources/config.yml

@@ -35,6 +35,9 @@ fixer-item:
 tamer-item:
   material: FISHING_ROD
   name: Tamer's Lead
+captured-mob-item:
+  material: PAPER
+  name: Captured Mob
 denied-mob-types:
   - ENDER_DRAGON
   - WITHER