Add gate to dispatch API (#96)

darkbot-reloaded · Mar 6, 2024 · 5c3449b · 5c3449b
1 parent 8971925
commit 5c3449b
Showing 1 changed file with 50 additions and 0 deletions.
diff --git a/api/src/main/java/eu/darkbot/api/managers/DispatchAPI.java b/api/src/main/java/eu/darkbot/api/managers/DispatchAPI.java
@@ -39,6 +39,11 @@ public interface DispatchAPI extends API.Singleton {
      */
     Retriever getSelectedRetriever();
 
+    /**
+     * @return The {@code List} of all available gates
+     */
+    List<? extends Gate> getAvailableGates();
+
     /**
      * In game retriever representation, includes name, in game name, type, duration &amp; slot id
      */
@@ -95,6 +100,51 @@ interface Retriever {
         Cost getInstantCost();
     }
 
+    /**
+     * In game gate representation, includes name, in game name, type, duration &amp; slot id
+     */
+    interface Gate {
+        /**
+         * @return status
+         */
+        int getStatus();
+
+        /**
+         * @return gate Id
+         */
+        int getGateId();
+
+        /**
+         * @return the time to build
+         */
+        int getDuration();
+
+        /**
+         * @return the time left to complete
+         */
+        double getTimeLeft();
+
+        /**
+         * @return gate dispatch id
+         */
+        String getDispatchId();
+
+        /**
+         * @return in game variable name
+         */
+        String getIconId();
+
+        /**
+         * @return game name
+         */
+        String getName();
+
+        /**
+         * @return cost for the gate
+         */
+        Cost getCost();
+    }
+
     /**
      * In game representation of cost of retriever
      */