diff --git a/src/main/java/net/tfminecraft/geigercounters/config/GeigerConfiguration.java b/src/main/java/net/tfminecraft/geigercounters/config/GeigerConfiguration.java index 163aac3..eab0cba 100644 --- a/src/main/java/net/tfminecraft/geigercounters/config/GeigerConfiguration.java +++ b/src/main/java/net/tfminecraft/geigercounters/config/GeigerConfiguration.java @@ -405,9 +405,9 @@ private void loadRewards() { // Load items for this tier List tierItems = tiersSection.getStringList(tierName); for (String itemString : tierItems) { - ItemReward item = parseItemReward(itemString); - if (item != null) { - tier.addItem(item); + List entry = parseRewardEntry(itemString); + if (entry != null) { + tier.addEntry(entry); } } @@ -421,6 +421,34 @@ private void loadRewards() { plugin.getLogger().info("Loaded " + tierRewards.size() + " reward tiers from drop list '" + activeDropList + "'"); } + // ==================================== + // One list entry: "item:amount", or several joined with " + " that are + // given together. A broken part skips the whole entry, so it never pays + // only half of what it lists. + // ==================================== + private List parseRewardEntry(String entryString) { + // -1 keeps empty parts, so a dangling or lone "+" is a broken entry + String[] parts = entryString.split("\\+", -1); + if (parts.length > TierReward.MAX_ENTRY_ITEMS) { + plugin.getLogger().warning("Skipping reward entry with more than " + TierReward.MAX_ENTRY_ITEMS + + " items: " + entryString); + return null; + } + List entry = new ArrayList<>(); + for (String part : parts) { + // A single item is read as written, as before joined entries existed + ItemReward item = parseItemReward(parts.length > 1 ? part.trim() : part); + if (item == null) { + if (parts.length > 1) { + plugin.getLogger().warning("Skipping reward entry with a broken item: " + entryString); + } + return null; + } + entry.add(item); + } + return entry; + } + private ItemReward parseItemReward(String itemString) { // Split on the last colon to separate item path from amount int lastColonIndex = itemString.lastIndexOf(':'); diff --git a/src/main/java/net/tfminecraft/geigercounters/handlers/CacheMenu.java b/src/main/java/net/tfminecraft/geigercounters/handlers/CacheMenu.java index cd44d46..fa37a00 100644 --- a/src/main/java/net/tfminecraft/geigercounters/handlers/CacheMenu.java +++ b/src/main/java/net/tfminecraft/geigercounters/handlers/CacheMenu.java @@ -44,15 +44,17 @@ public CacheMenu(GeigerConfiguration config) { } // ==================================== - // Show the cache holding , which may be null for an empty cache + // Show the cache holding (empty for an empty cache), centred in + // the middle row. Reward entries hold at most one row of items. // ==================================== - public void open(Player player, ItemStack reward) { + public void open(Player player, List rewards) { Holder holder = new Holder(); Inventory inventory = Bukkit.createInventory(holder, SIZE, LEGACY.deserialize(config.getMessages().get("player.cache-title"))); holder.inventory = inventory; - if (reward != null) { - inventory.setItem(REWARD_SLOT, reward); + int first = REWARD_SLOT - rewards.size() / 2; + for (int index = 0; index < rewards.size(); index++) { + inventory.setItem(first + index, rewards.get(index)); } // Another plugin may refuse the window; the reward is theirs regardless if (player.openInventory(inventory) == null) { diff --git a/src/main/java/net/tfminecraft/geigercounters/handlers/SourceHandler.java b/src/main/java/net/tfminecraft/geigercounters/handlers/SourceHandler.java index 83fd8a1..541d90d 100644 --- a/src/main/java/net/tfminecraft/geigercounters/handlers/SourceHandler.java +++ b/src/main/java/net/tfminecraft/geigercounters/handlers/SourceHandler.java @@ -27,6 +27,7 @@ import java.io.File; import java.io.IOException; +import java.util.ArrayList; import java.util.EnumSet; import java.util.HashMap; import java.util.List; @@ -464,24 +465,31 @@ private void replaceGeigerWithDeadVersion(Player player, EquipmentSlot geigerSlo } // ==================================== - // A random reward based on tier weights, or null when there is none + // The items of a random entry based on tier weights; empty when there is + // none. An item whose path does not resolve is left out. // ==================================== - private ItemStack rollReward(Player player) { + private List rollReward(Player player) { + List rewards = new ArrayList<>(); List tiers = config.getTierRewards(); if (tiers.isEmpty()) { - return null; + return rewards; } // Select a tier based on weights TierReward selectedTier = selectRandomTier(tiers); if (selectedTier.isEmpty()) { - return null; + return rewards; } - // Select a random item from the tier - List tierItems = selectedTier.getItems(); - ItemReward randomItem = tierItems.get(random.nextInt(tierItems.size())); - return rewardItem(player, randomItem, selectedTier.getTierName()); + // Select a random entry from the tier + List> entries = selectedTier.getEntries(); + for (ItemReward reward : entries.get(random.nextInt(entries.size()))) { + ItemStack item = rewardItem(player, reward, selectedTier.getTierName()); + if (item != null) { + rewards.add(item); + } + } + return rewards; } // ==================================== diff --git a/src/main/java/net/tfminecraft/geigercounters/models/TierReward.java b/src/main/java/net/tfminecraft/geigercounters/models/TierReward.java index d436375..906c9f3 100644 --- a/src/main/java/net/tfminecraft/geigercounters/models/TierReward.java +++ b/src/main/java/net/tfminecraft/geigercounters/models/TierReward.java @@ -4,36 +4,44 @@ import java.util.List; // ==================================== -// Represents a reward tier with its weight and list of possible items +// Represents a reward tier with its weight and list of possible entries. +// One entry is drawn per cache; an entry gives one or more items together. // ==================================== public class TierReward { + // An entry's items fill one row of the cache window + public static final int MAX_ENTRY_ITEMS = 9; + private final String tierName; private final double weight; - private final List items; - + private final List> entries; + public TierReward(String tierName, double weight) { this.tierName = tierName; this.weight = weight; - this.items = new ArrayList<>(); + this.entries = new ArrayList<>(); } - + public void addItem(ItemReward item) { - items.add(item); + addEntry(List.of(item)); + } + + public void addEntry(List entry) { + entries.add(List.copyOf(entry)); } - + public String getTierName() { return tierName; } - + public double getWeight() { return weight; } - - public List getItems() { - return items; + + public List> getEntries() { + return entries; } - + public boolean isEmpty() { - return items.isEmpty(); + return entries.isEmpty(); } } diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml index a611e8f..f9ca9c4 100644 --- a/src/main/resources/config.yml +++ b/src/main/resources/config.yml @@ -223,6 +223,9 @@ drops: # Items in each rarity tier # Format: "item_path:amount" # Example: m.MATERIALS.ARCANE_DUST:5 + # Join up to 9 items with " + " to give them together as one entry: + # "m.MATERIALS.IGNITIUM:32 + v.iron_ingot:32" + # If any item in a joined entry is malformed, the whole entry is skipped. lists: default: tiers: diff --git a/src/test/java/net/tfminecraft/geigercounters/config/GeigerConfigurationTest.java b/src/test/java/net/tfminecraft/geigercounters/config/GeigerConfigurationTest.java index d935a91..67e1976 100644 --- a/src/test/java/net/tfminecraft/geigercounters/config/GeigerConfigurationTest.java +++ b/src/test/java/net/tfminecraft/geigercounters/config/GeigerConfigurationTest.java @@ -251,16 +251,44 @@ void rewardsChooseNamedListIgnoreDisabledEmptyAndMalformedTiers() { var tier = configuration.getTierRewards().getFirst(); assertEquals("common", tier.getTierName()); assertEquals(10, tier.getWeight()); - assertEquals(2, tier.getItems().size()); - assertEquals("m.APPLE", tier.getItems().getFirst().getOutputItem()); - assertEquals(2, tier.getItems().getFirst().getOutputAmount()); - assertEquals("namespace:item", tier.getItems().getLast().getOutputItem()); - assertEquals(3, tier.getItems().getLast().getOutputAmount()); + assertEquals(2, tier.getEntries().size()); + assertEquals("m.APPLE", tier.getEntries().getFirst().getFirst().getOutputItem()); + assertEquals(2, tier.getEntries().getFirst().getFirst().getOutputAmount()); + assertEquals("namespace:item", tier.getEntries().getLast().getFirst().getOutputItem()); + assertEquals(3, tier.getEntries().getLast().getFirst().getOutputAmount()); load(); assertEquals( 1, configuration.getTierRewards().size(), "Reload must replace rather than append rewards"); } + @Test + void entriesJoinedWithPlusGiveTheirItemsTogetherAndBrokenOrOversizedOnesAreSkipped() { + yaml.set("drops.tier-weights.common", 1); + yaml.set( + "drops.lists.act.tiers.common", + List.of( + "m.MATERIALS.IGNITIUM:32 + v.iron_ingot:32", + "m.A:1 + broken", + "m.A:1 + m.B:x", + "m.A:1 +", + "+", + "m.C:1 ", + String.join(" + ", java.util.Collections.nCopies(10, "m.A:1")), + String.join("+", java.util.Collections.nCopies(9, "m.B:2")))); + yaml.set("drops.active-list", "act"); + load(); + var entries = configuration.getTierRewards().getFirst().getEntries(); + assertEquals(2, entries.size()); + var bundle = entries.getFirst(); + assertEquals(2, bundle.size()); + assertEquals("m.MATERIALS.IGNITIUM", bundle.getFirst().getOutputItem()); + assertEquals(32, bundle.getFirst().getOutputAmount()); + assertEquals("v.iron_ingot", bundle.getLast().getOutputItem()); + assertEquals(32, bundle.getLast().getOutputAmount()); + assertEquals(9, entries.getLast().size()); + assertEquals("m.B", entries.getLast().getFirst().getOutputItem()); + } + @Test void missingListFallsBackToFirstAvailableAndMissingSectionsProduceNoRewards() { yaml.createSection("drops.tier-weights"); diff --git a/src/test/java/net/tfminecraft/geigercounters/handlers/CacheMenuTest.java b/src/test/java/net/tfminecraft/geigercounters/handlers/CacheMenuTest.java index 32d8d15..b8e3dda 100644 --- a/src/test/java/net/tfminecraft/geigercounters/handlers/CacheMenuTest.java +++ b/src/test/java/net/tfminecraft/geigercounters/handlers/CacheMenuTest.java @@ -49,14 +49,14 @@ void setUp() { when(player.openInventory(any(Inventory.class))).thenReturn(mock(InventoryView.class)); } - InventoryHolder open(ItemStack reward) { + InventoryHolder open(ItemStack... rewards) { ArgumentCaptor holder = ArgumentCaptor.forClass(InventoryHolder.class); ArgumentCaptor title = ArgumentCaptor.forClass(Component.class); try (var bukkit = mockStatic(Bukkit.class)) { bukkit .when(() -> Bukkit.createInventory(any(InventoryHolder.class), eq(27), any(Component.class))) .thenReturn(window); - menu.open(player, reward); + menu.open(player, List.of(rewards)); bukkit.verify(() -> Bukkit.createInventory(holder.capture(), eq(27), title.capture())); } assertEquals("Arcane Cache", PlainTextComponentSerializer.plainText().serialize(title.getValue())); @@ -78,15 +78,40 @@ void theRewardSitsInTheMiddleOfTheCache() { verify(window).setItem(13, reward); } + @Test + void severalRewardsAreCentredInTheMiddleRow() { + ItemStack first = item(false), second = item(false), third = item(false); + open(first, second); + verify(window).setItem(12, first); + verify(window).setItem(13, second); + clearInvocations(window, player); + open(first, second, third); + verify(window).setItem(12, first); + verify(window).setItem(13, second); + verify(window).setItem(14, third); + } + + @Test + void aFullRowOfRewardsFillsTheWholeMiddleRow() { + ItemStack[] row = new ItemStack[9]; + for (int index = 0; index < row.length; index++) { + row[index] = item(false); + } + open(row); + for (int index = 0; index < row.length; index++) { + verify(window).setItem(9 + index, row[index]); + } + } + @Test void anEmptyCacheStillOpens() { - open(null); + open(); verify(window, never()).setItem(anyInt(), any()); } @Test void whateverIsLeftWhenTheCacheClosesGoesToThePlayer() { - InventoryHolder holder = open(null); + InventoryHolder holder = open(); ItemStack left = item(false), air = item(true); when(window.getHolder()).thenReturn(holder); when(window.getContents()).thenReturn(new ItemStack[] {null, air, left}); @@ -101,7 +126,7 @@ void whateverIsLeftWhenTheCacheClosesGoesToThePlayer() { @Test void otherWindowsAndNonPlayersAreLeftAlone() { - InventoryHolder holder = open(null); + InventoryHolder holder = open(); InventoryCloseEvent event = mock(InventoryCloseEvent.class); when(event.getInventory()).thenReturn(window); when(window.getHolder()).thenReturn(mock(InventoryHolder.class)); @@ -115,7 +140,7 @@ void otherWindowsAndNonPlayersAreLeftAlone() { @Test void openCachesAreHandedBackWhenThePluginStops() { - InventoryHolder holder = open(null); + InventoryHolder holder = open(); ItemStack left = item(false); when(window.getHolder()).thenReturn(holder); when(window.getContents()).thenReturn(new ItemStack[] {left}); @@ -159,7 +184,7 @@ PlayerDeathEvent death(Inventory top, boolean keep, List drops) { @Test void dyingWithTheCacheOpenFillsEmptySlotsForGravesAndAddsToTheDrops() { - InventoryHolder holder = open(null); + InventoryHolder holder = open(); ItemStack held = item(false), gap = item(true); ItemStack first = item(false), second = item(false); ItemStack firstCopy = mock(ItemStack.class), secondCopy = mock(ItemStack.class); @@ -186,7 +211,7 @@ void lootWithNoFreeSlotFallsWhereThePlayerDied() { Location at = new Location(world, 1, 2, 3); when(player.getWorld()).thenReturn(world); when(player.getLocation()).thenReturn(at); - InventoryHolder holder = open(null); + InventoryHolder holder = open(); ItemStack fits = item(false), spare = item(false), copy = mock(ItemStack.class); when(fits.clone()).thenReturn(copy); ItemStack held = item(false); @@ -202,7 +227,7 @@ void lootWithNoFreeSlotFallsWhereThePlayerDied() { @Test void keptInventoriesKeepTheCacheContentsWithoutDropping() { - InventoryHolder holder = open(null); + InventoryHolder holder = open(); ItemStack left = item(false); when(pockets.getStorageContents()).thenReturn(new ItemStack[] {null}); when(window.getHolder()).thenReturn(holder); diff --git a/src/test/java/net/tfminecraft/geigercounters/handlers/SourceHandlerTest.java b/src/test/java/net/tfminecraft/geigercounters/handlers/SourceHandlerTest.java index c6e50c0..04242c1 100644 --- a/src/test/java/net/tfminecraft/geigercounters/handlers/SourceHandlerTest.java +++ b/src/test/java/net/tfminecraft/geigercounters/handlers/SourceHandlerTest.java @@ -488,7 +488,7 @@ void collectionConsumesCounterRecordsLimitAndPublishesOriginalLocation() { verify(player).playSound(any(Location.class), eq(Sound.ENTITY_ITEM_BREAK), eq(1f), eq(1f)); verify(player).playSound(old, Sound.BLOCK_CHEST_OPEN, 1f, 1f); verify(player).spawnParticle(Particle.WITCH, old, 30, 0.4, 0.4, 0.4, 0.0); - verify(menu).open(player, null); + verify(menu).open(player, List.of()); assertNull(handler.getSource(hunter)); assertFalse(handler.isPlacing(hunter)); } @@ -537,7 +537,7 @@ void offhandCollectionPutsClonedRewardWithConfiguredAmountInTheCache() { collect(EquipmentSlot.OFF_HAND); verify(inventory).setItemInOffHand(null); verify(copy).setAmount(4); - verify(menu).open(player, copy); + verify(menu).open(player, List.of(copy)); verify(inventory, never()).addItem(copy); verify(original, never()).setAmount(anyInt()); } @@ -552,7 +552,30 @@ void missingDeadCounterAndInvalidRewardAreLoggedWithoutAbortingCollection() { collect(EquipmentSlot.HAND); verify(limits).recordCollection(player); verify(inventory, never()).addItem(any(ItemStack.class)); - verify(menu).open(player, null); + verify(menu).open(player, List.of()); + } + + @Test + void aBundledEntryPutsEachItemInTheCacheAndLeavesOutOneThatDoesNotResolve() { + TierReward tier = new TierReward("rare", 1); + tier.addEntry( + List.of( + new ItemReward("m.ignitium", 32), + new ItemReward("v.missing", 1), + new ItemReward("v.iron_ingot", 32))); + when(config.getTierRewards()).thenReturn(List.of(tier)); + ItemStack ignitium = mock(ItemStack.class), ignitiumCopy = mock(ItemStack.class); + ItemStack iron = mock(ItemStack.class), ironCopy = mock(ItemStack.class); + when(api.getCreator().getItemFromPath("m.ignitium")).thenReturn(ignitium); + when(api.getCreator().getItemFromPath("v.iron_ingot")).thenReturn(iron); + when(api.getCreator().getItemFromPath("v.missing")).thenReturn(null); + when(ignitium.clone()).thenReturn(ignitiumCopy); + when(iron.clone()).thenReturn(ironCopy); + place(); + collect(EquipmentSlot.HAND); + verify(ignitiumCopy).setAmount(32); + verify(ironCopy).setAmount(32); + verify(menu).open(player, List.of(ignitiumCopy, ironCopy)); } @Test @@ -561,7 +584,7 @@ void emptyRewardTierDoesNotAttemptRewardCreation() { place(); collect(EquipmentSlot.HAND); verify(inventory, times(1)).addItem(any(ItemStack.class)); - verify(menu).open(player, null); + verify(menu).open(player, List.of()); } @Test @@ -665,7 +688,7 @@ void fullInventoryDropsDeadCounterWhileTheRewardWaitsInTheCache() { verify(inventory).setItemInOffHand(null); verify(world).dropItemNaturally(player.getLocation(), dead); verify(world, times(1)).dropItemNaturally(any(Location.class), any(ItemStack.class)); - verify(menu).open(player, reward); + verify(menu).open(player, List.of(reward)); } @Test diff --git a/src/test/java/net/tfminecraft/geigercounters/validators/SpawnLocationFilterTest.java b/src/test/java/net/tfminecraft/geigercounters/validators/SpawnLocationFilterTest.java index a963a4e..de39396 100644 --- a/src/test/java/net/tfminecraft/geigercounters/validators/SpawnLocationFilterTest.java +++ b/src/test/java/net/tfminecraft/geigercounters/validators/SpawnLocationFilterTest.java @@ -227,7 +227,7 @@ void tierStateAndUsageCounterRemainConsistentAcrossCollectionsAndDrains() { ItemReward item = new ItemReward("m.TEST", 2); tier.addItem(item); assertFalse(tier.isEmpty()); - assertEquals(List.of(item), tier.getItems()); + assertEquals(List.of(List.of(item)), tier.getEntries()); assertEquals("rare", tier.getTierName()); assertEquals(4, tier.getWeight()); assertEquals("m.TEST", item.getOutputItem());