add general woodcutting and improve alert system

Author: jort-dev

README.md

@@ -10,7 +10,7 @@ https://user-images.githubusercontent.com/115373370/195444530-a0a17efc-7d8c-4574
 * Fishing & Cooking - Trout & Salmon - Barbarian Village
 
 # Features
-Configuration options:
+Configuration options:  
 ![Settings configuration](/img/settings.png "Copilot configuration options.")
 
 

old/CodeHolder.java

@@ -0,0 +1,8 @@
+package dev.jort.copilot.old;
+
+public class CodeHolder {
+    private final String[] illegalKeywords = {"STUMP", "DISEASED", "DEAD", "BIRDHOUSE",
+            "BAG", "STRONG", "BENCH", "CAPE", "CHAIR", "DECORATION", "DRAWER", "FEEDER",
+            "HOUSE", "OUTFIT", "NOCKS", "WARDROBE", "TROPHY", "TABLE", "CHEST", "STAND",
+            "BRANCH", "DOOR", "PATCH", "CROSSBOW"};
+}

src/main/java/dev/jort/copilot/CopilotConfig.java

@@ -1,6 +1,5 @@
 package dev.jort.copilot;
 
-import net.runelite.api.SoundEffectID;
 import net.runelite.api.SoundEffectVolume;
 import net.runelite.client.config.*;
 
@@ -11,12 +10,11 @@ public interface CopilotConfig extends Config {
 
     @ConfigSection(
             name = "Settings",
-            description = "Set which activity you want assistance with. Only one selected item works.",
+            description = "Configure settings which apply to all helpers.",
             position = 0
     )
     String settingsSection = "Settings";
 
-
     @Range(
             max = SoundEffectVolume.HIGH
     )
@@ -32,13 +30,24 @@ default int alertVolume() {
     }
 
     @ConfigItem(
-            keyName = "soundId",
+            keyName = "mainSoundId",
             name = "Alert sound ID",
             description = "Configures the sound to play for alerts. For inspiration: search 'sound id osrs'.",
             section = settingsSection,
             position = 2
     )
-    default int soundId() {
+    default int mainSoundId() {
+        return 3929;
+    }
+
+    @ConfigItem(
+            keyName = "alternativeSoundId",
+            name = "Alt alert sound ID",
+            description = "Configures the sound to play when the inventory is full. Set to 0 to disable.",
+            section = settingsSection,
+            position = 3
+    )
+    default int alternativeSoundId() {
         return 1959;
     }
 
@@ -47,7 +56,7 @@ default int soundId() {
             name = "Alert delay",
             description = "Configure after how many milliseconds of inactivity the alert go off.",
             section = settingsSection,
-            position = 3
+            position = 4
     )
     default int alertDelayMs() {
         return 1000;
@@ -61,7 +70,7 @@ default int alertDelayMs() {
             position = 4
     )
     default int amountOfSoundAlerts() {
-        return 3;
+        return 5;
     }
 
 
@@ -71,7 +80,7 @@ default int amountOfSoundAlerts() {
             name = "Notification color",
             description = "Set the notification overlay color",
             section = settingsSection,
-            position = 5
+            position = 6
     )
     default Color overlayColor() {
         return new Color(1.0f, 0.0f, 0.0f, 0.1f);
@@ -83,7 +92,7 @@ default Color overlayColor() {
             name = "Highlight color",
             description = "Set the color of the highlight for items to click.",
             section = settingsSection,
-            position = 6
+            position = 7
     )
     default Color highlightColor() {
         return new Color(0.0f, 1.0f, 1.0f, 0.2f);
@@ -92,41 +101,30 @@ default Color highlightColor() {
     @ConfigSection(
             name = "Activities",
             description = "Set which activity you want assistance with. Only one selected item works.",
-            position = 7
+            position = 8
     )
     String activitiesSection = "Activities";
 
     @ConfigItem(
-            keyName = "willowsDraynor",
-            name = "Willows @ Draynor bank",
-            description = "Chop down and bank willows next to the bank in Draynor Village.",
+            keyName = "woodcuttingGeneral",
+            name = "Woodcutting",
+            description = "Highlights trees, logs and banks.",
             section = activitiesSection,
-            position = 8
+            position = 9
 
     )
-    default boolean willowsDraynor() {
+    default boolean woodcutting() {
         return false;
     }
 
     @ConfigItem(
             keyName = "fishingBarbarianVillage",
-            name = "Fishing & Cooking @ Barbarians",
+            name = "Fishing and Cooking at Barbarians",
             description = "Fish trout and salmon at Barbarian Village, cook it and then drop it.",
             section = activitiesSection,
-            position = 9
-    )
-    default boolean fishingBarbarian() {
-        return false;
-    }
-
-    @ConfigItem(
-            keyName = "yewsWoodcuttingGuild",
-            name = "Yews @ Woodcutting Guild",
-            description = "Chop down and bank yew trees at the Woodcutting Guild",
-            section = activitiesSection,
             position = 10
     )
-    default boolean yewsGuild() {
+    default boolean fishingBarbarian() {
         return false;
     }
 }

src/main/java/dev/jort/copilot/CopilotPlugin.java

@@ -6,10 +6,12 @@
 import dev.jort.copilot.scripts.FishingBarbarian;
 import dev.jort.copilot.other.Script;
 import dev.jort.copilot.scripts.WillowsDraynor;
+import dev.jort.copilot.scripts.Woodcutting;
 import dev.jort.copilot.scripts.YewsWoodcuttingGuild;
 import lombok.extern.slf4j.Slf4j;
 import net.runelite.api.ChatMessageType;
 import net.runelite.api.Client;
+import net.runelite.api.GameState;
 import net.runelite.api.InventoryID;
 import net.runelite.api.events.*;
 import net.runelite.client.callback.ClientThread;
@@ -25,6 +27,7 @@
 import javax.inject.Inject;
 import java.time.temporal.ChronoUnit;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 
 @Slf4j
@@ -82,6 +85,8 @@ public class CopilotPlugin extends Plugin {
     FishingBarbarian fishingBarbarian;
     @Inject
     YewsWoodcuttingGuild yewsWoodcuttingGuild;
+    @Inject
+    Woodcutting woodcutting;
 
     Script runningScript = null;
 
@@ -106,8 +111,9 @@ protected void startUp() throws Exception {
         }
 
         //initialize scripts which require arguments
-        yewsWoodcuttingGuild.initialize(ids.BANK_CHEST_IDS, new int[]{ids.YEW_LOGS}, ids.YEW_TREE_IDS);
-        willowsDraynor.initialize(new int[]{ids.BANK_BOOTH}, new int[]{ids.WILLOW_LOGS}, ids.WILLOW_TREE_IDS);
+//        yewsWoodcuttingGuild.initialize(ids.BANK_CHEST_IDS, new int[]{ids.YEW_LOGS}, ids.YEW_TREE_IDS);
+//        willowsDraynor.initialize(new int[]{ids.BANK_BOOTH}, new int[]{ids.WILLOW_LOGS}, ids.WILLOW_TREE_IDS);
+        woodcutting.initialize();
     }
 
     @Override
@@ -185,15 +191,15 @@ public void setOverlaysEnabled(boolean enable) {
     @Subscribe
     public void onGameTick(GameTick event) {
         tracker.onGameTick(event);
-        if (config.willowsDraynor()) {
-            willowsDraynor.loop();
-            runningScript = willowsDraynor;
+        if (!client.getGameState().equals(GameState.LOGGED_IN)) {
+            return;
+        }
+        if (config.woodcutting()) {
+            woodcutting.loop();
+            runningScript = woodcutting;
         } else if (config.fishingBarbarian()) {
             fishingBarbarian.loop();
             runningScript = fishingBarbarian;
-        } else if (config.yewsGuild()) {
-            yewsWoodcuttingGuild.loop();
-            runningScript = yewsWoodcuttingGuild;
         } else {
             setOverlaysEnabled(false);
         }
@@ -202,6 +208,7 @@ public void onGameTick(GameTick event) {
     @Subscribe
     public void onMenuOptionClicked(MenuOptionClicked event) {
         tracker.onMenuOptionClicked(event);
+        woodcutting.onMenuOptionClicked(event);
     }
 
     @Subscribe

src/main/java/dev/jort/copilot/helpers/Alert.java

@@ -17,6 +17,9 @@ public class Alert {
     @Inject
     Client client;
 
+    @Inject
+    Inventory inventory;
+
     @Inject
     CopilotConfig config;
 
@@ -30,27 +33,28 @@ public class Alert {
     EntityOverlay entityOverlay;
 
     int soundAlertsPlayed = 0;
-    boolean previousAlertNeeded = false;
+    boolean previousInteractionNeeded = false;
     long alertStartTime = -1;
 
 
-    public void handleAlert(boolean alertNeeded) {
+    public void handleAlert(boolean interactionNeeded) {
         //if this is the first time alerting, needed for the alert delay
-        if (!previousAlertNeeded) {
+        if (!previousInteractionNeeded) {
             alertStartTime = System.currentTimeMillis();
         }
-        previousAlertNeeded = alertNeeded;
+        previousInteractionNeeded = interactionNeeded;
+
 
         //always disable visual overlay when no alert is needed
-        if (!alertNeeded) {
+        if (!interactionNeeded) {
             notificationOverlay.disable();
             soundAlertsPlayed = 0;
             alertStartTime = -2;
             return;
         }
 
-        //ignore if we are awaiting the alert delay
-        if (System.currentTimeMillis() - alertStartTime < config.alertDelayMs()) {
+        //ignore if interacted recently
+        if (Math.max(client.getMouseLastPressedMillis(), alertStartTime) + config.alertDelayMs() > System.currentTimeMillis()) {
             return;
         }
 
@@ -63,15 +67,27 @@ public void handleAlert(boolean alertNeeded) {
         }
 
         //play sound alert
-        playAlertSound();
+        if (inventory.isFull()) {
+            playAlternativeAlertSound();
+        } else {
+            playAlertSound();
+        }
         soundAlertsPlayed++;
     }
 
     public void playAlertSound() {
-        playSound(config.soundId());
+        playSound(config.mainSoundId());
+    }
+
+    public void playAlternativeAlertSound() {
+        if (config.alternativeSoundId() == 0) { //set to 0 disables it
+            playAlertSound();
+            return;
+        }
+        playSound(config.alternativeSoundId());
     }
 
-    public void playSound(int id){
+    public void playSound(int id) {
         Preferences preferences = client.getPreferences();
         int previousVolume = preferences.getSoundEffectVolume();
         int volume = config.alertVolume();

src/main/java/dev/jort/copilot/helpers/GameObjects.java

@@ -4,6 +4,7 @@
 import net.runelite.api.Client;
 import net.runelite.api.GameObject;
 import net.runelite.api.GameState;
+import net.runelite.api.Perspective;
 import net.runelite.api.coords.WorldPoint;
 import net.runelite.api.events.GameObjectDespawned;
 import net.runelite.api.events.GameObjectSpawned;
@@ -12,6 +13,7 @@
 import javax.inject.Inject;
 import javax.inject.Singleton;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 import java.util.function.Predicate;
 
@@ -28,7 +30,17 @@ public void add(GameObject gameObject) {
         if (gameObjects.contains(gameObject)) {
             return;
         }
-        gameObjects.add(gameObject);
+
+        String[] actions = client.getObjectDefinition(gameObject.getId()).getActions();
+
+
+        for (String action : actions) {
+            if (action != null) {
+                //dont add gameobject which are not interactable, to prevent fake bank booths for example
+                gameObjects.add(gameObject);
+                return;
+            }
+        }
     }
 
     public void remove(GameObject gameObject) {
@@ -39,6 +51,9 @@ public GameObject closest(int... ids) {
         if (gameObjects.isEmpty()) {
             return null;
         }
+        if (ids == null) { // seems to happen at startup in render
+            return null;
+        }
         GameObject closest = null;
         WorldPoint myLocation = client.getLocalPlayer().getWorldLocation();
         for (GameObject gameObject : gameObjects) {
@@ -69,7 +84,7 @@ public void onGameObjectDespawned(GameObjectDespawned event) {
     }
 
     public void onGameStateChanged(GameStateChanged gameStateChanged) {
-        if(gameStateChanged.getGameState().equals(GameState.LOADING)){
+        if (gameStateChanged.getGameState().equals(GameState.LOADING)) {
             gameObjects.clear();
         }
     }