@deafwave/osrs-botmaker-types 0.3.8 → 0.4.0

package/dist/src/types/sox/api/bot/attackStyle.d.ts

@@ -0,0 +1,12 @@
+
+
+declare namespace bot {
+    interface attackStyle {
+        /**
+         * Sets the current attack style.
+         * @param attackstyle - The array of attack style IDs to set.
+         */
+        setStyle: (attackStyle: number[]) => void;
+    }
+
+}

package/dist/src/types/sox/api/bot/bank.d.ts

@@ -0,0 +1,144 @@
+
+
+declare namespace bot {
+    /**
+     * Represents the interface for interacting with the bank system.
+     */
+    interface bank {
+        /**
+         * Closes the bank interface.
+         */
+        close: () => void;
+
+        /**
+         * Consumes (removes) items from the bank by their IDs.
+         * @param ids - The array of item IDs to consume.
+         * @returns True if the operation was successful, otherwise false.
+         */
+        consumeIds: (ids: number[]) => boolean;
+
+        /**
+         * Consumes (removes) items from the bank by their names.
+         * @param names - The array of item names to consume.
+         * @returns True if the operation was successful, otherwise false.
+         */
+        consumeNames: (names: string[]) => boolean;
+
+        /**
+         * Deposits all items from the inventory into the bank.
+         */
+        depositAll: () => void;
+
+        /**
+         * Deposits all items with the specified ID from the inventory into the bank.
+         * @param id - The item ID to deposit.
+         */
+        depositAllWithId: (id: number) => void;
+
+        /**
+         * Deposits all items with the specified name from the inventory into the bank.
+         * @param name - The item name to deposit.
+         */
+        depositAllWithName: (name: string) => void;
+
+        /**
+         * Deposits a single item with the specified ID from the inventory into the bank.
+         * @param id - The item ID to deposit.
+         */
+        depositWithId: (id: number) => void;
+
+        /**
+         * Deposits a single item with the specified name from the inventory into the bank.
+         * @param name - The item name to deposit.
+         */
+        depositWithName: (name: string) => void;
+
+        /**
+         * Gets the current noted mode status.
+         * @returns True if noted mode is enabled, otherwise false.
+         */
+        getNotedMode: () => boolean;
+
+        /**
+         * Gets the quantities of all specified item IDs in the bank.
+         * @param itemIds - The array of item IDs to check.
+         * @returns An array of quantities corresponding to the provided item IDs.
+         */
+        getQuantityOfAllIds: (itemIds: number[]) => number[];
+
+        /**
+         * Gets the quantities of all specified item names in the bank.
+         * @param itemNames - The array of item names to check.
+         * @returns An array of quantities corresponding to the provided item names.
+         */
+        getQuantityOfAllNames: (itemNames: string[]) => number[];
+
+        /**
+         * Gets the quantity of a specific item ID in the bank.
+         * @param itemId - The item ID to check.
+         * @returns The quantity of the specified item.
+         */
+        getQuantityOfId: (itemId: number) => number;
+
+        /**
+         * Gets the quantity of a specific item name in the bank.
+         * @param itemName - The item name to check.
+         * @returns The quantity of the specified item.
+         */
+        getQuantityOfName: (itemName: string) => number;
+
+        /**
+         * Checks if the player is currently banking.
+         * @returns True if banking, otherwise false.
+         */
+        isBanking: () => boolean;
+
+        /**
+         * Checks if the bank interface is currently open.
+         * @returns True if the bank is open, otherwise false.
+         */
+        isOpen: () => boolean;
+
+        /**
+         * Opens the bank interface.
+         */
+        open: () => void;
+
+        /**
+         * Sets the noted mode for withdrawing items.
+         * @param value - True to enable noted mode, false to disable.
+         */
+        setNotedMode: (value: boolean) => void;
+
+        /**
+         * Withdraws all items with the specified ID from the bank.
+         * @param id - The item ID to withdraw.
+         */
+        withdrawAllWithId: (id: number) => void;
+
+        /**
+         * Withdraws all items with the specified name from the bank.
+         * @param name - The item name to withdraw.
+         */
+        withdrawAllWithName: (name: string) => void;
+
+        /**
+         * Withdraws a specific quantity of an item with the specified ID from the bank.
+         * @param id - The item ID to withdraw.
+         * @param quantity - The quantity to withdraw.
+         */
+        withdrawQuantityWithId: (id: number, quantity: number) => void;
+
+        /**
+         * Withdraws a single item with the specified ID from the bank.
+         * @param id - The item ID to withdraw.
+         */
+        withdrawWithId: (id: number) => void;
+
+        /**
+         * Withdraws a single item with the specified name from the bank.
+         * @param name - The item name to withdraw.
+         */
+        withdrawWithName: (name: string) => void;
+    }
+}

package/dist/src/types/sox/api/bot/bmCache.d.ts

@@ -0,0 +1,54 @@
+
+
+declare namespace bot {
+    /**
+     * Interface for interacting with the Bot Maker's cache system
+     * Allows storing and retrieving persistent data between bot sessions
+     */
+    interface bmCache {
+        /**
+         * Gets a boolean value from the BM cache
+         * @param key The key to retrieve the value for
+         * @param defaultValue The default value to return if the key doesn't exist
+         * @returns The stored boolean value or the default value if not found
+         */
+        getBoolean: (key: string, defaultValue: boolean) => boolean;
+
+        /**
+         * Gets an integer value from the BM cache
+         * @param key The key to retrieve the value for
+         * @param defaultValue The default value to return if the key doesn't exist
+         * @returns The stored integer value or the default value if not found
+         */
+        getInt: (key: string, defaultValue: number) => number;
+
+        /**
+         * Gets a string value from the BM cache
+         * @param key The key to retrieve the value for
+         * @param defaultValue The default value to return if the key doesn't exist
+         * @returns The stored string value or the default value if not found
+         */
+        getString: (key: string, defaultValue: string) => string;
+
+        /**
+         * Saves a boolean value to the BM cache
+         * @param key The key to store the value under
+         * @param value The boolean value to store
+         */
+        saveBoolean: (key: string, value: boolean) => void;
+
+        /**
+         * Saves an integer value to the BM cache
+         * @param key The key to store the value under
+         * @param value The integer value to store
+         */
+        saveInt: (key: string, value: number) => void;
+
+        /**
+         * Saves a string value to the BM cache
+         * @param key The key to store the value under
+         * @param value The string value to store
+         */
+        saveString: (key: string, value: string) => void;
+    }
+}

package/dist/src/types/sox/api/bot/bmGlobalCache.d.ts

@@ -0,0 +1,54 @@
+
+
+declare namespace bot {
+    /**
+     * Interface for interacting with the Bot Maker's cache system
+     * Allows storing and retrieving persistent data between bot sessions
+     */
+    interface bmCache {
+        /**
+         * Gets a boolean value from the BM cache
+         * @param key The key to retrieve the value for
+         * @param defaultValue The default value to return if the key doesn't exist
+         * @returns The stored boolean value or the default value if not found
+         */
+        getBoolean: (key: string, defaultValue: boolean) => boolean;
+
+        /**
+         * Gets an integer value from the BM cache
+         * @param key The key to retrieve the value for
+         * @param defaultValue The default value to return if the key doesn't exist
+         * @returns The stored integer value or the default value if not found
+         */
+        getInt: (key: string, defaultValue: number) => number;
+
+        /**
+         * Gets a string value from the BM cache
+         * @param key The key to retrieve the value for
+         * @param defaultValue The default value to return if the key doesn't exist
+         * @returns The stored string value or the default value if not found
+         */
+        getString: (key: string, defaultValue: string) => string;
+
+        /**
+         * Saves a boolean value to the BM cache
+         * @param key The key to store the value under
+         * @param value The boolean value to store
+         */
+        saveBoolean: (key: string, value: boolean) => void;
+
+        /**
+         * Saves an integer value to the BM cache
+         * @param key The key to store the value under
+         * @param value The integer value to store
+         */
+        saveInt: (key: string, value: number) => void;
+
+        /**
+         * Saves a string value to the BM cache
+         * @param key The key to store the value under
+         * @param value The string value to store
+         */
+        saveString: (key: string, value: string) => void;
+    }
+}

package/dist/src/types/sox/api/bot/breakHandler.d.ts

@@ -0,0 +1,15 @@
+
+
+declare namespace bot {
+    /**
+     * Interface for managing the bot's break handling functionality
+     * Controls whether the bot will take automated breaks
+     */
+    interface breakHandler {
+        /**
+         * Sets the status of the break handler
+         * @param status True to enable the break handler, false to disable it
+         */
+        setBreakHandlerStatus(status: boolean): void;
+    }
+}

package/dist/src/types/sox/api/bot/counters.d.ts

@@ -0,0 +1,23 @@
+
+
+declare namespace bot {
+    /**
+     * Interface for managing numeric counters within the bot
+     * Useful for tracking statistics and progress during bot operation
+     */
+    interface counters {
+        /**
+         * Gets the value of a counter
+         * @param name The name of the counter to retrieve
+         * @returns The current value of the counter
+         */
+        getCounter: (name: string) => number;
+
+        /**
+         * Sets the value of a counter
+         * @param name The name of the counter to set
+         * @param value The value to set the counter to
+         */
+        setCounter: (name: string, value: number) => void;
+    }
+}

package/dist/src/types/sox/api/bot/equipment.d.ts

@@ -0,0 +1,62 @@
+
+
+declare namespace bot {
+    /**
+     * Interface for interacting with the player's equipped items
+     * Provides methods to check and manage equipment
+     */
+    type Item = {
+        id: number;
+        quantity: number;
+    };
+
+    interface equipment {
+        /**
+         * Checks if the player has all the specified items equipped by their IDs
+         * @param ids Array of item IDs to check for
+         * @returns True if all specified items are equipped, false otherwise
+         */
+        containsAllIds: (ids: number[]) => boolean;
+
+        /**
+         * Checks if the player has all the specified items equipped by their names
+         * @param names Array of item names to check for
+         * @returns True if all specified items are equipped, false otherwise
+         */
+        containsAllNames: (names: string[]) => boolean;
+
+        /**
+         * Checks if the player has any of the specified items equipped by their IDs
+         * @param ids Array of item IDs to check for
+         * @returns True if any of the specified items are equipped, false otherwise
+         */
+        containsAnyIds: (ids: number[]) => boolean;
+
+        /**
+         * Checks if the player has any of the specified items equipped by their names
+         * @param names Array of item names to check for
+         * @returns True if any of the specified items are equipped, false otherwise
+         */
+        containsAnyNames: (names: string[]) => boolean;
+
+        /**
+         * Checks if the player has a specific item equipped by its ID
+         * @param id The item ID to check for
+         * @returns True if the item is equipped, false otherwise
+         */
+        containsId: (id: number) => boolean;
+
+        /**
+         * Checks if the player has a specific item equipped by its name
+         * @param name The item name to check for
+         * @returns True if the item is equipped, false otherwise
+         */
+        containsName: (name: string) => boolean;
+
+        /**
+         * Gets an array of all currently equipped items
+         * @returns Array of equipped items
+         */
+        getEquipment: () => Item[];
+    }
+}

package/dist/src/types/sox/api/bot/events.d.ts

@@ -0,0 +1,37 @@
+/// <reference path="../../../runelite/index.d.ts" />
+
+declare namespace bot {
+
+    /**
+     * Interface for handling game events
+     * Extends RuneLite's EventBus to provide event subscription capabilities
+     */
+    interface events extends net.runelite.client.eventbus.EventBus {
+        /**
+         * Posts an event to the event bus, notifying all registered subscribers.
+         * @param event - The event object to be posted.
+         */
+        post: (event: Object) => void;
+
+        /**
+         * Registers a subscriber function to listen for events of the specified class.
+         * @param clazz - The class of the event to subscribe to.
+         * @param subFn - The subscriber function to be called when the event is posted.
+         * @param priority - The priority of the subscriber; higher values are called first.
+         * @returns The created Subscriber instance.
+         */
+        register: (clazz: Class, subFn: Function, priority: number) => Subscriber;
+
+        /**
+         * Unregisters a previously registered subscriber function.
+         * @param object - The subscriber function to be unregistered.
+         */
+        unregister: (object: Function) => void;
+
+        /**
+         * Unregisters all event handlers that have been registered
+         * Useful for cleaning up event listeners when terminating a bot
+         */
+        unregisterAll: () => void;
+    }
+}

package/dist/src/types/sox/api/bot/grandExchange.d.ts

@@ -0,0 +1,67 @@
+/// <reference path="../../../runelite/index.d.ts" />
+
+declare namespace bot {
+    /**
+     * Represents a Grand Exchange buy/sell request
+     */
+    interface ExchangeRequest {
+        /** Aborts the exchange request */
+        abort(): void;
+        /** Gets the ID of the item being bought or sold */
+        getItemId(): number;
+        /** Gets the quantity of the item being bought or sold */
+        getQuantity(): number;
+        /** Gets the slot number used for this exchange request */
+        getSlot(): GrandExchangeOffer;
+        /** Checks if the request has been aborted */
+        isAborted(): boolean;
+        /** Checks if the request is in the process of being aborted */
+        isAborting(): boolean;
+        /** Checks if the request has been completed */
+        isComplete(): boolean;
+        /** Sets the number of attempts for this exchange request */
+        setAttempts(attempts: number): void;
+        /** Sets the maximum number of attempts for this exchange request */
+        setMaxAttempts(maxAttempts: number): void;
+    }
+
+    /**
+     * Interface for interacting with the Grand Exchange
+     * Provides methods to buy/sell items and check GE status
+     * @warning QUEUE DOES NOT CLEAR ON GE ADDTOBUY
+     */
+    interface grandExchange {
+        /**
+         * Adds a buy order to the Grand Exchange queue
+         * @param itemId The ID of the item to buy
+         * @param quantity The quantity of the item to buy
+         * @param walkToAndOpenGE Whether to automatically walk to and open the GE
+         * @returns An ExchangeRequest object representing the buy order
+         */
+        addBuyToQueue: (itemId: number, quantity: number, walkToAndOpenGE: boolean) => net.runelite.api.GrandExchangeOffer;
+
+        /**
+         * Gets the current size of the Grand Exchange queue
+         * @returns The number of requests in the queue
+         */
+        getExchangeQueueSize: () => number;
+
+        /**
+         * Gets the number of free slots in the Grand Exchange
+         * @returns The number of available GE slots
+         */
+        getFreeSlots: () => number;
+
+        /**
+         * Checks if the Grand Exchange is currently processing exchanges
+         * @returns True if exchanges are in progress, false otherwise
+         */
+        isExchanging: () => boolean;
+
+        /**
+         * Checks if the Grand Exchange interface is open
+         * @returns True if the GE is open, false otherwise
+         */
+        isOpen: () => boolean;
+    }
+}

package/dist/src/types/sox/api/bot/graphicsObjects.d.ts

@@ -0,0 +1,16 @@
+/// <reference path="../../../runelite/index.d.ts" />
+
+declare namespace bot {
+    /**
+     * Interface for interacting with in-game graphics objects
+     * Graphics objects include visual effects like spell impacts and animations
+     */
+    interface graphicsObjects {
+        /**
+         * Gets all graphics objects with the specified IDs
+         * @param ids Array of graphics object IDs to search for
+         * @returns Array of matching GraphicsObject instances
+         */
+        getWithIds: (ids: number[]) => net.runelite.api.GraphicsObject[];
+    }
+}

package/dist/src/types/sox/api/bot/index.d.ts

@@ -0,0 +1,128 @@
+/// <reference path="./bank.d.ts" />
+/// <reference path="./bmCache.d.ts" />
+/// <reference path="./bmGlobalCache.d.ts" />
+/// <reference path="./breakHandler.d.ts" />
+/// <reference path="./counters.d.ts" />
+/// <reference path="./equipment.d.ts" />
+/// <reference path="./events.d.ts" />
+/// <reference path="./grandExchange.d.ts" />
+/// <reference path="./graphicsObjects.d.ts" />
+/// <reference path="./inventory.d.ts" />
+/// <reference path="./magic.d.ts" />
+/// <reference path="./menuActions.d.ts" />
+/// <reference path="./net.d.ts" />
+/// <reference path="./notifier.d.ts" />
+/// <reference path="./npcs.d.ts" />
+/// <reference path="./objects.d.ts" />
+/// <reference path="./players.d.ts" />
+/// <reference path="./plugins.d.ts" />
+/// <reference path="./prayer.d.ts" />
+/// <reference path="./projectiles.d.ts" />
+/// <reference path="./task.d.ts" />
+/// <reference path="./tileItems.d.ts" />
+/// <reference path="./types.d.ts" />
+/// <reference path="./variables.d.ts" />
+/// <reference path="./walking.d.ts" />
+/// <reference path="./widgets.d.ts" />
+
+declare namespace bot {
+    // Core methods are accessed directly on the bot object
+    interface SoxBotApi extends bot {
+
+        // Namespaces
+        attackStyle: bot.attackStyle;
+        bank: bot.bank;
+        bmCache: bot.bmCache;
+        bmGlobalCache: bot.bmGlobalCache;
+        breakHandler: bot.breakHandler;
+        counters: bot.counters;
+        equipment: bot.equipment;
+        events: bot.events;
+        grandExchange: bot.grandExchange;
+        graphicsObjects: bot.graphicsObjects;
+        inventory: bot.inventory;
+        magic: bot.magic;
+        net: bot.net;
+        notifier: bot.notifier;
+        npcs: bot.npcs;
+        objects: bot.objects;
+        players: bot.players;
+        plugins: bot.plugins;
+        prayer: bot.prayer;
+        projectiles: bot.projectiles;
+        task: bot.task;
+        tileItems: bot.tileItems;
+        variables: bot.variables;
+        walking: bot.walking;
+        widgets: bot.widgets;
+
+        // Direct methods
+        /**
+         * Performs a menu action.
+         * @param p0 The first parameter for the menu action
+         * @param p1 The second parameter for the menu action
+         * @param action The menu action to perform
+         * @param identifier The identifier for the menu action
+         * @param itemId The item ID for the menu action
+         * @param option The option for the menu action
+         * @param target The target for the menu action
+         * @param bounds The bounds for the menu action
+         */
+        menuAction: {
+            (
+                p0: number,
+                p1: number,
+                action: net.runelite.api.MenuAction,
+                identifier: number,
+                itemId: number,
+                option: string,
+                target: string
+            ): void;
+            (
+                p0: number,
+                p1: number,
+                action: net.runelite.api.MenuAction,
+                identifier: number,
+                itemId: number,
+                option: string,
+                target: string,
+                bounds: java.awt.Rectangle
+            ): void;
+        };
+        /**
+         * Clears the game chat.
+         */
+        clearGameChat: () => void;
+        /**
+         * Checks if the local player is idle.
+         * @returns True if the local player is idle, false otherwise.
+         */
+        localPlayerIdle: () => boolean;
+        /**
+         * Checks if the local player is moving.
+         * @returns True if the local player is moving, false otherwise.
+         */
+        localPlayerMoving: () => boolean;
+        /**
+         * Prints a message to the game chat.
+         * @param message The message to print.
+         */
+        printGameMessage: (message: string) => void;
+        /**
+         * Prints a message to the log.
+         * @param message The message to print.
+         */
+        printLogMessage: (message: string) => void;
+
+        /**
+         * Runs a client script.
+         * @param ints The integer parameters for the script.
+         */
+        runClientScript: (ints: number[]) => void;
+
+        /**
+         * Terminates the bot.
+         */
+        terminate: () => void;
+    }
+}