Merge pull request #5817 from raiyni/clue-tags

Bank tags: Search current clue items

runelite-client/src/main/java/net/runelite/client/plugins/banktags/BankTagsPlugin.java

@@ -60,15 +60,18 @@ import net.runelite.client.game.ItemManager;
 import net.runelite.client.input.MouseManager;
 import net.runelite.client.input.MouseWheelListener;
 import net.runelite.client.plugins.Plugin;
+import net.runelite.client.plugins.PluginDependency;
 import net.runelite.client.plugins.PluginDescriptor;
 import net.runelite.client.plugins.banktags.tabs.TabInterface;
 import net.runelite.client.plugins.banktags.tabs.TabSprites;
+import net.runelite.client.plugins.cluescrolls.ClueScrollPlugin;
 
 @PluginDescriptor(
 	name = "Bank Tags",
 	description = "Enable tagging of bank items and searching of bank tags",
 	tags = {"searching", "tagging"}
 )
+@PluginDependency(ClueScrollPlugin.class)
 public class BankTagsPlugin extends Plugin implements MouseWheelListener
 {
 	public static final Splitter SPLITTER = Splitter.on(",").omitEmptyStrings().trimResults();

runelite-client/src/main/java/net/runelite/client/plugins/banktags/TagManager.java

@@ -32,11 +32,20 @@ import java.util.List;
 import java.util.stream.Collectors;
 import javax.inject.Inject;
 import javax.inject.Singleton;
+import net.runelite.api.ItemID;
 import net.runelite.client.config.ConfigManager;
 import net.runelite.client.game.ItemManager;
 import static net.runelite.client.plugins.banktags.BankTagsPlugin.CONFIG_GROUP;
 import static net.runelite.client.plugins.banktags.BankTagsPlugin.JOINER;
 import static net.runelite.client.plugins.banktags.BankTagsPlugin.SPLITTER;
+import net.runelite.client.plugins.cluescrolls.ClueScrollService;
+import net.runelite.client.plugins.cluescrolls.clues.ClueScroll;
+import net.runelite.client.plugins.cluescrolls.clues.CoordinateClue;
+import net.runelite.client.plugins.cluescrolls.clues.EmoteClue;
+import net.runelite.client.plugins.cluescrolls.clues.FairyRingClue;
+import net.runelite.client.plugins.cluescrolls.clues.HotColdClue;
+import net.runelite.client.plugins.cluescrolls.clues.MapClue;
+import net.runelite.client.plugins.cluescrolls.clues.emote.ItemRequirement;
 import net.runelite.client.util.Text;
 
 @Singleton
@@ -46,11 +55,14 @@ public class TagManager
 	private final ItemManager itemManager;
 	private final ConfigManager configManager;
 
+	private final ClueScrollService clueScrollService;
+
 	@Inject
-	private TagManager(final ItemManager itemManager, final ConfigManager configManager)
+	private TagManager(final ItemManager itemManager, final ConfigManager configManager, final ClueScrollService clueScrollService)
 	{
 		this.itemManager = itemManager;
 		this.configManager = configManager;
+		this.clueScrollService = clueScrollService;
 	}
 
 	String getTagString(int itemId)
@@ -108,6 +120,11 @@ public class TagManager
 
 	boolean findTag(int itemId, String search)
 	{
+		if (search.equals("clue") && testClue(itemId))
+		{
+			return true;
+		}
+
 		return getTags(itemId).stream().anyMatch(tag -> tag.contains(Text.standardize(search)));
 	}
 
@@ -134,4 +151,39 @@ public class TagManager
 			setTags(itemId, tags);
 		}
 	}
+
+	private boolean testClue(int itemId)
+	{
+		ClueScroll c = clueScrollService.getClue();
+
+		if (c == null)
+		{
+			return false;
+		}
+
+		if (c instanceof EmoteClue)
+		{
+			EmoteClue emote = (EmoteClue) c;
+
+			for (ItemRequirement ir : emote.getItemRequirements())
+			{
+				if (ir.fulfilledBy(itemId))
+				{
+					return true;
+				}
+			}
+		}
+		else if (c instanceof CoordinateClue || c instanceof HotColdClue || c instanceof FairyRingClue)
+		{
+			return itemId == ItemID.SPADE;
+		}
+		else if (c instanceof MapClue)
+		{
+			MapClue mapClue = (MapClue) c;
+
+			return mapClue.getObjectId() == -1 && itemId == ItemID.SPADE;
+		}
+
+		return false;
+	}
 }

runelite-client/src/main/java/net/runelite/client/plugins/cluescrolls/ClueScrollPlugin.java

@@ -27,6 +27,7 @@
 package net.runelite.client.plugins.cluescrolls;
 
 import com.google.common.eventbus.Subscribe;
+import com.google.inject.Binder;
 import com.google.inject.Provides;
 import java.awt.image.BufferedImage;
 import java.time.Duration;
@@ -147,6 +148,12 @@ public class ClueScrollPlugin extends Plugin
 		return configManager.getConfig(ClueScrollConfig.class);
 	}
 
+	@Override
+	public void configure(Binder binder)
+	{
+		binder.bind(ClueScrollService.class).to(ClueScrollServiceImpl.class);
+	}
+
 	@Override
 	protected void startUp() throws Exception
 	{

runelite-client/src/main/java/net/runelite/client/plugins/cluescrolls/ClueScrollService.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2018, Ron Young <https://github.com/raiyni>
+ * 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 net.runelite.client.plugins.cluescrolls;
+
+import net.runelite.client.plugins.cluescrolls.clues.ClueScroll;
+
+public interface ClueScrollService
+{
+	/**
+	 * Get the clue scroll
+	 *
+	 * @return ClueScroll
+	 */
+	ClueScroll getClue();
+}

runelite-client/src/main/java/net/runelite/client/plugins/cluescrolls/ClueScrollServiceImpl.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2018, Ron Young <https://github.com/raiyni>
+ * 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 net.runelite.client.plugins.cluescrolls;
+
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import net.runelite.client.plugins.cluescrolls.clues.ClueScroll;
+
+@Singleton
+class ClueScrollServiceImpl implements ClueScrollService
+{
+	private final ClueScrollPlugin plugin;
+
+	@Inject
+	private ClueScrollServiceImpl(ClueScrollPlugin plugin)
+	{
+		this.plugin = plugin;
+	}
+
+	@Override
+	public ClueScroll getClue()
+	{
+		return plugin.getClue();
+	}
+}

runelite-client/src/main/java/net/runelite/client/plugins/cluescrolls/clues/emote/AllRequirementsCollection.java

@@ -36,6 +36,20 @@ public class AllRequirementsCollection implements ItemRequirement
 		this.requirements = requirements;
 	}
 
+	@Override
+	public boolean fulfilledBy(int itemId)
+	{
+		for (ItemRequirement requirement : requirements)
+		{
+			if (requirement.fulfilledBy(itemId))
+			{
+				return true;
+			}
+		}
+
+		return false;
+	}
+
 	@Override
 	public boolean fulfilledBy(Item[] items)
 	{

runelite-client/src/main/java/net/runelite/client/plugins/cluescrolls/clues/emote/AnyRequirementCollection.java

@@ -38,6 +38,20 @@ public class AnyRequirementCollection implements ItemRequirement
 		this.requirements = requirements;
 	}
 
+	@Override
+	public boolean fulfilledBy(int itemId)
+	{
+		for (ItemRequirement requirement : requirements)
+		{
+			if (requirement.fulfilledBy(itemId))
+			{
+				return true;
+			}
+		}
+
+		return false;
+	}
+
 	@Override
 	public boolean fulfilledBy(Item[] items)
 	{

runelite-client/src/main/java/net/runelite/client/plugins/cluescrolls/clues/emote/ItemRequirement.java

@@ -29,6 +29,8 @@ import net.runelite.api.Item;
 
 public interface ItemRequirement
 {
+	boolean fulfilledBy(int itemId);
+
 	boolean fulfilledBy(Item[] items);
 
 	String getCollectiveName(Client client);

runelite-client/src/main/java/net/runelite/client/plugins/cluescrolls/clues/emote/RangeItemRequirement.java

@@ -40,6 +40,12 @@ public class RangeItemRequirement implements ItemRequirement
 		this.endItemId = endItemId;
 	}
 
+	@Override
+	public boolean fulfilledBy(int itemId)
+	{
+		return itemId >= startItemId && itemId <= endItemId;
+	}
+
 	@Override
 	public boolean fulfilledBy(Item[] items)
 	{

runelite-client/src/main/java/net/runelite/client/plugins/cluescrolls/clues/emote/SingleItemRequirement.java

@@ -37,6 +37,12 @@ public class SingleItemRequirement implements ItemRequirement
 		this.itemId = itemId;
 	}
 
+	@Override
+	public boolean fulfilledBy(int itemId)
+	{
+		return this.itemId == itemId;
+	}
+
 	@Override
 	public boolean fulfilledBy(Item[] items)
 	{

runelite-client/src/main/java/net/runelite/client/plugins/cluescrolls/clues/emote/SlotLimitationRequirement.java

@@ -39,6 +39,12 @@ public class SlotLimitationRequirement implements ItemRequirement
 		this.slots = slots;
 	}
 
+	@Override
+	public boolean fulfilledBy(int itemId)
+	{
+		return false;
+	}
+
 	@Override
 	public boolean fulfilledBy(Item[] items)
 	{