Create ShipWarpAPI.java

api/src/main/java/eu/darkbot/api/managers/ShipWarpAPI.java

@@ -0,0 +1,66 @@
+package eu.darkbot.api.managers;
+
+import eu.darkbot.api.API;
+
+import java.util.List;
+
+/**
+ * Provide access to Ship Warp data
+ */
+public interface ShipWarpAPI extends API.Singleton{
+
+    /**
+     * Open's ship warp window to update proxy data
+     */
+    void updateShipList();
+
+    /**
+     * @return if Ship is near a station to warp for free
+     */
+    boolean isNearSpaceStation();
+
+    /**
+     * @return The {@code List} of all warp able ship that are favorite
+     */
+    List<? extends Ship> getShips();
+
+    /**
+     * In Game Ship representation to warp to
+     */
+    interface Ship {
+        /**
+         * @return ship id, this value is unique
+         */
+        int getShipId();
+
+        /**
+         * @return the cost to warp at current location
+         */
+        int getWarpCost();
+
+        /**
+         * @return if warping is free at current location
+         */
+        boolean isFreeWarp();
+
+        /**
+         * @return the index of favorite order
+         */
+        int getFavouriteIndex();
+
+        /**
+         * @return the mapId of where ship is located
+         */
+        int getMapId();
+
+        /**
+         * @return the ship type id
+         */
+        String getShipTypeId();
+
+        /**
+         * @return the full ship name
+         */
+        String getShipName();
+    }
+}