### On Start Method Override Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/events/loadout/EquipmentLoadoutEvent Handles the initialization logic when the equipment loadout event starts. This method overrides the default behavior from AbstractEvent. ```java public void onStart() ``` -------------------------------- ### SkillTracker Start Methods Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/listeners/skill/SkillTracker Provides methods to initiate skill tracking. This includes starting tracking for all available skills, a single specified skill, or multiple skills at once. ```Java public static void start() ``` ```Java public static void start(Skill skill) ``` ```Java public static void start(Skill... skills) ``` -------------------------------- ### SkillTracker Get Start Experience Method Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/listeners/skill/SkillTracker Retrieves the initial experience points for a specified skill. Returns 0 if the skill tracker is null. ```Java public static int getStartExperience(Skill skill) ``` -------------------------------- ### Get Start Y Coordinate - Java Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/wrappers/interactives/GameObject Retrieves the starting Y-coordinate of a region or object. This is useful for defining boundaries. ```java public int getStartY() ``` -------------------------------- ### Overview Page Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/help-doc The main entry point of the API documentation, listing all packages with summaries. ```APIDOC ## Overview ### Description The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages. ### Method N/A ### Endpoint N/A ``` -------------------------------- ### Get Start X Coordinate - Java Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/wrappers/interactives/GameObject Retrieves the starting X-coordinate of a region or object. This is useful for defining boundaries. ```java public int getStartX() ``` -------------------------------- ### StartTaskResult Class Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalfarm/client/result/StartTaskResult This section details the StartTaskResult class, its constructors, and available methods. ```APIDOC ## StartTaskResult Class ### Description Represents the result of a task, indicating success or failure. ### Methods #### Constructor Summary - `StartTaskResult()`: Initializes a new instance of the `StartTaskResult` class. #### Method Summary - `isSuccess()` (boolean): Checks if the task was successful. - `setSuccess(boolean success)`: Sets the success status of the task. - `equals(Object o)` (boolean): Compares this `StartTaskResult` instance with another object for equality. - `canEqual(Object other)` (boolean): Determines whether another object can be equal to this instance. - `hashCode()` (int): Returns a hash code value for the `StartTaskResult` instance. - `toString()` (String): Returns a string representation of the `StartTaskResult` instance. ### Constructor Detail #### StartTaskResult ```java public StartTaskResult() ``` ### Method Detail #### isSuccess ```java public boolean isSuccess() ``` #### setSuccess ```java public void setSuccess(boolean success) ``` #### equals ```java public boolean equals(Object o) ``` Overrides: `equals` in class `java.lang.Object` #### canEqual ```java protected boolean canEqual(Object other) ``` #### hashCode ```java public int hashCode() ``` Overrides: `hashCode` in class `java.lang.Object` #### toString ```java public String toString() ``` Overrides: `toString` in class `java.lang.Object` ``` -------------------------------- ### SkillTracker Get Start Level Method Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/listeners/skill/SkillTracker Returns the starting level for a given skill. Returns 0 if the skill is not currently being tracked. ```Java public static long getStartLevel(Skill skill) ``` -------------------------------- ### SkillTracker Get Start Time Method Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/listeners/skill/SkillTracker Retrieves the start time for a specified skill's tracking. Returns 0 if the tracker for the skill is not found. ```Java public static long getStartTime(Skill skill) ``` -------------------------------- ### EquipmentLoadoutEvent Lifecycle Methods Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/events/loadout/EquipmentLoadoutEvent Methods related to the event lifecycle, including starting and looping. ```APIDOC ## EquipmentLoadoutEvent Lifecycle Methods ### Description Methods that control the execution flow of the event. ### Method INSTANCE ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example ```java EquipmentLoadoutEvent event = ...; // Assume an initialized event // Executes when the event starts event.onStart(); // Called repeatedly during the event's execution loop int loopResult = event.onLoop(); ``` ### Response #### Success Response (200) - **onStart()** (void) - Called when the event begins execution. Overrides AbstractEvent.onStart. - **onLoop()** (int) - The main loop method for the event. Returns an integer representing the next action or delay. #### Response Example N/A ``` -------------------------------- ### Get Valid Starting Positions (Java) Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/wrappers/walking/teleports/Teleport Retrieves a list of all valid starting positions within the game environment. This method is crucial for initializing player or NPC placements. ```java public static java.util.List getValidStartingPositions() ``` -------------------------------- ### ClientInstance Constructor Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/wrappers/clientinstance/ClientInstance Initializes a new ClientInstance object with comprehensive game state information. ```APIDOC ## ClientInstance Constructor ### Description Initializes a new ClientInstance object with comprehensive game state information. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example ```java public ClientInstance( java.lang.String clientID, java.lang.String script, int gameState, int loginState, java.lang.String username, java.lang.String displayName, int worldID, int positionX, int positionY, int positionPlane, int totalLevel, int questPoints, int combatLevel, java.util.Map skillLevels, java.util.Map boostedSkillLevels, java.util.Map inventoryItems, java.util.Map equipmentItems, java.util.Map bankItems, java.util.Map questStates ) ``` ``` -------------------------------- ### Task Management API Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalfarm/client/EternalFarmClient This section covers endpoints for managing tasks, including retrieving lists of tasks, getting individual tasks, creating, updating, deleting, starting, and stopping tasks. ```APIDOC ## GET /api/tasks ### Description Retrieves a paginated list of tasks with optional filters. ### Method GET ### Endpoint /api/tasks ### Parameters #### Query Parameters - **page** (int) - Required - The page number to retrieve. - **perPage** (int) - Required - The number of items per page. - **filters** (Map) - Optional - A map of filters to apply to the task list. ### Response #### Success Response (200) - **PageResult** - An object containing the paginated task results. #### Response Example ```json { "content": [ { "taskId": 1, "status": "RUNNING" } ], "totalPages": 10, "totalElements": 100 } ``` ``` ```APIDOC ## GET /api/tasks/{id} ### Description Retrieves a specific task by its ID. ### Method GET ### Endpoint /api/tasks/{id} ### Parameters #### Path Parameters - **id** (int) - Required - The ID of the task to retrieve. ### Response #### Success Response (200) - **GetResult** - An object containing the requested task. #### Response Example ```json { "result": { "taskId": 1, "status": "RUNNING" } } ``` ``` ```APIDOC ## POST /api/tasks ### Description Creates a new task. ### Method POST ### Endpoint /api/tasks ### Parameters #### Request Body - **task** (EFTask) - Required - The task object to create. ### Request Example ```json { "task": { "taskId": 0, "status": "PENDING" } } ``` ### Response #### Success Response (200) - **CreateResult** - An object containing the result of the task creation. #### Response Example ```json { "result": { "taskId": 2, "status": "PENDING" }, "success": true } ``` ``` ```APIDOC ## PUT /api/tasks ### Description Updates an existing task. ### Method PUT ### Endpoint /api/tasks ### Parameters #### Request Body - **task** (EFTask) - Required - The task object to update. ### Request Example ```json { "task": { "taskId": 1, "status": "COMPLETED" } } ``` ### Response #### Success Response (200) - **UpdateResult** - An object containing the result of the task update. #### Response Example ```json { "result": { "taskId": 1, "status": "COMPLETED" }, "success": true } ``` ``` ```APIDOC ## DELETE /api/tasks ### Description Deletes a task. ### Method DELETE ### Endpoint /api/tasks ### Parameters #### Request Body - **task** (EFTask) - Required - The task object to delete. ### Request Example ```json { "task": { "taskId": 1, "status": "COMPLETED" } } ``` ### Response #### Success Response (200) - **DeleteResult** - An object containing the result of the task deletion. #### Response Example ```json { "success": true } ``` ``` ```APIDOC ## POST /api/tasks/start ### Description Starts a task on a specific agent and account. ### Method POST ### Endpoint /api/tasks/start ### Parameters #### Request Body - **task** (EFTask) - Required - The task to start. - **agentId** (int) - Required - The ID of the agent to run the task on. - **accountId** (int) - Required - The ID of the account associated with the task. ### Request Example ```json { "task": { "taskId": 1, "status": "RUNNING" }, "agentId": 101, "accountId": 201 } ``` ### Response #### Success Response (200) - **StartTaskResult** - An object containing the result of starting the task. #### Response Example ```json { "success": true, "message": "Task started successfully" } ``` ``` ```APIDOC ## POST /api/tasks/stop ### Description Stops a running task on a specific agent and account. ### Method POST ### Endpoint /api/tasks/stop ### Parameters #### Request Body - **task** (EFTask) - Required - The task to stop. - **agentId** (int) - Required - The ID of the agent the task is running on. - **accountId** (int) - Required - The ID of the account associated with the task. ### Request Example ```json { "task": { "taskId": 1, "status": "RUNNING" }, "agentId": 101, "accountId": 201 } ``` ### Response #### Success Response (200) - **StopTaskResult** - An object containing the result of stopping the task. #### Response Example ```json { "success": true, "message": "Task stopped successfully" } ``` ``` -------------------------------- ### EquipmentLoadoutItem Constructors Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/events/loadout/EquipmentLoadoutItem Provides documentation for the different ways to construct an EquipmentLoadoutItem object. ```APIDOC ## EquipmentLoadoutItem Constructors This section details the various constructors available for the EquipmentLoadoutItem class. ### Constructor Overloads - **EquipmentLoadoutItem(int id, int min, int max)** - Description: Constructs an EquipmentLoadoutItem with a specific ID, minimum, and maximum value. - Parameters: - `id` (int) - The unique identifier for the item. - `min` (int) - The minimum quantity of the item. - `max` (int) - The maximum quantity of the item. - **EquipmentLoadoutItem(int id, Supplier min, Supplier max)** - Description: Constructs an EquipmentLoadoutItem with a specific ID and suppliers for minimum and maximum values. - Parameters: - `id` (int) - The unique identifier for the item. - `min` (Supplier) - A supplier for the minimum quantity. - `max` (Supplier) - A supplier for the maximum quantity. - **EquipmentLoadoutItem(int id, int min, Supplier max)** - Description: Constructs an EquipmentLoadoutItem with a specific ID, a minimum value, and a supplier for the maximum value. - Parameters: - `id` (int) - The unique identifier for the item. - `min` (int) - The minimum quantity of the item. - `max` (Supplier) - A supplier for the maximum quantity. - **EquipmentLoadoutItem(int id, Supplier min, int max)** - Description: Constructs an EquipmentLoadoutItem with a specific ID, a supplier for the minimum value, and a maximum value. - Parameters: - `id` (int) - The unique identifier for the item. - `min` (Supplier) - A supplier for the minimum quantity. - `max` (int) - The maximum quantity of the item. - **EquipmentLoadoutItem(Supplier idSupplier, int min, int max)** - Description: Constructs an EquipmentLoadoutItem with a supplier for the ID, and specific minimum and maximum values. - Parameters: - `idSupplier` (Supplier) - A supplier for the item's ID. - `min` (int) - The minimum quantity of the item. - `max` (int) - The maximum quantity of the item. - **EquipmentLoadoutItem(Supplier idSupplier, Supplier min, Supplier max)** - Description: Constructs an EquipmentLoadoutItem with suppliers for the ID, minimum, and maximum values. - Parameters: - `idSupplier` (Supplier) - A supplier for the item's ID. - `min` (Supplier) - A supplier for the minimum quantity. - `max` (Supplier) - A supplier for the maximum quantity. - **EquipmentLoadoutItem(Supplier idSupplier, int min, Supplier max)** - Description: Constructs an EquipmentLoadoutItem with a supplier for the ID, a specific minimum value, and a supplier for the maximum value. - Parameters: - `idSupplier` (Supplier) - A supplier for the item's ID. - `min` (int) - The minimum quantity of the item. - `max` (Supplier) - A supplier for the maximum quantity. - **EquipmentLoadoutItem(Supplier idSupplier, Supplier min, int max)** - Description: Constructs an EquipmentLoadoutItem with a supplier for the ID, a supplier for the minimum value, and a specific maximum value. - Parameters: - `idSupplier` (Supplier) - A supplier for the item's ID. - `min` (Supplier) - A supplier for the minimum quantity. - `max` (int) - The maximum quantity of the item. - **EquipmentLoadoutItem(ItemMapping mapping, int min, int max)** - Description: Constructs an EquipmentLoadoutItem using an ItemMapping and specific minimum and maximum values. - Parameters: - `mapping` (ItemMapping) - The mapping for the item. - `min` (int) - The minimum quantity of the item. - `max` (int) - The maximum quantity of the item. - **EquipmentLoadoutItem(ItemMapping mapping, Supplier min, Supplier max)** - Description: Constructs an EquipmentLoadoutItem using an ItemMapping and suppliers for minimum and maximum values. - Parameters: - `mapping` (ItemMapping) - The mapping for the item. - `min` (Supplier) - A supplier for the minimum quantity. - `max` (Supplier) - A supplier for the maximum quantity. - **EquipmentLoadoutItem(ItemMapping mapping, int min, Supplier max)** - Description: Constructs an EquipmentLoadoutItem using an ItemMapping, a specific minimum value, and a supplier for the maximum value. - Parameters: - `mapping` (ItemMapping) - The mapping for the item. - `min` (int) - The minimum quantity of the item. - `max` (Supplier) - A supplier for the maximum quantity. - **EquipmentLoadoutItem(ItemMapping mapping, Supplier min, int max)** - Description: Constructs an EquipmentLoadoutItem using an ItemMapping, a supplier for the minimum value, and a specific maximum value. - Parameters: - `mapping` (ItemMapping) - The mapping for the item. - `min` (Supplier) - A supplier for the minimum quantity. - `max` (int) - The maximum quantity of the item. - **EquipmentLoadoutItem(ItemVariant variant, int min, int max)** - Description: Constructs an EquipmentLoadoutItem using an ItemVariant and specific minimum and maximum values. - Parameters: - `variant` (ItemVariant) - The variant of the item. - `min` (int) - The minimum quantity of the item. - `max` (int) - The maximum quantity of the item. - **EquipmentLoadoutItem(ItemVariant variant, Supplier min, Supplier max)** - Description: Constructs an EquipmentLoadoutItem using an ItemVariant and suppliers for minimum and maximum values. - Parameters: - `variant` (ItemVariant) - The variant of the item. - `min` (Supplier) - A supplier for the minimum quantity. - `max` (Supplier) - A supplier for the maximum quantity. - **EquipmentLoadoutItem(ItemVariant variant, int min, Supplier max)** - Description: Constructs an EquipmentLoadoutItem using an ItemVariant, a specific minimum value, and a supplier for the maximum value. - Parameters: - `variant` (ItemVariant) - The variant of the item. - `min` (int) - The minimum quantity of the item. - `max` (Supplier) - A supplier for the maximum quantity. - **EquipmentLoadoutItem(ItemVariant variant, Supplier min, int max)** - Description: Constructs an EquipmentLoadoutItem using an ItemVariant, a supplier for the minimum value, and a specific maximum value. - Parameters: - `variant` (ItemVariant) - The variant of the item. - `min` (Supplier) - A supplier for the minimum quantity. - `max` (int) - The maximum quantity of the item. ``` -------------------------------- ### Close Quick Prayers Setup API Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/wrappers/prayer/Prayers Closes the Quick Prayers setup interface. ```APIDOC ## POST /quick-prayers/setup/close ### Description Closes the Quick Prayers setup interface. ### Method POST ### Endpoint /quick-prayers/setup/close ### Response #### Success Response (200) - **success** (boolean) - true if the setup was successfully closed, false otherwise. #### Response Example ```json { "success": false } ``` ``` -------------------------------- ### Equipment Management API Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/containers/equipment/Equipment This section details the various methods available for managing equipment within the container. ```APIDOC ## Equipment Class ### Description A class to manage equipment related functionality. ### Constructor Summary - **Equipment()**: Default constructor. ### Method Summary #### Retrieving Items - **GET /api/equipment/all** - Description: Returns a list of all items in the container. - Returns: `List` - **GET /api/equipment/all/{ids}** - Description: Returns a list of all items with the given IDs. - Parameters: - `ids` (int...) - Required - A variable number of item IDs. - Returns: `List` - **GET /api/equipment/all/names/{names}** - Description: Returns a list of all items with the given names. - Parameters: - `names` (String...) - Required - A variable number of item names. - Returns: `List` - **POST /api/equipment/all/predicate** - Description: Returns a list of all items that satisfy the given predicate. - Request Body: - `predicate` (Predicate) - Required - The predicate to filter items. - Returns: `List` - **POST /api/equipment/all/items** - Description: Returns a list of all items with the given items. - Request Body: - `items` (Item...) - Required - A variable number of items. - Returns: `List` - **POST /api/equipment/all/variant** - Description: Returns a list of all items with the given variant. - Request Body: - `itemVariant` (ItemVariant) - Required - The item variant to filter by. - Returns: `List` - **GET /api/equipment/allExcept/{ids}** - Description: Returns a list of all items except those with the given IDs. - Parameters: - `ids` (int...) - Required - A variable number of item IDs. - Returns: `List` - **GET /api/equipment/allExcept/names/{names}** - Description: Returns a list of all items except those with the given names. - Parameters: - `names` (String...) - Required - A variable number of item names. - Returns: `List` - **POST /api/equipment/allExcept/predicate** - Description: Returns a list of all items except those that satisfy the given predicate. - Request Body: - `predicate` (Predicate) - Required - The predicate to filter items. - Returns: `List` - **POST /api/equipment/allExcept/items** - Description: Returns a list of all items except those with the given items. - Request Body: - `items` (Item...) - Required - A variable number of items. - Returns: `List` - **POST /api/equipment/allExcept/variant** - Description: Returns a list of all items except those with the given variant. - Request Body: - `itemVariant` (ItemVariant) - Required - The item variant to filter by. - Returns: `List` #### Container Information - **GET /api/equipment/capacity** - Description: Returns the capacity of the container. - Returns: `int` #### Checking Item Existence - **GET /api/equipment/contains/{id}** - Description: Checks if the container contains an item with the given ID. - Parameters: - `id` (int) - Required - The item ID to check. - Returns: `boolean` - **GET /api/equipment/contains/ids/{ids}** - Description: Checks if the container contains items with the given IDs. - Parameters: - `ids` (int...) - Required - A variable number of item IDs. - Returns: `boolean` - **GET /api/equipment/contains/name/{name}** - Description: Checks if the container contains an item with the given name. - Parameters: - `name` (String) - Required - The item name to check. - Returns: `boolean` - **GET /api/equipment/contains/names/{names}** - Description: Checks if the container contains items with the given names. - Parameters: - `names` (String...) - Required - A variable number of item names. - Returns: `boolean` - **POST /api/equipment/contains/predicate** - Description: Checks if the container contains an item that satisfies the given predicate. - Request Body: - `predicate` (Predicate) - Required - The predicate to check. - Returns: `boolean` - **POST /api/equipment/contains/item** - Description: Checks if the container contains the given item. - Request Body: - `item` (Item) - Required - The item to check. - Returns: `boolean` - **POST /api/equipment/contains/items** - Description: Checks if the container contains the given items. - Request Body: - `items` (Item...) - Required - A variable number of items. - Returns: `boolean` - **POST /api/equipment/contains/variant** - Description: Checks if the container contains the given item variant. - Request Body: - `itemVariant` (ItemVariant) - Required - The item variant to check. - Returns: `boolean` - **GET /api/equipment/containsAll/{id}** - Description: Checks if the container contains all items with the given ID. - Parameters: - `id` (int) - Required - The item ID to check. - Returns: `boolean` - **GET /api/equipment/containsAll/ids/{ids}** - Description: Checks if the container contains all items with the given IDs. - Parameters: - `ids` (int...) - Required - A variable number of item IDs. - Returns: `boolean` - **GET /api/equipment/containsAll/name/{name}** - Description: Checks if the container contains all items with the given name. - Parameters: - `name` (String) - Required - The item name to check. - Returns: `boolean` - **GET /api/equipment/containsAll/names/{names}** - Description: Checks if the container contains all items with the given names. - Parameters: - `names` (String...) - Required - A variable number of item names. - Returns: `boolean` - **POST /api/equipment/containsAll/predicate** - Description: Checks if the container contains all items that satisfy the given predicate. - Request Body: - `predicate` (Predicate) - Required - The predicate to check. - Returns: `boolean` - **POST /api/equipment/containsAll/item** - Description: Checks if the container contains all items with the given item. - Request Body: - `item` (Item) - Required - The item to check. - Returns: `boolean` - **POST /api/equipment/containsAll/items** - Description: Checks if the container contains all items with the given items. - Request Body: - `items` (Item...) - Required - A variable number of items. - Returns: `boolean` - **POST /api/equipment/containsAll/variant** - Description: Checks if the container contains all items with the given item variant. - Request Body: - `itemVariant` (ItemVariant) - Required - The item variant to check. - Returns: `boolean` #### Counting Items - **GET /api/equipment/count/{id}** - Description: Returns the total amount of items in the container with the given ID. - Parameters: - `id` (int) - Required - The item ID. - Returns: `int` - **GET /api/equipment/count/ids/{ids}** - Description: Returns the total amount of items in the container with the given IDs. - Parameters: - `ids` (int...) - Required - A variable number of item IDs. - Returns: `int` - **GET /api/equipment/count/name/{name}** - Description: Returns the total amount of items in the container with the given name. - Parameters: - `name` (String) - Required - The item name. - Returns: `int` - **GET /api/equipment/count/names/{names}** - Description: Returns the total amount of items in the container with the given names. - Parameters: - `names` (String...) - Required - A variable number of item names. - Returns: `int` - **POST /api/equipment/count/predicate** - Description: Returns the total amount of items in the container that satisfy the given predicate. - Request Body: - `predicate` (Predicate) - Required - The predicate to count by. - Returns: `int` - **POST /api/equipment/count/slots** - Description: Counts the total number of items in the given equipment slots. - Request Body: - `slots` (EquipmentSlot...) - Required - A variable number of equipment slots. - Returns: `int` - **POST /api/equipment/count/item** - Description: Returns the total amount of items in the container in which the item has the same ID as the given item. - Request Body: - `item` (Item) - Required - The item to count. - Returns: `int` - **POST /api/equipment/count/items** - Description: Returns the total amount of items in the container in which the item has the same ID as the given items. - Request Body: - `items` (Item...) - Required - A variable number of items. - Returns: `int` ``` -------------------------------- ### Open Quick Prayers Setup API Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/wrappers/prayer/Prayers Opens the Quick Prayers setup interface. ```APIDOC ## POST /quick-prayers/setup/open ### Description Opens the Quick Prayers setup interface. ### Method POST ### Endpoint /quick-prayers/setup/open ### Response #### Success Response (200) - **success** (boolean) - true if the setup was successfully opened, false otherwise. #### Response Example ```json { "success": true } ``` ``` -------------------------------- ### Eternal Client API Accessors Overview Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/accessors/package-tree This section provides an overview of the available accessors in the Eternal Client API. ```APIDOC ## Overview of Accessors This API provides access to various aspects of the game, including combat, dialogues, entities, friends, game objects, players, skills, and world information. ### Accessors Available: - **Combat**: Access to combat-related functionalities. - **Dialogues**: Interaction with dialogue systems. - **Entities**: General access to game entities. - **Friends**: Management of friend lists and related features. - **FriendsChat**: Functionality for friends chat. - **GameObjects**: Interaction with static game objects. - **GraphicsObjects**: Access to graphical effects. - **GroundItems**: Handling of items on the ground. - **LocalPlayer**: Information and actions related to the local player. - **NPCs**: Interaction with non-player characters. - **Players**: Information and actions related to other players. - **PlayerSettings**: Access to player-specific settings. - **Projectiles**: Information about projectiles in the game. - **Skills**: Access to player skills and progression. - **Widgets**: Interaction with UI widgets. - **Worlds**: Information about game worlds. ``` -------------------------------- ### ItemVariant Field Detail Examples Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/wrappers/item/ItemVariant Provides specific details for a few example fields within the ItemVariant class. ```APIDOC ## ItemVariant Field Details ### GAMES_NECKLACE ```java public static final ItemVariant GAMES_NECKLACE ``` ### SKILLS_NECKLACE ```java public static final ItemVariant SKILLS_NECKLACE ``` ### AMULET_OF_GLORY ```java public static final ItemVariant AMULET_OF_GLORY ``` ### DIGSITE_PENDANT ```java public static final ItemVariant DIGSITE_PENDANT ``` ### NECKLACE_OF_PASSAGE ```java public static final ItemVariant NECKLACE_OF_PASSAGE ``` ### BURNING_AMULET ```java public static final ItemVariant BURNING_AMULET ``` ### RING_OF_DUELING ```java public static final ItemVariant RING_OF_DUELING ``` ### RING_OF_WEALTH ```java public static final ItemVariant RING_OF_WEALTH ``` ### SLAYER_RING ```java public static final ItemVariant SLAYER_RING ``` ### COMBAT_BRACELET ```java public static final ItemVariant COMBAT_BRACELET ``` ### TELEPORT_CRYSTAL ```java public static final ItemVariant TELEPORT_CRYSTAL ``` ### RADAS_BLESSING ```java public static final ItemVariant RADAS_BLESSING ``` ``` -------------------------------- ### ScreenAdjustedNature Constructors Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/internal/mouse/naturalmouse/support/ScreenAdjustedNature Provides details on how to initialize ScreenAdjustedNature. ```APIDOC ## ScreenAdjustedNature Constructors ### Description Provides constructors for initializing the `ScreenAdjustedNature` class. ### Constructor Summary * **ScreenAdjustedNature(int x, int y, int x2, int y2)**: Constructor that takes four integer arguments. * **ScreenAdjustedNature(java.awt.Dimension screenSize, java.awt.Point mouseOffset)**: Constructor that takes a Dimension object for screen size and a Point object for mouse offset. ### Constructor Detail #### ScreenAdjustedNature(int x, int y, int x2, int y2) ```java public ScreenAdjustedNature(int x, int y, int x2, int y2) ``` #### ScreenAdjustedNature(java.awt.Dimension screenSize, java.awt.Point mouseOffset) ```java public ScreenAdjustedNature(java.awt.Dimension screenSize, java.awt.Point mouseOffset) ``` ``` -------------------------------- ### EquipmentLoadout - Configuration Methods Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/events/loadout/EquipmentLoadout Methods for configuring the equipment loadout, including setting enabled status, strictness, price, and refill parameters. ```APIDOC ## EquipmentLoadout - Configuration Methods ### Description Methods for configuring the equipment loadout, including setting enabled status, strictness, price, and refill parameters. ### Methods - `setEnabled(java.util.function.Supplier enabled)` - `setLoadoutStrict()` - `setLoadoutStrict(java.util.function.BooleanSupplier booleanSupplier)` - `setMaxPrice(int maxPrice)` - `setMaxPrice(java.util.function.Supplier maxPrice)` - `setPrice(int price)` - `setPrice(java.util.function.Supplier price)` - `setRefill(int refill)` - `setRefill(int refill, boolean buyUpTo)` - `setRefill(java.util.function.Supplier refill)` - `setRefill(java.util.function.Supplier refill, boolean buyUpTo)` - `setShared()` ``` -------------------------------- ### Is Quick Prayers Setup Open API Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/wrappers/prayer/Prayers Checks if the Quick Prayers setup interface is currently open. ```APIDOC ## GET /quick-prayers/setup/is-open ### Description Checks if the Quick Prayers setup interface is currently open. ### Method GET ### Endpoint /quick-prayers/setup/is-open ### Response #### Success Response (200) - **isOpen** (boolean) - true if the setup is open, false otherwise. #### Response Example ```json { "isOpen": false } ``` ``` -------------------------------- ### MathUtil Constructor Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/internal/mouse/naturalmouse/util/MathUtil Initializes a new instance of the MathUtil class. ```APIDOC ## MathUtil Constructor ### Description Initializes a new instance of the MathUtil class. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response (200) An instance of MathUtil. #### Response Example None ``` -------------------------------- ### Check Quick Prayer Setup Open - Java Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/wrappers/prayer/Prayers Checks if the Quick Prayer setup interface is currently open. ```Java public static boolean isQuickPrayersSetupOpen​() ``` -------------------------------- ### SkillTracker Has Started Method Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/listeners/skill/SkillTracker Checks whether the tracking for a specified skill has been initiated. Returns true if started, false otherwise. ```Java public static boolean hasStarted(Skill skill) ``` -------------------------------- ### Get Next Tutorial Account (Java) Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalfarm/client/EternalFarmClient Retrieves the next tutorial account based on provided filters. This method is susceptible to IOExceptions. ```java public GetResult getNextTutorialAccount(java.util.Map filters) throws java.io.IOException ``` -------------------------------- ### Pathfinding and Reachability Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/interfaces/Positionable Determine walkable tiles, path distances, and generate paths between positionables. ```APIDOC ## GET /positionable/pathfinding ### Description Provides methods to find walkable tiles near a positionable, check reachability, and calculate path distances and routes. ### Method GET ### Endpoint /positionable/pathfinding ### Parameters #### Query Parameters - **radius** (int) - Optional. The radius to search for a walkable tile. - **other** (Positionable) - Required for path calculations. The destination positionable. ### Request Example ### Response #### Success Response (200) - **walkableTile** (Positionable) - A walkable tile within the specified radius, or null if none found. - **canReach** (boolean) - Indicates if the destination is directly reachable. - **canReachSurrounding** (boolean) - Indicates if any surrounding tile is reachable. - **distanceToPath** (int) - The path distance to the 'other' positionable. Returns Integer.MAX_VALUE if unreachable. - **pathTo** (List) - A list of checkpoint tiles representing the path to the 'other' positionable. #### Response Example { "walkableTile": { "x": 50, "y": 60, "z": 0 }, "canReach": true, "canReachSurrounding": true, "distanceToPath": 15, "pathTo": [ {"x": 55, "y": 65, "z": 0}, {"x": 50, "y": 60, "z": 0} ] } ``` -------------------------------- ### Get Current Amount Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/containers/ge/GrandExchange Retrieves the current amount from PlayerSettings by accessing a specific bit value. This method is used to get a stored quantity. ```java public static int getCurrentAmount() Retrieves the current amount from the PlayerSettings by fetching the bit value at position 4396. ``` -------------------------------- ### OpenBuyEvent.State Class Overview Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/events/ge/sub/buy/OpenBuyEvent Provides an overview of the OpenBuyEvent.State class, its inheritance, and field summaries. ```APIDOC ## OpenBuyEvent.State Class ### Description Represents the state of an OpenBuyEvent. ### Inheritance - `java.lang.Object` - `net.eternalclient.api.events.ge.sub.buy.OpenBuyEvent.State` ### Fields - `action` (String) - The action associated with the state. - `instance` (OpenBuyEvent) - The instance of the OpenBuyEvent. - `slot` (int) - The slot number. ### Constructors - `State()` - Default constructor. ``` -------------------------------- ### Container Utility Methods Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/containers/equipment/Equipment Provides utility methods for the equipment container. ```APIDOC ## GET /equipment/container/size ### Description Gets the size of the item container. ### Method GET ### Endpoint /equipment/container/size ### Parameters None ### Request Example None ### Response #### Success Response (200) - **body** (int) - The size of the item container. #### Response Example ```json { "size": 5 } ``` ``` ```APIDOC ## GET /equipment/container/cache ### Description Gets the item container cache. ### Method GET ### Endpoint /equipment/container/cache ### Parameters None ### Request Example None ### Response #### Success Response (200) - **body** (ItemContainerCache) - The item container cache. #### Response Example ```json { "cacheId": "abc-123" } ``` ``` ```APIDOC ## GET /equipment/container ### Description Returns the item container with the specified node ID. ### Method GET ### Endpoint /equipment/container ### Parameters #### Query Parameters - **nodeId** (int) - Required - The node ID of the item container. ### Request Example None ### Response #### Success Response (200) - **body** (RSItemContainer) - The item container. #### Response Example ```json { "containerId": 456 } ``` ``` ```APIDOC ## GET /equipment/container/usedSlots ### Description Returns the number of used slots in the container. ### Method GET ### Endpoint /equipment/container/usedSlots ### Parameters None ### Request Example None ### Response #### Success Response (200) - **body** (int) - The number of used slots. #### Response Example ```json { "usedSlots": 3 } ``` ``` -------------------------------- ### Close Quick Prayer Setup - Java Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/wrappers/prayer/Prayers Closes the Quick Prayer setup interface. Returns true if successful, false otherwise. ```Java public static boolean closeQuickPrayersSetup​() ``` -------------------------------- ### EquipmentLoadoutEvent Methods Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/events/loadout/EquipmentLoadoutEvent Provides methods for interacting with and configuring the EquipmentLoadoutEvent, including retrieving loadout details, managing bank state, and controlling buying behavior. ```APIDOC ## EquipmentLoadoutEvent Methods ### Description Methods for managing and configuring the equipment loadout event. ### Method INSTANCE ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example ```java EquipmentLoadoutEvent event = ...; // Assume an initialized event // Get the current loadout EquipmentLoadout currentLoadout = event.getLoadout(); // Keep the bank open event.keepBankOpen(); // Set whether to keep the bank open event.keepBankOpen(true); // or false // Set the bank location BankLocation bankLoc = ...; // Initialize BankLocation event.setBank(bankLoc); // Set the bank using a supplier event.setBank(() -> bankLoc); // Set to buy remainder event.setBuyRemainder(true); // or false // Set to use buying teleport event.setUseBuyingTeleport(true); // or false ``` ### Response #### Success Response (200) - **getLoadout()** (EquipmentLoadout) - Returns the current equipment loadout. - **keepBankOpen()** (EquipmentLoadoutEvent) - Returns the current event instance for chaining. - **keepBankOpen(boolean)** (EquipmentLoadoutEvent) - Returns the current event instance for chaining. - **setBank(BankLocation)** (EquipmentLoadoutEvent) - Returns the current event instance for chaining. - **setBank(Supplier)** (EquipmentLoadoutEvent) - Returns the current event instance for chaining. - **setBuyRemainder(boolean)** (EquipmentLoadoutEvent) - Returns the current event instance for chaining. - **setUseBuyingTeleport(boolean)** (EquipmentLoadoutEvent) - Returns the current event instance for chaining. #### Response Example N/A ``` -------------------------------- ### Open Quick Prayer Setup - Java Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/wrappers/prayer/Prayers Opens the Quick Prayer setup interface. Returns true if successful, false otherwise. ```Java public static boolean openQuickPrayersSetup​() ``` -------------------------------- ### Get EquipmentLoadout Items Source: https://eternalclient.ams3.cdn.digitaloceanspaces.com/javadocs/1.1.1/net/eternalclient/api/events/loadout/EquipmentLoadout Retrieves lists of items associated with the EquipmentLoadout. Includes methods to get all items, actionable items, and items for a specific slot. ```java java.util.List getActionableItems() ``` ```java EquipmentLoadoutItem getForSlot​(EquipmentSlot slot) ``` ```java java.util.List getItems() ```