@deafwave/osrs-botmaker-types 0.3.1 → 0.4.0

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

@@ -0,0 +1,65 @@
+/// <reference path="../../../runelite/index.d.ts" />
+/// <reference path="./types.d.ts" />
+
+declare namespace bot {
+
+    interface TileItemInfo {
+        id: number;
+        name: string;
+        quantity: number;
+        location: net.runelite.api.coords.WorldPoint;
+    }
+    /**
+     * Interface for interacting with items on the ground (tile items)
+     * Provides methods to find and loot items from the ground
+     */
+    interface tileItems {
+        /**
+         * Gets all items on the ground with a value equal to or greater than the specified value
+         * @param value The minimum value of items to find
+         * @returns Array of TileItemInfo objects for items meeting the value criteria
+         */
+        getItemsOfValue: (value: number) => TileItemInfo[];
+
+        /**
+         * Gets all items on the ground that match the specified IDs
+         * @param ids Array of item IDs to match
+         * @returns Array of TileItemInfo objects for matching items
+         */
+        getItemsWithIds: (ids: number[]) => TileItemInfo[];
+
+        /**
+         * Gets all items on the ground that match the specified names
+         * @param names Array of item names to match
+         * @returns Array of TileItemInfo objects for matching items
+         */
+        getItemsWithNames: (names: string[]) => TileItemInfo[];
+
+        /**
+         * Loots a specific item from the ground
+         * @param tileItemInfo The TileItemInfo object representing the item to loot
+         */
+        lootItem: (tileItemInfo: TileItemInfo) => void;
+
+        /**
+         * Loots all items of the specified minimum value within the maximum distance
+         * @param value The minimum value of items to loot
+         * @param maxDistance The maximum distance to loot items from
+         */
+        lootItemsOfValue: (value: number, maxDistance: number) => void;
+
+        /**
+         * Loots all items with the specified IDs within the maximum distance
+         * @param lootIds Array of item IDs to loot
+         * @param maxDistance The maximum distance to loot items from
+         */
+        lootItemsWithIds: (lootIds: number[], maxDistance: number) => void;
+
+        /**
+         * Loots all items with the specified names within the maximum distance
+         * @param lootNames Array of item names to loot
+         * @param maxDistance The maximum distance to loot items from
+         */
+        lootItemsWithNames: (lootNames: string[], maxDistance: number) => void;
+    }
+}

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

@@ -0,0 +1,51 @@
+
+
+declare namespace bot {
+    /**
+     * Interface for managing script variables
+     * Provides methods to get and set various types of variables for script state management
+     */
+    interface variables {
+        /**
+         * Gets a boolean variable by name
+         * @param variableName The name of the variable to retrieve
+         * @returns The boolean value of the variable
+         */
+        getBooleanVariable: (variableName: string) => boolean;
+
+        /**
+         * Gets an array of integers variable by name
+         * @param variableName The name of the variable to retrieve
+         * @returns The array of integers value of the variable
+         */
+        getIntArrayVariable: (variableName: string) => number[];
+
+        /**
+         * Gets an integer variable by name
+         * @param variableName The name of the variable to retrieve
+         * @returns The integer value of the variable
+         */
+        getIntVariable: (variableName: string) => number;
+
+        /**
+         * Gets an array of strings variable by name
+         * @param variableName The name of the variable to retrieve
+         * @returns The array of strings value of the variable
+         */
+        getStringArrayVariable: (variableName: string) => string[];
+
+        /**
+         * Gets a string variable by name
+         * @param variableName The name of the variable to retrieve
+         * @returns The string value of the variable
+         */
+        getStringVariable: (variableName: string) => string;
+
+        /**
+         * Sets a variable of any type by name
+         * @param variableName The name of the variable to set
+         * @param value The value to set the variable to
+         */
+        setVariable: (variableName: string, value: any) => void;
+    }
+}

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

@@ -0,0 +1,65 @@
+/// <reference path="../../../runelite/index.d.ts" />
+
+declare namespace bot {
+    /**
+     * Interface for player movement and navigation
+     * Provides methods to control walking, running, and pathing in the game
+     */
+    interface walking {
+        /**
+         * Gets the calculated path for the current web walking operation
+         * @returns Array of WorldPoint objects representing the calculated path
+         */
+        getWebWalkCalculatedPath: () => net.runelite.api.coords.WorldPoint[];
+
+        /**
+         * Checks if the player is currently using the RLPL web walking system
+         * @returns True if the player is using RLPL web walking, false otherwise
+         */
+        isRlplWebWalking: () => boolean;
+
+        /**
+         * Checks if the player is currently running
+         * @returns True if the player is running, false otherwise
+         */
+        isRunning: () => boolean;
+
+        /**
+         * Checks if the player is currently web walking
+         * @returns True if the player is web walking, false otherwise
+         */
+        isWebWalking: () => boolean;
+
+        /**
+         * Toggles run mode on or off
+         */
+        toggleRun: () => void;
+
+        /**
+         * Walks to a true world point using coordinates
+         * @param x The x-coordinate of the destination
+         * @param y The y-coordinate of the destination
+         * @description Use if you're using a World point provided by the Bot Makers World Point true tile debug
+         */
+        walkToTrueWorldPoint: (x: number, y: number) => void;
+
+        /**
+         * Walks to a world point using coordinates
+         * @param x The x-coordinate of the destination
+         * @param y The y-coordinate of the destination
+         * @description Use if you're walking to a world point that's already provided by the RL API such as localPlayer.getWorldLocation
+         */
+        walkToWorldPoint: (x: number, y: number) => void;
+
+        /**
+         * Cancels the current web walking operation
+         */
+        webWalkCancel: () => void;
+
+        /**
+         * Starts web walking to a specific world point
+         * @param worldPoint The WorldPoint destination to walk to
+         */
+        webWalkStart: (worldPoint: net.runelite.api.coords.WorldPoint) => void;
+    }
+}

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

@@ -0,0 +1,32 @@
+
+
+declare namespace bot {
+    /**
+     * Interface for interacting with UI widgets
+     * Provides methods to interact with game interface elements
+     */
+    interface widgets {
+        /**
+         * Handles dialogue interactions
+         */
+        handleDialogue: (dialogues: []) => boolean;
+
+        /**
+         * Interacts with a specified widget using its ID and parameters
+         * @param packedWidgetId The packed ID of the widget to interact with
+         * @param identifier The identifier for the interaction
+         * @param opcode The operation code for the interaction
+         * @param p0 The first parameter for the interaction
+         * @param p1 The second parameter for the interaction (optional)
+         */
+        interactSpecifiedWidget: {
+            (packedWidgetId: number, identifier: number, opcode: number, p0: number): void;
+            (packedWidgetId: number, identifier: number, opcode: number, p0: number, p1: number): void;
+        };
+        /**
+         * Interacts with a widget by matching its text content
+         * @param text The text to search for in widgets
+         */
+        interactWidgetText: (text: string) => void;
+    }
+}

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

@@ -1,117 +1,4 @@
 /// <reference path="../runelite/index.d.ts" />
+/// <reference path="./bot/index.d.ts" />
 
-declare const bot: SoxBotApi;
-
-interface SoxBotApi {
-	events: net.runelite.client.eventbus.EventBus;
-	bank: {
-		close: () => void;
-		depositAllWithId: (id: number) => void;
-		depositAllWithName: (name: string) => void;
-		depositWithId: (id: number) => void;
-		depositWithName: (name: string) => void;
-		isOpen: () => boolean;
-		withdrawAllWithId: (id: number) => void;
-		withdrawAllWithName: (name: string) => void;
-		withdrawWithId: (id: number) => void;
-		withdrawWithName: (name: string) => void;
-	};
-	bmCache: {
-		getBoolean: (key: string) => boolean;
-		getInt: (key: string) => number;
-		getString: (key: string) => string;
-		saveBoolean: (key: string, value: boolean) => void;
-		saveInt: (key: string, value: number) => void;
-		saveString: (key: string, value: string) => void;
-	};
-	breakHandler: {
-		setBreakHandlerStatus(status: boolean): void;
-	};
-	counters: {
-		getCounter: (name: string) => number;
-		setCounter: (name: string, value: number) => void;
-	};
-	graphicsObjects: {
-		getWithIds: (ids: number[]) => net.runelite.api.GraphicsObject[];
-	};
-	inventory: {
-		interactWithIds: (itemIds: number[], options: string[]) => void;
-		interactWithNames: (itemNames: string[], options: string[]) => void;
-		itemOnItemWithIds: (itemId1: number, itemId2: number) => void;
-		itemOnNpcWithIds: (itemId: number, npc: net.runelite.api.NPC) => void;
-		itemOnObjectWithIds: (itemId: number, tileObject: net.runelite.api.TileObject) => void;
-		itemOnPlayerWithIds: (itemId: number, player: net.runelite.api.Player) => void;
-		itemOnPlayerWithNames: (itemNames: string[], playerNames: string[]) => void;
-	};
-	npcs: {
-		getAnimationID: (npc: net.runelite.api.NPC) => number;
-		getAttackSpeed: (npcId: number) => number;
-		getHeadIcon: (npc: net.runelite.api.NPC) => net.runelite.api.HeadIcon;
-		getWithIds: (ids: number[]) => net.runelite.api.NPC[];
-		getWithNames: (names: string[]) => net.runelite.api.NPC[];
-		interact: (npcName: string, action: string) => void;
-		interactSupplied: (target: net.runelite.api.NPC, action: string) => void;
-	};
-	objects: {
-		getTileObjectComposition: (objectId: number) => net.runelite.api.ObjectComposition;
-		getTileObjectsWithIds: (ids: number[]) => net.runelite.api.TileObject[];
-		getTileObjectsWithNames: (names: string[]) => net.runelite.api.TileObject[];
-		interactObject: (objectName: string, action: string) => void;
-		interactObjects: (objectNames: string[], actions: string[]) => void;
-		interactSuppliedObject: (target: net.runelite.api.TileObject, action: string) => void;
-	};
-	players: {
-		attackPlayer: (names: string[]) => void;
-		followPlayer: (names: string[]) => void;
-		isNearPlayer: (radius: number, names: string[]) => boolean;
-		tradePlayer: (names: string[]) => void;
-	};
-	prayer: {
-		togglePrayer: (prayer: net.runelite.api.Prayer, bypassMouseClicks: boolean) => void;
-	};
-	projectiles: {
-		getProjectilesWithIds: (ids: number[]) => net.runelite.api.Projectile[];
-	};
-	tileItems: {
-		getItemsOfValue: (value: number) => TileItemInfo[];
-		getItemsWithIds: (ids: number[]) => TileItemInfo[];
-		getItemsWithNames: (names: string[]) => TileItemInfo[];
-		lootItem: (tileItemInfo: TileItemInfo) => void;
-		lootItemsOfValue: (value: number, maxDistance: number) => void;
-		lootItemsWithIds: (lootIds: number[], maxDistance: number) => void;
-		lootItemsWithNames: (lootNames: string[], maxDistance: number) => void;
-	};
-	variables: {
-		getBooleanVariable: (variableName: string) => boolean;
-		getIntArrayVariable: (variableName: string) => number[];
-		getIntVariable: (variableName: string) => number;
-		getStringArrayVariable: (variableName: string) => string[];
-		getStringVariable: (variableName: string) => string;
-		setVariable: (variableName: string, value: any) => void;
-	};
-	walking: {
-		isWebWalking: () => boolean;
-		/** Use if you're using a World point provided by the Bot Makers World Point true tile debug */
-		walkToTrueWorldPoint: (x: number, y: number) => void;
-		/** Use if you're walking to a world point thats already provided by the RL API such as localPlayer.getWorldLocation */
-		walkToWorldPoint: (x: number, y: number) => void;
-		webWalkCancel: () => void;
-		webWalkStart: (worldPoint: net.runelite.api.coords.WorldPoint) => void;
-	};
-	widgets: {
-		interactSpecifiedWidget: (packedWidgetId: number, identifier: number, opcode: number, param0: number) => void;
-		interactSpecifiedWidget: (
-			packedWidgetId: number,
-			identifier: number,
-			opcode: number,
-			param0: number,
-			param1: number,
-		) => void;
-		interactWidgetText: (text: string) => void;
-	};
-	clearGameChat: () => void;
-	localPlayerIdle: () => boolean;
-	localPlayerMoving: () => boolean;
-	printGameMessage: (message: string) => void;
-	runClientScript: (ints: number[]) => void;
-}
+declare const bot: bot.SoxBotApi;

package/dist/src/types/sox/api/client.d.ts

@@ -1,3 +1,3 @@
 /// <reference path="../../runelite/index.d.ts" />
 import client = net.runelite.api.Client;
-declare const client: net.runelite.api.Client;
+declare const client: net.runelite.api.Client;

package/dist/src/types/sox/api/clientThread.d.ts

@@ -0,0 +1,24 @@
+/// <reference path="../runelite/index.d.ts" />
+
+/**
+ * Provides methods to schedule and invoke functions on the client thread.
+ */
+declare const clientThread: {
+    /**
+     * Schedules the given BooleanSupplier to be invoked on the client thread.
+     * @param r - A Java BooleanSupplier to be executed.
+     */
+    invoke: (r: java.util.function.BooleanSupplier) => void;
+
+    /**
+     * Schedules the given Runnable to be invoked at the end of the current tick on the client thread.
+     * @param r - A Java Runnable to be executed.
+     */
+    invokeAtTickEnd: (r: java.lang.Runnable) => void;
+
+    /**
+     * Schedules the given BooleanSupplier to be invoked later on the client thread.
+     * @param r - A Java BooleanSupplier to be executed.
+     */
+    invokeLater: (r: java.util.function.BooleanSupplier) => void;
+};

package/dist/src/types/sox/api/configManager.d.ts

@@ -0,0 +1,239 @@
+/// <reference path="../runelite/index.d.ts" />
+
+
+
+/**
+ * The configManager provides methods to get, set, and manage configuration values and profiles.
+ */
+declare const configManager: {
+
+    /**
+     * Constants for RuneScape profiles
+     */
+    RSPROFILE_DISPLAY_NAME: string;
+    RSPROFILE_GROUP: string;
+    RSPROFILE_TYPE: string;
+
+    /**
+     * Retrieves a configuration value as a string or object.
+     * @param groupName - The configuration group name.
+     * @param key - The configuration key.
+     * @returns The configuration value as a string or null.
+     * @overload
+     */
+    getConfiguration: {
+        /**
+        * Retrieves a configuration value as an object of the specified type.
+        * @param groupName - The configuration group name.
+        * @param key - The configuration key.
+        * @returns The configuration value as an object.
+        */
+        (groupName: string, key: string): string | null;
+        /**
+         * Retrieves a configuration value as an object of the specified type.
+         * @param groupName - The configuration group name.
+         * @param key - The configuration key.
+         * @param clazz - The class type to deserialize the value into.
+         * @returns The configuration value as an object.
+         * @overload
+         */
+        (groupName: string, key: string, clazz: Type): object;
+        /**
+         * Retrieves a configuration value for a specific profile as an object of the specified type.
+         * @param groupName - The configuration group name.
+         * @param profile - The profile name.
+         * @param key - The configuration key.
+         * @param type - The class type to deserialize the value into.
+         * @returns The configuration value as an object.
+         * @overload
+         */
+        (groupName: string, profile: string, key: string, type: Type): object;
+    };
+
+    /**
+     * Sets a configuration value.
+     * @param groupName - The configuration group name.
+     * @param key - The configuration key.
+     * @param value - The value to set.
+     * @overload
+     */
+    setConfiguration: {
+        (groupName: string, key: string, value: object | boolean | string): void;
+        /**
+         * Sets a configuration value for a specific profile.
+         * @param groupName - The configuration group name.
+         * @param profile - The profile name.
+         * @param key - The configuration key.
+         * @param value - The value to set.
+         * @overload
+         */
+        (groupName: string, profile: string, key: string, value: object | string | boolean): void;
+    };
+
+    /**
+     * Retrieves a RuneScape profile-specific configuration value as a string or object.
+     * @param groupName - The configuration group name.
+     * @param key - The configuration key.
+     * @returns The configuration value as a string or null.
+     * @overload
+     */
+    getRSProfileConfiguration: {
+        (groupName: string, key: string): string | null;
+        /**
+         * Retrieves a RuneScape profile-specific configuration value as an object of the specified type.
+         * @param groupName - The configuration group name.
+         * @param key - The configuration key.
+         * @param clazz - The class type to deserialize the value into.
+         * @returns The configuration value as an object.
+         * @overload
+         */
+        (groupName: string, key: string, clazz: Type): object;
+    };
+
+    /**
+     * Sets a RuneScape profile-specific configuration value.
+     * @param groupName - The configuration group name.
+     * @param key - The configuration key.
+     * @param value - The value to set.
+     */
+    setRSProfileConfiguration: (groupName: string, key: string, value: object) => void;
+
+    /**
+     * Retrieves the configuration for the specified class.
+     * @param clazz - The class to retrieve configuration for.
+     * @returns The configuration object.
+     */
+    getConfig: (clazz: Class) => object;
+
+    /**
+     * Retrieves the configuration descriptor for the given configuration proxy.
+     * @param configurationProxy - The configuration proxy object.
+     * @returns The configuration descriptor.
+     */
+    getConfigDescriptor: (configurationProxy: Config) => ConfigDescriptor;
+
+    /**
+     * Retrieves a list of configuration keys with the specified prefix.
+     * @param prefix - The prefix to filter configuration keys.
+     * @returns A list of configuration keys.
+     */
+    getConfigurationKeys: (prefix: string) => List;
+
+    /**
+     * Retrieves the current configuration profile.
+     * @returns The current configuration profile.
+     */
+    getProfile: () => ConfigProfile;
+
+    /**
+     * Retrieves the RuneScape profile key.
+     * @returns The RuneScape profile key as a string.
+     */
+    getRSProfileKey: () => string;
+
+    /**
+     * Retrieves a list of RuneScape profile configuration keys for the specified group, profile, and key prefix.
+     * @param group - The configuration group name.
+     * @param profile - The profile name.
+     * @param keyPrefix - The key prefix to filter configuration keys.
+     * @returns A list of configuration keys.
+     */
+    getRSProfileConfigurationKeys: (group: string, profile: string, keyPrefix: string) => List;
+
+    /**
+     * Retrieves a list of all RuneScape profiles.
+     * @returns A list of RuneScape profiles.
+     */
+    getRSProfiles: () => List;
+
+    /**
+     * Constructs the full configuration key for the specified group, profile, and key.
+     * @param groupName - The configuration group name.
+     * @param profile - The profile name.
+     * @param key - The configuration key.
+     * @returns The full configuration key as a string.
+     */
+    getWholeKey: (groupName: string, profile: string, key: string) => string;
+
+    /**
+     * Imports and migrates configuration from a file to the target profile.
+     * @param lock - The profile manager lock.
+     * @param from - The source file to import from.
+     * @param targetProfile - The target configuration profile.
+     */
+    importAndMigrate: (lock: ProfileManager.Lock, from: File, targetProfile: ConfigProfile) => void;
+
+    /**
+     * Indicates whether the configuration manager is currently loading.
+     */
+    isLoading: () => void;
+
+    /**
+     * Registers a callback to be invoked when a session is closed.
+     * @param sessionClose - The session close event handler.
+     */
+    onSessionClose: (sessionClose: SessionClose) => void;
+
+    /**
+     * Registers a callback to be invoked when a session is opened.
+     * @param sessionOpen - The session open event handler.
+     */
+    onSessionOpen: (sessionOpen: SessionOpen) => void;
+
+    /**
+     * Renames the specified configuration profile.
+     * @param profile - The configuration profile to rename.
+     * @param name - The new name for the profile.
+     */
+    renameProfile: (profile: ConfigProfile, name: string) => void;
+
+    /**
+     * Sends the current configuration to the server or other destination.
+     */
+    sendConfig: () => void;
+
+    /**
+     * Sets the default configuration for the specified proxy.
+     * @param proxy - The configuration proxy object.
+     * @param override - Whether to override existing values.
+     */
+    setDefaultConfiguration: (proxy: Config, override: boolean) => void;
+
+    /**
+     * Switches to the specified configuration profile.
+     * @param profile - The configuration profile to switch to.
+     */
+    switchProfile: (profile: ConfigProfile) => void;
+
+    /**
+     * Toggles synchronization for the specified profile.
+     * @param profile - The configuration profile.
+     * @param sync - Whether to enable or disable synchronization.
+     */
+    toggleSync: (profile: ConfigProfile, sync: boolean) => void;
+
+    /**
+     * Unsets a configuration value.
+     * @param groupName - The configuration group name.
+     * @param key - The configuration key.
+     * @overload
+     */
+    unsetConfiguration: {
+        (groupName: string, key: string): void;
+        /**
+         * Unsets a configuration value for a specific profile.
+         * @param groupName - The configuration group name.
+         * @param profile - The profile name.
+         * @param key - The configuration key.
+         * @overload
+         */
+        (groupName: string, profile: string, key: string): void;
+    };
+
+    /**
+     * Unsets a RuneScape profile-specific configuration value.
+     * @param groupName - The configuration group name.
+     * @param key - The configuration key.
+     */
+    unsetRSProfileConfiguration: (groupName: string, key: string) => void;
+};

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

@@ -1,8 +1,5 @@
 /// <reference path="./api/api.d.ts" />
 /// <reference path="./api/bot.d.ts" />
 /// <reference path="./api/client.d.ts" />
-
-declare const configManager: {
-	getConfiguration: (groupName: string, key: string) => string | null;
-	setConfiguration: (groupName: string, key: string, value: string) => void;
-};
+/// <reference path="./api/clientThread.d.ts" />
+/// <reference path="./api/configManager.d.ts" />