fix(loottracker): Track automated bird nest searching (runelite#19975)

- Added support for tracking the loot received from the next searched bird nest that's automated by the game itself
	- Modified LootTrackerPlugin#onItemContainerChanged to see if a bird nest was searched by the game and whether or not to keep processing inventory changes while there are searchable bird nests remaining
- Added new test case LootTrackerPluginTest#testBirdNests

Author: Infinitay

runelite-client/src/main/java/net/runelite/client/plugins/loottracker/LootTrackerPlugin.java

@@ -1221,12 +1221,29 @@ public void onItemContainerChanged(ItemContainerChanged event)
 
 		log.debug("Inv change: {} Ground items: {}", items, groundItems);
 
+		final Set<Integer> removedItemIDs = diffr.entrySet().stream().map(Multiset.Entry::getElement).collect(Collectors.toSet());
+		final Set<Integer> currentInventoryItemIDs = currentInventory.entrySet().stream().map(Multiset.Entry::getElement).collect(Collectors.toSet());
+		// Determines whether to ignore #resetEvent or not due to the game possibly continuing to modify the players inventory without any interaction
+		// An example of this would be searching bird nests, as after searching one nest, the game will continue to search the rest of the nests in the inventory until interrupted
+		boolean ignoreReset = false;
+		if (removedItemIDs.stream().anyMatch(BIRDNEST_IDS::contains))
+		{
+			onInvChange(collectInvItems(LootRecordType.EVENT, BIRDNEST_EVENT));
+			if (currentInventoryItemIDs.stream().anyMatch(BIRDNEST_IDS::contains))
+			{
+				ignoreReset = true;
+			}
+		}
+
 		if (inventorySnapshotCb != null)
 		{
 			inventorySnapshotCb.accept(items, groundItems, diffr);
 		}
 
-		resetEvent();
+		if (!ignoreReset)
+		{
+			resetEvent();
+		}
 	}
 
 	@Subscribe

runelite-client/src/test/java/net/runelite/client/plugins/loottracker/LootTrackerPluginTest.java

@@ -43,6 +43,7 @@
 import net.runelite.api.ItemComposition;
 import net.runelite.api.ItemContainer;
 import net.runelite.api.IterableHashTable;
+import net.runelite.api.MenuAction;
 import net.runelite.api.MessageNode;
 import net.runelite.api.Player;
 import net.runelite.api.Skill;
@@ -52,6 +53,7 @@
 import net.runelite.api.events.ChatMessage;
 import net.runelite.api.events.GameStateChanged;
 import net.runelite.api.events.ItemContainerChanged;
+import net.runelite.api.events.MenuOptionClicked;
 import net.runelite.api.events.WidgetLoaded;
 import net.runelite.api.gameval.InterfaceID;
 import net.runelite.api.gameval.InventoryID;
@@ -583,7 +585,7 @@ public void testWintertodtRewardCart()
 		when(client.getLocalPlayer()).thenReturn(player);
 		when(client.getBoostedSkillLevel(Skill.FIREMAKING)).thenReturn(99);
 
-		doNothing().when(lootTrackerPlugin).addLoot(any(), anyInt(), any(), any(), anyCollection());
+		doNothing().when(lootTrackerPlugin).addLoot(any(), anyInt(), any(), any(), any(Collection.class));
 
 		ItemContainer itemContainer = mock(ItemContainer.class);
 		when(itemContainer.getItems()).thenReturn(new Item[]{
@@ -686,4 +688,64 @@ public void testLargeSalvage()
 
 		verify(lootTrackerPlugin).addLoot("Large salvage", -1, LootRecordType.EVENT, null, Collections.singletonList(new ItemStack(ItemID.NAILS, 4)));
 	}
+
+	@Test
+	public void testBirdNests()
+	{
+		List<ItemStack> initialItems = Collections.singletonList(
+			new ItemStack(ItemID.BIRD_NEST_SEEDS_JAN2019, 2)
+		);
+		sendInvChange(InventoryID.INV, initialItems);
+
+		MenuOptionClicked searchBirdNest = mock(MenuOptionClicked.class);
+		when(searchBirdNest.getMenuAction()).thenReturn(MenuAction.CC_OP);
+		when(searchBirdNest.isItemOp()).thenReturn(true);
+		when(searchBirdNest.getMenuOption()).thenReturn("Search");
+		when(searchBirdNest.getItemId()).thenReturn(ItemID.BIRD_NEST_SEEDS_JAN2019);
+		lootTrackerPlugin.onMenuOptionClicked(searchBirdNest);
+
+		List<ItemStack> itemsAfterOneSearch = Arrays.asList(
+			new ItemStack(ItemID.BIRD_NEST_EMPTY, 1),
+			new ItemStack(ItemID.BIRD_NEST_SEEDS_JAN2019, 1),
+			new ItemStack(ItemID.ACORN, 1)
+		);
+		ChatMessage chatMessage = new ChatMessage(null, ChatMessageType.GAMEMESSAGE, "", "You take an acorn out of the bird's nest.", "", 0);
+		lootTrackerPlugin.onChatMessage(chatMessage);
+		sendInvChange(InventoryID.INV, itemsAfterOneSearch);
+		verify(lootTrackerPlugin).addLoot("Bird nest", -1, LootRecordType.EVENT, null, Arrays.asList(
+			new ItemStack(ItemID.ACORN, 1),
+			new ItemStack(ItemID.BIRD_NEST_EMPTY, 1)
+		));
+
+		lootTrackerPlugin.onMenuOptionClicked(searchBirdNest);
+
+		List<ItemStack> itemsAfterTwoSearches = Arrays.asList(
+			new ItemStack(ItemID.BIRD_NEST_EMPTY, 2),
+			new ItemStack(ItemID.ACORN, 1),
+			new ItemStack(ItemID.CELASTRUS_TREE_SEED, 1)
+		);
+		chatMessage = new ChatMessage(null, ChatMessageType.GAMEMESSAGE, "", "You take a celastrus tree seed out of the bird's nest.", "", 0);
+		lootTrackerPlugin.onChatMessage(chatMessage);
+		sendInvChange(InventoryID.INV, itemsAfterTwoSearches);
+		verify(lootTrackerPlugin).addLoot("Bird nest", -1, LootRecordType.EVENT, null, Arrays.asList(
+			new ItemStack(ItemID.BIRD_NEST_EMPTY, 1),
+			new ItemStack(ItemID.CELASTRUS_TREE_SEED, 1)
+		));
+
+		// Additional test to make sure ignoring reset didn't break anything
+		List<ItemStack> itemsPostBirdNestTest = Arrays.asList(
+			new ItemStack(ItemID.SAILING_LARGE_SHIPWRECK_SALVAGE, 1)
+		);
+
+		sendInvChange(InventoryID.INV, itemsPostBirdNestTest);
+
+		chatMessage = new ChatMessage(null, ChatMessageType.GAMEMESSAGE, "", "You sort through the large salvage and find: 4 x Steel nails.", "", 0);
+		lootTrackerPlugin.onChatMessage(chatMessage);
+
+		sendInvChange(InventoryID.INV, Collections.singletonList(
+			new ItemStack(ItemID.NAILS, 4)
+		));
+
+		verify(lootTrackerPlugin).addLoot("Large salvage", -1, LootRecordType.EVENT, null, Collections.singletonList(new ItemStack(ItemID.NAILS, 4)));
+	}
 }