Merge branch 'Zoinkwiz:master' into master

Author: PsycloneTM

src/main/java/com/questhelper/QuestHelperPlugin.java

@@ -182,6 +182,7 @@ protected void startUp() throws IOException
 	{
 		questBankManager.startUp(injector, eventBus);
 		QuestContainerManager.getBankData().setSpecialMethodToObtainItems(() -> questBankManager.getBankItems().toArray(new Item[0]));
+		QuestContainerManager.getGroupStorageData().setSpecialMethodToObtainItems(() -> questBankManager.getGroupBankItems().toArray(new Item[0]));
 		eventBus.register(worldMapAreaManager);
 
 		injector.injectMembers(playerStateManager);
@@ -260,13 +261,31 @@ public void onItemContainerChanged(ItemContainerChanged event)
 		{
 			ItemAndLastUpdated inventoryData = QuestContainerManager.getInventoryData();
 			inventoryData.update(client.getTickCount(), items);
+
+			// Check if it matches last known group inventory state to know if we should update group storage
+			boolean bankChanged = questBankManager.updateGroupBankOnInventoryChange(items);
+			if (bankChanged)
+			{
+				ItemAndLastUpdated groupBankData = QuestContainerManager.getGroupStorageData();
+				groupBankData.update(client.getTickCount(), items);
+			}
 		}
 
 		if (event.getContainerId() == InventoryID.EQUIPMENT.getId())
 		{
 			ItemAndLastUpdated equippedData = QuestContainerManager.getEquippedData();
 			equippedData.update(client.getTickCount(), items);
 		}
+		if (event.getContainerId() == InventoryID.GROUP_STORAGE.getId())
+		{
+			ItemAndLastUpdated groupBankData = QuestContainerManager.getGroupStorageData();
+			groupBankData.update(client.getTickCount(), items);
+			questBankManager.updateLocalGroupBank(client, event.getItemContainer());
+		}
+		if (event.getContainerId() == InventoryID.GROUP_STORAGE_INV.getId())
+		{
+			questBankManager.updateLocalGroupInventory(items);
+		}
 	}
 
 	@Subscribe

src/main/java/com/questhelper/bank/GroupBank.java

@@ -0,0 +1,110 @@
+/*
+ * Copyright (c) 2024, Zoinkwiz <https://github.com/Zoinkwiz>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.questhelper.bank;
+
+import com.google.gson.Gson;
+import com.google.inject.Inject;
+import com.google.inject.Singleton;
+import lombok.Setter;
+import lombok.extern.slf4j.Slf4j;
+import net.runelite.api.Client;
+import net.runelite.api.Item;
+import net.runelite.client.config.ConfigManager;
+
+import java.util.Arrays;
+
+@Slf4j
+@Singleton
+public class GroupBank extends QuestBank
+{
+
+    @Setter
+    private Item[] groupBankDuringEditing;
+
+    private Item[] groupInventoryDuringEditing;
+
+    // Inventory change event occurs once before actual change from group editing
+    // So we need to allow for this
+    private int inventoryChangeEvents = 0;
+
+    @Inject
+    public GroupBank(Client client, ConfigManager configManager, Gson gson)
+    {
+        super(client, configManager, gson);
+    }
+
+    // Inventory changed. If it matches group Inventory
+    public boolean updateAfterInventoryChange(Item[] inventoryItems)
+    {
+        if (groupBankDuringEditing == null || inventoryItems == null || groupInventoryDuringEditing == null) return false;
+        if (Arrays.equals(inventoryItems, paddedItems(groupInventoryDuringEditing)))
+        {
+            updateLocalBank(groupBankDuringEditing);
+            groupBankDuringEditing = null;
+            groupInventoryDuringEditing = null;
+            return true;
+        }
+
+        inventoryChangeEvents++;
+        int MAX_INVENTORY_CHANGE_BEFORE_CLEAR = 2;
+        if (inventoryChangeEvents == MAX_INVENTORY_CHANGE_BEFORE_CLEAR)
+        {
+            inventoryChangeEvents = 0;
+            groupBankDuringEditing = null;
+            groupInventoryDuringEditing = null;
+        }
+
+        return false;
+    }
+
+    public void setGroupInventoryDuringEditing(Item[] groupInventoryDuringEditing)
+    {
+        inventoryChangeEvents = 0;
+        this.groupInventoryDuringEditing = groupInventoryDuringEditing;
+    }
+
+    private Item[] paddedItems(Item[] oldItems)
+    {
+        final int INVENTORY_SIZE = 28;
+
+        Item[] newItems = new Item[28];
+
+        System.arraycopy(oldItems, 0, newItems, 0, oldItems.length);
+
+        for (int i = oldItems.length; i < INVENTORY_SIZE; i++)
+        {
+            newItems[i] = new Item(-1, 0);
+        }
+
+        return newItems;
+    }
+
+    @Override
+    protected String getKey()
+    {
+        return "groupbankitems";
+    }
+}
+

src/main/java/com/questhelper/bank/QuestBank.java

@@ -50,7 +50,6 @@ public class QuestBank
 	private final Gson gson;
 
 	private static final String CONFIG_GROUP = QuestHelperConfig.QUEST_HELPER_GROUP;
-	private static final String BANK_KEY = "bankitems";
 
 	private List<Item> bankItems;
 	private final QuestBankData questBankData;
@@ -111,7 +110,7 @@ private void loadBankFromConfig()
 		rsProfileKey = configManager.getRSProfileKey();
 		worldType = RuneScapeProfileType.getCurrent(client);
 
-		String json = configManager.getRSProfileConfiguration(CONFIG_GROUP, BANK_KEY);
+		String json = configManager.getRSProfileConfiguration(CONFIG_GROUP, getKey());
 		try
 		{
 			questBankData.setIdAndQuantity(gson.fromJson(json, int[].class));
@@ -132,7 +131,7 @@ public void saveBankToConfig()
 			return;
 		}
 
-		configManager.setConfiguration(CONFIG_GROUP, rsProfileKey, BANK_KEY, gson.toJson(questBankData.getIdAndQuantity()));
+		configManager.setConfiguration(CONFIG_GROUP, rsProfileKey, getKey(), gson.toJson(questBankData.getIdAndQuantity()));
 	}
 
 	private String getCurrentKey()
@@ -151,4 +150,8 @@ private String getCurrentKey()
 		key.append(client.getLocalPlayer().getName());
 		return key.toString();
 	}
+	protected String getKey()
+	{
+		return "bankitems";
+	}
 }

src/main/java/com/questhelper/collections/ItemCollections.java

@@ -203,6 +203,7 @@ public enum ItemCollections
 		ItemID.ZARYTE_CROSSBOW,
 		ItemID.ARMADYL_CROSSBOW,
 		ItemID.DRAGON_HUNTER_CROSSBOW,
+		ItemID.HUNTERS_SUNLIGHT_CROSSBOW,
 		ItemID.HUNTERS_CROSSBOW,
 		ItemID.DORGESHUUN_CROSSBOW,
 		ItemID.BLURITE_CROSSBOW,

src/main/java/com/questhelper/helpers/achievementdiaries/fremennik/FremennikMedium.java

@@ -418,6 +418,7 @@ public List<Requirement> getGeneralRequirements()
 		req.add(olafsQuest);
 		req.add(eaglesPeak);
 		req.add(betweenARock);
+		req.add(horrorFromTheDeep);
 		return req;
 	}
 

src/main/java/com/questhelper/helpers/quests/contact/Contact.java

@@ -331,16 +331,16 @@ public List<PanelDetails> getPanels()
 	{
 		List<PanelDetails> allSteps = new ArrayList<>();
 
-		allSteps.add(new PanelDetails("Starting off", Arrays.asList(talkToHighPriest, talkToJex), lightSource, tinderbox));
+		allSteps.add(new PanelDetails("Starting off", Arrays.asList(talkToHighPriest, talkToJex), lightSource, tinderbox, antipoison));
 
 		allSteps.add(new PanelDetails("Explore the dungeon",
 			Arrays.asList(goDownToBank, goDownToDungeon, goDownToChasm, searchKaleef, readParchment,
-				talkToMaisa, talkToOsman), lightSource, tinderbox));
+				talkToMaisa, talkToOsman), lightSource, tinderbox, antipoison));
 
 		allSteps.add(new PanelDetails("Help Osman",
 			Arrays.asList(talkToOsmanOutsideSoph, goDownToBankAgain, goDownToDungeonAgain,
 				goDownToChasmAgain, killGiantScarab, talkToOsmanChasm, pickUpKeris, returnToHighPriest), combatGear, food, prayerPotions,
-			lightSource, tinderbox));
+			lightSource, tinderbox, antipoison));
 
 		return allSteps;
 	}

src/main/java/com/questhelper/helpers/quests/entertheabyss/EnterTheAbyss.java

@@ -146,6 +146,7 @@ public void setupSteps()
 		goDownInWizardsTower.addDialogStep("Wizard's Tower");
 		talkToSedridor = new NpcStep(this, NpcID.ARCHMAGE_SEDRIDOR, new WorldPoint(3104, 9571, 0),
 			"Teleport to the essence mine with Sedridor in the Wizard Tower's basement.", scryingOrb);
+		((NpcStep) talkToSedridor).addAlternateNpcs(5034);
 		talkToSedridor.addDialogStep("Can you teleport me to the Rune Essence Mine?");
 		talkToSedridor.addSubSteps(goDownInWizardsTower);
 

src/main/java/com/questhelper/helpers/quests/whileguthixsleeps/WhileGuthixSleeps.java

@@ -1122,7 +1122,7 @@ public void setupSteps()
 			"Bring the unconscious broav to the Feldip Hills hunting expert.", unconsciousBroav);
 		returnBroavToHuntingExpert.addDialogSteps("Do you think you could train this broav for me?", "A creature to help track down a person.");
 
-		goToBrokenTable = new DetailedQuestStep(this, new WorldPoint(2519, 3248, 0), "Go to the broken table in the middle of the khazard side of the gnome/khazard battlefield.", broav);
+		goToBrokenTable = new DetailedQuestStep(this, new WorldPoint(2519, 3248, 0), "Go to the broken table in the middle of the Khazard side of the Khazard-Gnome battlefield.", broav);
 		goToBrokenTable.addTeleport(khazardTeleport);
 		goToBrokenTable.setHighlightZone(nearTable);
 
@@ -1133,7 +1133,7 @@ public void setupSteps()
 
 		searchBrokenTable = new ObjectStep(this, NullObjectID.NULL_53889, new WorldPoint(2519, 3249, 0), "Search the broken table.");
 
-		enterMovarioBase = new ObjectStep(this, ObjectID.TRAPDOOR_53279, new WorldPoint(2519, 3249, 0), "Enter movario's base under the broken table in the Khazard Battlefield.");
+		enterMovarioBase = new ObjectStep(this, ObjectID.TRAPDOOR_53279, new WorldPoint(2519, 3249, 0), "Enter Movario's base under the broken table in the Khazard Battlefield.");
 
 		// TODO: Update hardcoded 54117 to CHEST_54117
 		claimRunes = new ObjectStep(this, 54117, new WorldPoint(4124, 4984, 0), "Search the open chest in the far north of the area for some runes.");
@@ -1227,8 +1227,8 @@ public void setupSteps()
 		searchChestForTraps = new ObjectStep(this, ObjectID.BED_CHEST_53951, new WorldPoint(4179, 4954, 2), "RIGHT-CLICK search the bed chest for traps.");
 		getNotesFromChest = new ObjectStep(this, ObjectID.BED_CHEST_53952, new WorldPoint(4179, 4954, 2), "Take the second pair of notes from the bed chest.");
 		((ObjectStep) getNotesFromChest).addAlternateObjects(ObjectID.BED_CHEST_53951);
-		readNotes1 = new DetailedQuestStep(this, "Read the movario notes 1.", movariosNotesV1.highlighted());
-		readNotes2 = new DetailedQuestStep(this, "Read the movario notes 2.", movariosNotesV2.highlighted());
+		readNotes1 = new DetailedQuestStep(this, "Read Movario's notes (vol. 1).", movariosNotesV1.highlighted());
+		readNotes2 = new DetailedQuestStep(this, "Read Movario's notes (vol. 2).", movariosNotesV2.highlighted());
 		goDownFromHiddenRoom = new ObjectStep(this, ObjectID.STAIRS_53948, new WorldPoint(4173, 4956, 2), "Go back downstairs.");
 		inspectPainting = new ObjectStep(this, ObjectID.PAINTING_53885, new WorldPoint(4179, 4948, 1), "Inspect the painting in the south of the room.");
 		inspectPainting.addDialogStep("Pull the lever.");

src/main/java/com/questhelper/managers/QuestBankManager.java

@@ -25,18 +25,16 @@
 package com.questhelper.managers;
 
 import com.google.inject.Injector;
-import com.questhelper.QuestHelperPlugin;
+import com.questhelper.bank.GroupBank;
 import com.questhelper.bank.QuestBank;
 import com.questhelper.bank.banktab.QuestBankTab;
 import com.questhelper.bank.banktab.QuestHelperBankTagService;
 import lombok.Getter;
-import net.runelite.api.Client;
-import net.runelite.api.Item;
-import net.runelite.api.ItemContainer;
-import net.runelite.api.Player;
+import net.runelite.api.*;
 import net.runelite.client.eventbus.EventBus;
 import javax.inject.Inject;
 import javax.inject.Singleton;
+import java.util.Arrays;
 import java.util.List;
 
 @Singleton
@@ -45,6 +43,9 @@ public class QuestBankManager
 	@Inject
 	private QuestBank questBank;
 
+	@Inject
+	private GroupBank groupBank;
+
 	@Getter
 	@Inject
 	private QuestHelperBankTagService bankTagService;
@@ -88,6 +89,7 @@ public void setUnknownInitialState()
 	public void loadState()
 	{
 		questBank.loadState();
+		groupBank.loadState();
 	}
 
 	public void startUpQuest()
@@ -105,6 +107,11 @@ public List<Item> getBankItems()
 		return questBank.getBankItems();
 	}
 
+	public List<Item> getGroupBankItems()
+	{
+		return groupBank.getBankItems();
+	}
+
 	public void refreshBankTab()
 	{
 		questBankTab.refreshBankTab();
@@ -115,18 +122,46 @@ public void updateLocalBank(ItemContainer itemContainer)
 		questBank.updateLocalBank(itemContainer.getItems());
 	}
 
+	public void updateLocalGroupBank(Client client, ItemContainer itemContainer)
+	{
+		boolean hasChangedGroupStorage = client.getVarbitValue(4602) == 1;
+		if (hasChangedGroupStorage)
+		{
+			// If editing, group bank not actually 'saved', so don't update yet
+			groupBank.setGroupBankDuringEditing(itemContainer.getItems());
+		}
+		else
+		{
+			groupBank.updateLocalBank(itemContainer.getItems());
+		}
+	}
+
+	public void updateLocalGroupInventory(Item[] items)
+	{
+		groupBank.setGroupInventoryDuringEditing(items);
+	}
+
+	public boolean updateGroupBankOnInventoryChange(Item[] inventoryItems)
+	{
+		return groupBank.updateAfterInventoryChange(inventoryItems);
+	}
+
 	public void updateBankForQuestSpeedrunningWorld()
 	{
 		questBank.updateLocalBank(new Item[]{ });
+		groupBank.updateLocalBank(new Item[]{ });
 	}
 
+
 	public void saveBankToConfig()
 	{
 		questBank.saveBankToConfig();
+		groupBank.saveBankToConfig();
 	}
 
 	public void emptyState()
 	{
 		questBank.emptyState();
+		groupBank.emptyState();
 	}
 }

src/main/java/com/questhelper/managers/QuestContainerManager.java

@@ -40,4 +40,7 @@ public class QuestContainerManager
 
     @Getter
     private final static ItemAndLastUpdated potionData = new ItemAndLastUpdated(TrackedContainers.POTION_STORAGE);
+
+    @Getter
+    private final static ItemAndLastUpdated groupStorageData = new ItemAndLastUpdated(TrackedContainers.GROUP_STORAGE);
 }

src/main/java/com/questhelper/panel/QuestRequirementsPanel.java

@@ -26,7 +26,6 @@
 package com.questhelper.panel;
 
 import com.questhelper.QuestHelperPlugin;
-import com.questhelper.bank.QuestBank;
 import com.questhelper.managers.QuestManager;
 import com.questhelper.questhelpers.QuestHelper;
 import com.questhelper.requirements.Requirement;
@@ -297,6 +296,10 @@ else if (newColor == Color.ORANGE)
 			{
 				label.setToolTipText("On steel key ring");
 			}
+			else if (newColor == Color.LIGHT_GRAY)
+			{
+				label.setToolTipText("Possibly in Group Storage");
+			}
 			else
 			{
 				label.setToolTipText("");