Create SpellRequirement for easier spell manipulation.

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

@@ -272,9 +272,10 @@ public class ItemCollections
 
 	@Getter
 	private static final List<Integer> waterStaff = QuestUtil.toLinkedList(
-		ItemID.FIRE_BATTLESTAFF,
-		ItemID.MYSTIC_FIRE_STAFF,
-		ItemID.STAFF_OF_FIRE,
+		ItemID.KODAI_WAND,
+		ItemID.WATER_BATTLESTAFF,
+		ItemID.MYSTIC_WATER_STAFF,
+		ItemID.STAFF_OF_WATER,
 		ItemID.MUD_BATTLESTAFF,
 		ItemID.MYSTIC_MUD_STAFF,
 		ItemID.MIST_BATTLESTAFF,
@@ -304,6 +305,42 @@ public class ItemCollections
 		ItemID.MYSTIC_LAVA_STAFF
 	);
 
+	@Getter
+	private static final List<Integer> lavaStaff = QuestUtil.toLinkedList(
+		ItemID.LAVA_BATTLESTAFF,
+		ItemID.MYSTIC_LAVA_STAFF
+	);
+
+	@Getter
+	private static final List<Integer> mudStaff = QuestUtil.toLinkedList(
+		ItemID.MUD_BATTLESTAFF,
+		ItemID.MYSTIC_MUD_STAFF
+	);
+
+	@Getter
+	private static final List<Integer> steamStaff = QuestUtil.toLinkedList(
+		ItemID.STEAM_BATTLESTAFF,
+		ItemID.MYSTIC_STEAM_STAFF
+	);
+
+	@Getter
+	private static final List<Integer> smokeStaff = QuestUtil.toLinkedList(
+		ItemID.SMOKE_BATTLESTAFF,
+		ItemID.MYSTIC_SMOKE_STAFF
+	);
+
+	@Getter
+	private static final List<Integer> mistStaff = QuestUtil.toLinkedList(
+		ItemID.MIST_BATTLESTAFF,
+		ItemID.MYSTIC_MIST_STAFF
+	);
+
+	@Getter
+	private static final List<Integer> dustStaff = QuestUtil.toLinkedList(
+		ItemID.DUST_BATTLESTAFF,
+		ItemID.MYSTIC_DUST_STAFF
+	);
+
 	// Potions
 
 	@Getter

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

@@ -135,6 +135,7 @@ public class QuestHelperPlugin extends Plugin
 
 	private static final Zone PHOENIX_START_ZONE = new Zone(new WorldPoint(3204, 3488, 0), new WorldPoint(3221, 3501, 0));
 
+	@Getter
 	private final BankItems bankItems = new BankItems();
 
 	@Getter

src/main/java/com/questhelper/banktab/BankItemHolder.java

@@ -0,0 +1,54 @@
+/*
+ *
+ *  * Copyright (c) 2021, Senmori
+ *  * 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.banktab;
+
+import com.questhelper.requirements.item.ItemRequirement;
+import java.util.List;
+import javax.annotation.Nullable;
+import net.runelite.api.Client;
+import net.runelite.api.Item;
+
+/**
+ * Represents anything that holds {@link ItemRequirement}s that are to be used
+ * for displaying via the {@link QuestBankTab}.
+ * <br>
+ * Most requirements will not need this interface, however this interface does allow
+ * that requirement to specify which {@link ItemRequirement} should be displayed
+ * via the quest bank tab.
+ */
+public interface BankItemHolder
+{
+	/**
+	 * Get a list of {@link ItemRequirement} to be displayed.
+	 *
+	 * @param client the {@link Client}
+	 * @param checkConsideringSlotRestrictions if the client item container checks should respect slot restrictions
+	 * @param bankItems the player's {@link com.questhelper.BankItems}, this can be null
+	 * @return a list of {@link ItemRequirement} that should be displayed, or an empty list if none are found
+	 */
+	List<ItemRequirement> getRequirements(Client client, boolean checkConsideringSlotRestrictions, @Nullable Item[] bankItems);
+}

src/main/java/com/questhelper/banktab/QuestBankTab.java

@@ -30,7 +30,11 @@
 import com.google.common.primitives.Shorts;
 import com.questhelper.QuestHelperPlugin;
 import java.awt.Color;
+import java.awt.Font;
+import java.awt.FontMetrics;
+import java.awt.Graphics;
 import java.awt.Point;
+import java.awt.image.BufferedImage;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -43,6 +47,7 @@
 import net.runelite.api.ChatMessageType;
 import net.runelite.api.Client;
 import net.runelite.api.FontID;
+import net.runelite.api.FontTypeFace;
 import net.runelite.api.ItemID;
 import net.runelite.api.ScriptEvent;
 import net.runelite.api.ScriptID;
@@ -64,6 +69,7 @@
 import net.runelite.client.chat.ChatMessageBuilder;
 import net.runelite.client.chat.ChatMessageManager;
 import net.runelite.client.chat.QueuedMessage;
+import net.runelite.client.config.FontType;
 import net.runelite.client.eventbus.Subscribe;
 import net.runelite.client.game.ItemManager;
 import net.runelite.client.game.ItemVariationMapping;
@@ -333,6 +339,12 @@ private int addPluginTabSection(Widget itemContainer, List<BankTabItem> items, L
 			return 0;
 		}
 
+		// Get FontMetrics so we can accurately get font height/width
+		BufferedImage img = new BufferedImage(1, 1, BufferedImage.TYPE_INT_ARGB);
+		Graphics graphics = img.getGraphics();
+		FontMetrics fm = graphics.getFontMetrics(FontType.SMALL.getFont());
+		img = null;
+		graphics = null;
 		for (BankTabItem bankTabItem : items)
 		{
 			boolean foundItem = false;
@@ -356,21 +368,22 @@ private int addPluginTabSection(Widget itemContainer, List<BankTabItem> items, L
 						if (bankTabItem.getQuantity() > 0)
 						{
 							String quantityString = QuantityFormatter.quantityToStackSize(bankTabItem.getQuantity());
-							int extraLength =
-								QuantityFormatter.quantityToStackSize(widget.getItemQuantity()).length() * 6;
-							int requirementLength = quantityString.length() * 6;
+							int itemStackSizeLength = fm.stringWidth(QuantityFormatter.quantityToStackSize(widget.getItemQuantity()));
+							int requirementLength = fm.stringWidth(quantityString);
 
-							int xPos = point.x + 2 + extraLength;
+							int xPos = point.x + 2 + itemStackSizeLength;
 							int yPos = point.y - 1;
-							if (extraLength + requirementLength > 24)
-							{
+							if (itemStackSizeLength + requirementLength > 24)
+							{ // put text on next line
 								xPos = point.x;
-								yPos = point.y + 9;
+								yPos = point.y + fm.getHeight();
 							}
 
+							Color color = questHelper.getConfig().textHighlightColor();
+
 							addedWidgets.add(createText(itemContainer,
 								"/ " + quantityString,
-								Color.WHITE.getRGB(),
+								color.getRGB(),
 								ITEM_HORIZONTAL_SPACING,
 								TEXT_HEIGHT - 3,
 								xPos,
@@ -400,18 +413,19 @@ private int addPluginTabSection(Widget itemContainer, List<BankTabItem> items, L
 				if (bankTabItem.getQuantity() > 0)
 				{
 					String quantityString = QuantityFormatter.quantityToStackSize(bankTabItem.getQuantity());
-					int requirementLength = quantityString.length() * 5;
+					int requirementLength = fm.stringWidth(quantityString);
 					int xPos = adjXOffset + 8;
 					int yPos = adjYOffset - 1;
 					if (requirementLength > 20)
-					{
+					{ // put text on next line
 						xPos = adjXOffset;
-						yPos = adjYOffset + 9;
+						yPos = adjYOffset + fm.getHeight();
 					}
+					Color color = questHelper.getConfig().textHighlightColor();
 
 					addedWidgets.add(createText(itemContainer,
 						"/ " + quantityString,
-						Color.WHITE.getRGB(),
+						color.getRGB(),
 						ITEM_HORIZONTAL_SPACING,
 						TEXT_HEIGHT - 3,
 						xPos,

src/main/java/com/questhelper/banktab/QuestHelperBankTagService.java

@@ -31,11 +31,13 @@
 import com.questhelper.requirements.util.LogicType;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
 import java.util.stream.Collectors;
 import javax.inject.Inject;
 import net.runelite.api.InventoryID;
+import net.runelite.api.Item;
 import net.runelite.api.ItemContainer;
 
 public class QuestHelperBankTagService
@@ -127,15 +129,34 @@ private void getItemsFromRequirement(BankTabItems pluginItems, ItemRequirement i
 				getItemsFromRequirement(pluginItems, match);
 			}
 		}
+		else if (itemRequirement instanceof BankItemHolder)
+		{
+			BankItemHolder holder = (BankItemHolder) itemRequirement;
+			final Item[] items = plugin.getBankItems().getItems();
+			// Force run on client thread even though it's not as responsive as not doing that, however it
+			// ensures we run on the client thread and never run into threading issues.
+			plugin.getClientThread().invoke(() -> {
+				List<ItemRequirement> reqs = holder.getRequirements(plugin.getClient(), false, items);
+				makeBankHolderItems(reqs, pluginItems); // callback because we can't halt on the client thread
+			});
+		}
 		else
 		{
-			if (itemRequirement.getDisplayItemId() != null)
+			makeBankHolderItems(Collections.singletonList(itemRequirement), pluginItems);
+		}
+	}
+
+	private void makeBankHolderItems(List<ItemRequirement> requirements, BankTabItems pluginItems)
+	{
+		for (ItemRequirement req : requirements)
+		{
+			if (req.getDisplayItemId() != null)
 			{
-				pluginItems.addItems(new BankTabItem(itemRequirement));
+				pluginItems.addItems(new BankTabItem(req));
 			}
-			else if (!itemRequirement.getDisplayItemIds().contains(-1))
+			else if (!req.getDisplayItemIds().contains(-1))
 			{
-				pluginItems.addItems(makeBankTabItem(itemRequirement));
+				pluginItems.addItems(makeBankTabItem(req));
 			}
 		}
 	}

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

@@ -506,6 +506,8 @@ public void updateRequirementPanels(Client client, List<QuestRequirementPanel> r
 				{
 					newColor = itemRequirement.getColorConsideringBank(client, false, bankItems.getItems());
 				}
+				String updatedTooltip = itemRequirement.getUpdatedTooltip(client, bankItems);
+				requirementPanel.setInfoButtonTooltip(updatedTooltip);
 			}
 			else
 			{

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

@@ -31,6 +31,7 @@
 import java.awt.Color;
 import java.awt.Dimension;
 import java.awt.Insets;
+import javax.annotation.Nullable;
 import javax.swing.ImageIcon;
 import javax.swing.JButton;
 import javax.swing.JLabel;
@@ -51,6 +52,10 @@ public class QuestRequirementPanel extends JPanel
 	@Getter
 	private final Requirement requirement;
 
+	@Nullable
+	@Getter
+	private JButton infoButton;
+
 	public QuestRequirementPanel(Requirement requirement)
 	{
 		this.requirement = requirement;
@@ -84,20 +89,37 @@ public QuestRequirementPanel(Requirement requirement)
 		}
 	}
 
+	public void setInfoButtonTooltip(String text)
+	{
+		if (infoButton != null)
+		{
+			if (text == null || text.isEmpty())
+			{
+				infoButton.setToolTipText("");
+				infoButton.setVisible(false);
+			}
+			else
+			{
+				String html1 = "<html><body>";
+				String html2 = "</body></html>";
+				text = text.replaceAll("\\n", "<br>");
+				infoButton.setToolTipText(html1 + text + html2);
+			}
+		}
+	}
+
 	private void addButtonToPanel(String tooltipText)
 	{
-		String html1 = "<html><body>";
-		String html2 = "</body></html>";
-		tooltipText = tooltipText.replaceAll("\\n", "<br>");
-		JButton b = new JButton(INFO_ICON);
-		b.setPreferredSize(new Dimension(10, 10));
-		b.setToolTipText(html1 + tooltipText + html2);
-		b.setBorderPainted(false);
-		b.setFocusPainted(false);
-		b.setBorderPainted(false);
-		b.setContentAreaFilled(false);
-		b.setMargin(new Insets(0, 0, 0, 0));
-		add(b);
+
+		infoButton = new JButton(INFO_ICON);
+		infoButton.setPreferredSize(new Dimension(10, 10));
+		setInfoButtonTooltip(tooltipText);
+		infoButton.setBorderPainted(false);
+		infoButton.setFocusPainted(false);
+		infoButton.setBorderPainted(false);
+		infoButton.setContentAreaFilled(false);
+		infoButton.setMargin(new Insets(0, 0, 0, 0));
+		add(infoButton);
 	}
 }
 

src/main/java/com/questhelper/questhelpers/QuestUtil.java

@@ -34,6 +34,7 @@
 import java.util.List;
 import java.util.stream.Collector;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 import javax.annotation.Nonnull;
 
 public class QuestUtil
@@ -59,4 +60,27 @@ public static <T> List<T> toReversedLinkedList(@Nonnull T... elements)
 	{
 		return Collectors.toCollection(ArrayList::new);
 	}
+
+	/**
+	 * Removes all the duplicate elements from a stream and collects them into a
+	 * mutable ArrayList
+	 *
+	 * @param stream stream to remove duplicates from
+	 * @return a mutable list containing all the remaining elements of the stream
+	 */
+	public static <T> List<T> collectAndRemoveDuplicates(Stream<T> stream)
+	{
+		return stream.distinct().collect(collectToArrayList());
+	}
+
+	/**
+	 * Remove duplicates in the given list.
+	 *
+	 * @param list the list
+	 * @return a mutable list without duplicates.
+	 */
+	public static <T> List<T> removeDuplicates(List<T> list)
+	{
+		return collectAndRemoveDuplicates(list.stream());
+	}
 }