Toggle for ChestSearch

Author: cev-api

README.md

@@ -164,7 +164,7 @@ I did not, nor could I copy their code directly as most are Meteor based mods. S
 ![WayPoints](https://i.imgur.com/dxFc17N.png) ![Waypoint Manager](https://i.imgur.com/K2xGVqc.png) ![Waypoint Editor](https://i.imgur.com/23i14s1.png)
 
 ### Chest Search
-- Automatically or manually scan each chest you open and store its contents in a JSON file per server
+- Automatically or manually scan each chest you open and store its contents in a JSON file per server (You can also disable entirely)
  - Able to detect chest changes that you make, so adding or removing items instantly updates the JSON
  - Unable to detect chest changes that other players make
  - Able to delete entries

src/main/java/net/wurstclient/hacks/ChestSearchHack.java

@@ -10,6 +10,7 @@
 import net.wurstclient.Category;
 import net.wurstclient.hack.Hack;
 import net.wurstclient.settings.ColorSetting;
+import net.wurstclient.settings.EnumSetting;
 import net.wurstclient.settings.SliderSetting;
 import net.wurstclient.settings.SliderSetting.ValueDisplay;
 import net.wurstclient.settings.CheckboxSetting;
@@ -18,9 +19,10 @@ public final class ChestSearchHack extends Hack
 {
 	private static final int DISPLAY_RADIUS_UNLIMITED = 2001;
 
-	private final net.wurstclient.settings.CheckboxSetting automaticMode =
-		new net.wurstclient.settings.CheckboxSetting("Automatic mode",
-			"Automatically scan chests on open.", true);
+	private final EnumSetting<Mode> modeSetting = new EnumSetting<>("Mode",
+		"Automatic scans instantly, Manual requires pressing the Scan button,"
+			+ " and Off disables ChestSearch entirely.",
+		Mode.values(), Mode.AUTOMATIC);
 	private final SliderSetting waypointTimeSec = new SliderSetting(
 		"Waypoint time (s)", 60, 5, 600, 5, ValueDisplay.INTEGER);
 	private final SliderSetting espTimeSec =
@@ -59,7 +61,7 @@ public ChestSearchHack()
 		setCategory(Category.ITEMS);
 		// automatic/manual toggle should appear above the timeouts in the
 		// clickui so add it first
-		addSetting(automaticMode);
+		addSetting(modeSetting);
 		addSetting(waypointTimeSec);
 		addSetting(espTimeSec);
 		// expose cleaner settings in navigator so user can tune them
@@ -130,7 +132,29 @@ public int getWaypointTimeMs()
 
 	public boolean isAutomaticMode()
 	{
-		return automaticMode.isChecked();
+		return getMode() == Mode.AUTOMATIC;
+	}
+	
+	public boolean isManualMode()
+	{
+		return getMode() == Mode.MANUAL;
+	}
+	
+	public boolean isOffMode()
+	{
+		return getMode() == Mode.OFF;
+	}
+	
+	public Mode getMode()
+	{
+		try
+		{
+			Mode mode = modeSetting.getSelected();
+			return mode != null ? mode : Mode.AUTOMATIC;
+		}catch(Throwable t)
+		{
+			return Mode.AUTOMATIC;
+		}
 	}
 
 	public int getEspTimeMs()
@@ -175,4 +199,24 @@ protected void onEnable()
 		{}
 		setEnabled(false);
 	}
+	
+	public enum Mode
+	{
+		AUTOMATIC("Automatic"),
+		MANUAL("Manual"),
+		OFF("Off");
+		
+		private final String displayName;
+		
+		private Mode(String displayName)
+		{
+			this.displayName = displayName;
+		}
+		
+		@Override
+		public String toString()
+		{
+			return displayName;
+		}
+	}
 }

src/main/java/net/wurstclient/mixin/GenericContainerScreenMixin.java

@@ -41,6 +41,7 @@
 import net.wurstclient.chestsearch.ChestRecorder;
 import net.wurstclient.clickgui.screens.ChestSearchScreen;
 import net.wurstclient.hacks.AutoStealHack;
+import net.wurstclient.hacks.ChestSearchHack;
 import net.wurstclient.hacks.QuickShulkerHack;
 
 @Mixin(ContainerScreen.class)
@@ -93,6 +94,7 @@ public void init()
 		super.init();
 		if(!WurstClient.INSTANCE.isEnabled())
 			return;
+		final ChestSearchHack chestSearchHack = wurst$getChestSearchHack();
 		if(autoSteal.areButtonsVisible())
 		{
 			addRenderableWidget(Button
@@ -130,13 +132,11 @@ public void init()
 		// ChestSearch hack settings.
 		try
 		{
-			net.wurstclient.hacks.ChestSearchHack csh =
-				WurstClient.INSTANCE.getHax().chestSearchHack;
-			boolean showScan = true;
+			boolean showScan = false;
 			try
 			{
-				if(csh != null)
-					showScan = !csh.isAutomaticMode();
+				if(chestSearchHack != null)
+					showScan = chestSearchHack.isManualMode();
 			}catch(Throwable ignored)
 			{}
 			if(showScan)
@@ -149,6 +149,13 @@ public void init()
 		// Attempt to record the chest contents when the container screen opens.
 		try
 		{
+			try
+			{
+				if(chestSearchHack != null && chestSearchHack.isOffMode())
+					return;
+			}catch(Throwable ignored)
+			{}
+			
 			ChestConfig cfg = new ChestConfig();
 			if(!cfg.enabled)
 				return;
@@ -628,11 +635,8 @@ else if(inv != null
 						{
 							try
 							{
-								net.wurstclient.hacks.ChestSearchHack csh =
-									WurstClient.INSTANCE
-										.getHax().chestSearchHack;
-								boolean doAuto =
-									csh == null || csh.isAutomaticMode();
+								boolean doAuto = chestSearchHack == null
+									|| chestSearchHack.isAutomaticMode();
 								if(doAuto)
 								{
 									int px =
@@ -705,11 +709,8 @@ else if(inv != null
 								}
 								try
 								{
-									net.wurstclient.hacks.ChestSearchHack csh =
-										WurstClient.INSTANCE
-											.getHax().chestSearchHack;
-									boolean doAuto =
-										csh == null || csh.isAutomaticMode();
+									boolean doAuto = chestSearchHack == null
+										|| chestSearchHack.isAutomaticMode();
 									if(doAuto)
 									{
 										int px =
@@ -759,10 +760,8 @@ else if(inv != null
 								// automatic mode)
 								try
 								{
-									net.wurstclient.hacks.ChestSearchHack csh =
-										WurstClient.INSTANCE
-											.getHax().chestSearchHack;
-									if(csh == null || csh.isAutomaticMode())
+									if(chestSearchHack == null
+										|| chestSearchHack.isAutomaticMode())
 										chestRecorder.onChestOpened(fServerIp,
 											fDimension,
 											GenericContainerScreenMixin.this.clickedX,
@@ -799,9 +798,8 @@ else if(inv != null
 				this.chestSlotOrder = new java.util.ArrayList<>(slotOrder);
 				try
 				{
-					net.wurstclient.hacks.ChestSearchHack csh =
-						WurstClient.INSTANCE.getHax().chestSearchHack;
-					if(csh == null || csh.isAutomaticMode())
+					if(chestSearchHack == null
+						|| chestSearchHack.isAutomaticMode())
 						chestRecorder.onChestOpened(fServerIp, fDimension,
 							GenericContainerScreenMixin.this.clickedX,
 							GenericContainerScreenMixin.this.clickedY,
@@ -857,11 +855,8 @@ public void run()
 						{
 							try
 							{
-								net.wurstclient.hacks.ChestSearchHack csh =
-									WurstClient.INSTANCE
-										.getHax().chestSearchHack;
-								boolean doAuto =
-									csh == null || csh.isAutomaticMode();
+								boolean doAuto = chestSearchHack == null
+									|| chestSearchHack.isAutomaticMode();
 								if(doAuto)
 								{
 									int px =
@@ -1291,6 +1286,18 @@ public void removed()
 		{}
 	}
 
+	@Unique
+	private ChestSearchHack wurst$getChestSearchHack()
+	{
+		try
+		{
+			return WurstClient.INSTANCE.getHax().chestSearchHack;
+		}catch(Throwable ignored)
+		{
+			return null;
+		}
+	}
+	
 	@Unique
 	private BlockPos wurst$normalizeContainerPos(BlockPos pos)
 	{