Merge pull request #6003 from deathbeam/make-cryptics-robust

Make 3 step cryptic clues more robust

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

@@ -308,7 +308,10 @@ public class ClueScrollPlugin extends Plugin
 				{
 					for (WorldPoint location : locations)
 					{
-						highlightObjectsForLocation(location, objectIds);
+						if (location != null)
+						{
+							highlightObjectsForLocation(location, objectIds);
+						}
 					}
 				}
 			}

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

@@ -195,7 +195,7 @@ public class CrypticClue extends ClueScroll implements TextClueScroll, NpcClueSc
 		new CrypticClue("Reflection is the weakness for these eyes of evil.", null, "Kill a basilisk."),
 		new CrypticClue("Search a bookcase in Lumbridge swamp.", BOOKCASE_9523, new WorldPoint(3146, 3177, 0), "Located in Father Urhney's house."),
 		new CrypticClue("Surround my bones in fire, ontop the wooden pyre. Finally lay me to rest, before my one last test.", null, "Kill a confused/lost barbarian to receive mangled bones. Construct and burn a pyre ship. Kill the ferocious barbarian spirit that spawns to receive a clue casket."),
-		new CrypticClue("Fiendish cooks probably won’t dig the dirty dishes.", new WorldPoint(3043, 4974, 1), "Dig by the fire in the Rogues' Den."),
+		new CrypticClue("Fiendish cooks probably won't dig the dirty dishes.", new WorldPoint(3043, 4974, 1), "Dig by the fire in the Rogues' Den."),
 		new CrypticClue("My life was spared but these voices remain, now guarding these iron gates is my bane.",  "Key Master", new WorldPoint(1310, 1251, 0), "Speak to the Key Master in Cerberus' Lair."),
 		new CrypticClue("Search the boxes in one of the tents in Al Kharid.", BOXES_361, new WorldPoint(3308, 3206, 0), "Search the boxes in the tent east of the Silk trader."),
 		new CrypticClue("One of several rhyming brothers, in business attire with an obsession for paper work.",  "Piles", new WorldPoint(3186, 3936, 0), "Speak to Piles in the Wilderness Resource Area. An entry fee of 7,500 coins is required, or less if Wilderness Diaries have been completed."),

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

@@ -47,17 +47,16 @@ import net.runelite.client.plugins.cluescrolls.ClueScrollPlugin;
 import net.runelite.client.ui.overlay.components.LineComponent;
 import net.runelite.client.ui.overlay.components.PanelComponent;
 import net.runelite.client.ui.overlay.components.TitleComponent;
+import net.runelite.client.util.Text;
 
 @Getter
 public class ThreeStepCrypticClue extends ClueScroll implements TextClueScroll, ObjectClueScroll, NpcClueScroll, LocationsClueScroll
 {
-	private static final int CLUE_STEPS = 3;
+	private final List<Map.Entry<CrypticClue, Boolean>> clueSteps;
-
+	private final int[] objectIds;
-	private List<Map.Entry<CrypticClue, Boolean>> clueSteps;
+	private final String[] npcs;
-	private int[] objectIds;
+	private final String text;
 	private WorldPoint[] locations;
-	private String[] npcs;
-	private String text;
 
 	private ThreeStepCrypticClue(List<Map.Entry<CrypticClue, Boolean>> steps, String text)
 	{
@@ -70,8 +69,7 @@ public class ThreeStepCrypticClue extends ClueScroll implements TextClueScroll,
 
 		for (int i = 0; i < numClueSteps; i++)
 		{
-			CrypticClue c = clueSteps.get(i).getKey();
+			final CrypticClue c = clueSteps.get(i).getKey();
-
 			locations[i] = c.getLocation();
 			npcs[i] = c.getNpc();
 			objectIds[i] = c.getObjectId();
@@ -83,9 +81,9 @@ public class ThreeStepCrypticClue extends ClueScroll implements TextClueScroll,
 	{
 		panelComponent.setPreferredSize(new Dimension(200, 0));
 
-		for (int i = 0; i < CLUE_STEPS; i++)
+		for (int i = 0; i < clueSteps.size(); i++)
 		{
-			Map.Entry<CrypticClue, Boolean> e = clueSteps.get(i);
+			final Map.Entry<CrypticClue, Boolean> e = clueSteps.get(i);
 
 			if (!e.getValue())
 			{
@@ -142,48 +140,27 @@ public class ThreeStepCrypticClue extends ClueScroll implements TextClueScroll,
 
 	public static ThreeStepCrypticClue forText(String plainText, String text)
 	{
-		List<Map.Entry<CrypticClue, Boolean>> steps = new ArrayList<>(CLUE_STEPS);
+		final String[] split = text.split("<br>\\s*<br>");
-		StringBuilder threeStepText = new StringBuilder(text.replaceAll("<br><br>", " ").toLowerCase());
+		final List<Map.Entry<CrypticClue, Boolean>> steps = new ArrayList<>(split.length);
-		boolean stepDone;
 
-		for (int i = 0; i < CLUE_STEPS; i++)
+		for (String part : split)
 		{
-			// if text has <str> - strikethrough - tag then it is already done
+			boolean isDone = part.contains("<str>");
-			stepDone = threeStepText.toString().startsWith("<str>");
+			final String rawText = Text.sanitizeMultilineText(part);
-
-			if (stepDone)
-			{
-				// chop off <str> tag
-				threeStepText.delete(0, 5);
-			}
 
 			for (CrypticClue clue : CrypticClue.CLUES)
 			{
-				if (threeStepText.toString().startsWith(clue.getText().toLowerCase()))
+				if (!rawText.equalsIgnoreCase(clue.getText()))
 				{
-					if (stepDone)
+					continue;
-					{
-						steps.add(new AbstractMap.SimpleEntry<>(clue, true));
-						// chop off </str> tag
-						threeStepText.delete(0, 6);
-					}
-					else
-					{
-						steps.add(new AbstractMap.SimpleEntry<>(clue, false));
-					}
-
-					if (i < CLUE_STEPS - 1)
-					{
-						// chop off the length of the clue text plus a space
-						threeStepText.delete(0, clue.getText().length() + 1);
-					}
-
-					break;
 				}
+
+				steps.add(new AbstractMap.SimpleEntry<>(clue, isDone));
+				break;
 			}
 		}
 
-		if (steps.isEmpty())
+		if (steps.isEmpty() || steps.size() < 3)
 		{
 			return null;
 		}