Bug fixes, Custom method provider, Custom executable improvements, etc. (#83)

- Loads of bug fixes
- Massive improvement to agility activity
- Allow activities to define their own paints
- Introduce custom method provider
- Introduce blocking executable

v3.3.0

Co-authored-by: Explv <[email protected]>

Author: Explv

explvs_aio.iml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module org.jetbrains.idea.maven.project.MavenProjectsManager.isMavenModule="true" type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" LANGUAGE_LEVEL="JDK_1_8">
+    <output url="file://$MODULE_DIR$/target/classes" />
+    <output-test url="file://$MODULE_DIR$/target/test-classes" />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src/main/java" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/src/main/resources" type="java-resource" />
+      <sourceFolder url="file://$MODULE_DIR$/target/generated-sources/annotations" isTestSource="false" generated="true" />
+      <excludeFolder url="file://$MODULE_DIR$/target" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" name="Maven: com.googlecode.json-simple:json-simple:1.1.1" level="project" />
+    <orderEntry type="library" name="Maven: junit:junit:4.10" level="project" />
+    <orderEntry type="library" name="Maven: org.hamcrest:hamcrest-core:1.1" level="project" />
+    <orderEntry type="library" scope="PROVIDED" name="Maven: org.osbot:osbot:0" level="project" />
+  </component>
+</module>

pom.xml

@@ -4,7 +4,7 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
-    <groupId>org.explv.explv_osbot_manager</groupId>
+    <groupId>org.explv</groupId>
     <artifactId>explvs_aio</artifactId>
 
     <!--

src/main/java/activities/activity/Activity.java

@@ -1,10 +1,13 @@
 package activities.activity;
 
 
+import org.osbot.rs07.canvas.paint.Painter;
 import util.Copyable;
-import util.Executable;
+import util.executable.Executable;
 
-public abstract class Activity extends Executable implements Copyable<Activity> {
+import java.awt.*;
+
+public abstract class Activity extends Executable implements Copyable<Activity>, Painter {
 
     private final ActivityType activityType;
     public boolean isComplete = false;
@@ -40,4 +43,7 @@ public void run() throws InterruptedException {
     public String toString() {
         return activityType != null ? String.format("%s : %s", activityType.toString(), status) : "";
     }
+
+    @Override
+    public void onPaint(Graphics2D graphics) {}
 }

src/main/java/activities/banking/Bank.java

@@ -6,7 +6,6 @@
 
 import java.util.Arrays;
 
-// TODO: Check these areas
 public enum Bank {
 
     LUMBRIDGE_CASTLE(new Location("Lumbridge Castle", new Area(3207, 3220, 3209, 3216).setPlane(2))),

src/main/java/activities/banking/Banking.java

@@ -1,19 +1,15 @@
 package activities.banking;
 
 import org.osbot.rs07.api.map.Area;
-import util.Executable;
 import util.Sleep;
-import util.widget.CachedWidget;
-import util.widget.filters.WidgetActionFilter;
+import util.executable.BlockingExecutable;
 
 import java.util.stream.Stream;
 
-public abstract class Banking extends Executable {
+public abstract class Banking extends BlockingExecutable {
 
     private static final Area[] ALL_BANK_AND_DEPOSIT_BOX_AREAS = Stream.concat(Stream.of(Bank.AREAS), Stream.of(DepositBox.AREAS)).toArray(Area[]::new);
 
-    private static final CachedWidget CONTINUE_BANK_INSTRUCTIONS_WIDGET = new CachedWidget(new WidgetActionFilter("Continue"));
-
     private final boolean useDepositBoxes;
 
     protected enum BankType {
@@ -22,7 +18,7 @@ protected enum BankType {
     }
 
     private BankType currentBankType;
-    public boolean succeeded;
+    private boolean finishedBanking;
 
     public Banking() {
         this.useDepositBoxes = false;
@@ -32,10 +28,29 @@ public Banking(final boolean useDepositBoxes) {
         this.useDepositBoxes = useDepositBoxes;
     }
 
+    /**
+     * Override BlockingExecutable::setFinished
+     * to prevent finishing immediately upon a super class
+     * setFinished() call. We need to ensure that the bank is closed
+     * before we end the executable.
+     */
+    @Override
+    public void setFinished() {
+        finishedBanking = true;
+    }
+
     @Override
-    public void run() throws InterruptedException {
-        if (!playerInBank()) {
+    public void blockingRun() throws InterruptedException {
+        if (finishedBanking) {
+            if (isBankOpen()) {
+                closeBank();
+            } else {
+                super.setFinished();
+            }
+        } else if (!playerInBank()) {
             walkToBank();
+        } else if (getInventory().contains("Coin pouch")) {
+            getInventory().getItem("Coin pouch").interact();
         } else if (!isBankOpen()) {
             openBank();
         } else {
@@ -45,11 +60,7 @@ public void run() throws InterruptedException {
                 currentBankType = BankType.DEPOSIT_BOX;
             }
 
-            if (CONTINUE_BANK_INSTRUCTIONS_WIDGET.isVisible(getWidgets())) {
-                CONTINUE_BANK_INSTRUCTIONS_WIDGET.interact(getWidgets(), "Continue");
-            } else {
-                succeeded = bank(currentBankType);
-            }
+            bank(currentBankType);
         }
     }
 
@@ -100,10 +111,8 @@ private void openBank() throws InterruptedException {
 
     /**
      * Execute banking operation
-     *
-     * @return whether the operation was a success or not
      */
-    protected abstract boolean bank(final BankType currentBankType);
+    protected abstract void bank(final BankType currentBankType) throws InterruptedException;
 
     @Override
     public void onEnd() {

src/main/java/activities/banking/DepositAllBanking.java

@@ -26,19 +26,23 @@ public void setExceptItems(final String... exceptItems) {
     }
 
     @Override
-    protected boolean bank(final BankType currentBankType) {
+    protected void bank(final BankType currentBankType) {
+        boolean success;
+
         if (exceptItems == null) {
             if (currentBankType == BankType.DEPOSIT_BOX) {
-                return getDepositBox().depositAll();
+                success = getDepositBox().depositAll();
             } else {
-                return getBank().depositAll();
+                success = getBank().depositAll();
             }
+        } else if (currentBankType == BankType.DEPOSIT_BOX) {
+            success = getDepositBox().depositAllExcept(exceptItems);
+        } else {
+            success = getBank().depositAllExcept(exceptItems);
         }
 
-        if (currentBankType == BankType.DEPOSIT_BOX) {
-            return getDepositBox().depositAllExcept(exceptItems);
-        } else {
-            return getBank().depositAllExcept(exceptItems);
+        if (success) {
+            setFinished();
         }
     }
 }