### WelcomeScreenSolver Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/WelcomeScreenSolver.md

This section details the available methods for the WelcomeScreenSolver class, including how to get debug information and control its execution.

```APIDOC
## WelcomeScreenSolver Class Methods

### Description
Provides methods for interacting with the WelcomeScreenSolver, including retrieving debug information and controlling its execution loop.

### Methods

#### `getDebugInfo()`

- **Description**: Returns state information about the solver, useful for debugging.
- **Returns**: `java.lang.String` - The debug information string.

#### `onLoop()`

- **Description**: The main execution loop for the solver. This method must be overridden by subclasses.
- **Returns**: `int` - The result of the loop execution.

#### `shouldExecute()`

- **Description**: Checks whether the random event solver should execute. This method must be overridden by subclasses.
- **Returns**: `boolean` - True if the solver should execute, false otherwise.
```

--------------------------------

### ClientSettings.SettingsTab Enum Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/SettingsTab.md

This section covers the methods available for the ClientSettings.SettingsTab enum, specifically how to get an enum constant by its name and how to get all enum constants.

```APIDOC
## ClientSettings.SettingsTab Enum

### Description
Represents the different tabs within the client settings.

### Methods

#### `valueOf(String name)`

##### Description
Returns the enum constant of this type with the specified name.

##### Method
`static ClientSettings.SettingsTab`

##### Parameters
- **name** (String) - Required - The name of the enum constant to return.

#### `values()`

##### Description
Returns an array containing the constants of this enum type, in the order they are declared.

##### Method
`static ClientSettings.SettingsTab []`

##### Parameters
None
```

--------------------------------

### Get Local Player Information

Source: https://context7.com/bandit-haxunit/dreambot-mcp/llms.txt

Retrieves details about the local player, such as name, health, and movement status. Requires no setup.

```java
import org.dreambot.api.methods.interactive.Players;
import org.dreambot.api.wrappers.interactive.Player;

// Get local player
Player localPlayer = Players.getLocal();
String myName = localPlayer.getName();
int myHealth = localPlayer.getHealthPercent();
boolean amIMoving = localPlayer.isMoving();
boolean amIAnimating = localPlayer.isAnimating();

// Find other players
Player friend = Players.closest("FriendName");
List<Player> nearbyPlayers = Players.all(p -> p.distance() < 10);

// Check player state
if (localPlayer.isInCombat()) {
    // Handle combat
}

// Get player's current tile
Tile myPosition = localPlayer.getTile();
```

--------------------------------

### Basic Script Structure with AbstractScript

Source: https://context7.com/bandit-haxunit/dreambot-mcp/llms.txt

Extend AbstractScript and implement onLoop() for your script's main logic. Use ScriptManifest annotation for metadata. onStart() and onExit() handle initialization and cleanup.

```java
import org.dreambot.api.script.AbstractScript;
import org.dreambot.api.script.Category;
import org.dreambot.api.script.ScriptManifest;

@ScriptManifest(
    name = "My Script",
    description = "Example script",
    author = "Developer",
    version = 1.0,
    category = Category.MISC
)
public class MyScript extends AbstractScript {

    @Override
    public void onStart() {
        log("Script started!");
    }

    @Override
    public int onLoop() {
        // Main script logic here
        // Return value is sleep time in milliseconds before next loop
        return 600;
    }

    @Override
    public void onExit() {
        log("Script stopped!");
    }
}
```

--------------------------------

### EntranceWebNode Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/EntranceWebNode.md

Methods available for interacting with and configuring EntranceWebNode instances.

```APIDOC
## EntranceWebNode Methods

### Description
Methods to execute navigation, check requirements, and configure node properties.

### Methods
- **execute()** (boolean) - Handles the actual walking or entity interaction.
- **execute(AbstractWebNode nextNode)** (boolean) - Executes the node with a reference to the next node.
- **forceNext()** (boolean) - Determines if the walker should force execution of this node.
- **getAction()** (String) - Returns the interaction action.
- **getActions()** (String[]) - Returns the list of interaction actions.
- **getCondition()** (Condition) - Returns the condition required for this node.
- **getEntityName()** (String) - Returns the name of the entity associated with the node.
- **getForcedObjTile()** (Tile) - Returns the forced object tile.
- **getRequiredItems()** (List<RequiredItem>) - Returns items required to use this node.
- **getType()** (WebNodeType) - Returns the node type for path finding.
- **hasRequirements()** (boolean) - Checks if the player meets requirements to use this node.
- **isUseSleeps()** (boolean) - Checks if sleep is used during execution.
- **isValid()** (boolean) - Checks if the node is valid for path finding.
- **setAction(String action)** (void) - Sets the interaction action.
- **setActions(String[] actions)** (void) - Sets the interaction actions.
- **setCondition(Condition condition)** (void) - Sets the node condition.
- **setEntityName(String entityName)** (void) - Sets the entity name.
- **setForcedObjTile(Tile forcedObjTile)** (void) - Sets the forced object tile.
- **setUseSleeps(boolean useSleeps)** (void) - Configures whether to use sleeps.
```

--------------------------------

### Grand Exchange Status Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/Status.md

Provides methods to get the status value, retrieve an enum constant by name, and get all enum constants for the Grand Exchange status.

```APIDOC
## Class: org.dreambot.api.methods.grandexchange.Status

### Description
Represents the status of an item or transaction within the Grand Exchange.

### Methods

#### `int getStatusValue()`

*   **Description**: Returns the integer value representing the current status.
*   **Returns**: `int` - The status value.

#### `static Status valueOf(java.lang.String name)`

*   **Description**: Returns the enum constant of this type with the specified name.
*   **Parameters**:
    *   `name` (java.lang.String) - Required - The name of the enum constant to retrieve.
*   **Returns**: `Status` - The enum constant with the specified name.

#### `static Status[] values()`

*   **Description**: Returns an array containing the constants of this enum type, in the order they are declared.
*   **Returns**: `Status[]` - An array of all Status enum constants.
```

--------------------------------

### BasicWebNode Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/BasicWebNode.md

This section details the available methods for the BasicWebNode class, including execution, validation, and configuration.

```APIDOC
## BasicWebNode Methods

### Description
Details the methods available for the BasicWebNode class.

### Methods

- `boolean execute(AbstractWebNode next)`
  - **Description**: Executes the web node, similar to `AbstractWebNode.execute()`, but provides the next web node in the path.
  - **Parameters**:
    - `next` (AbstractWebNode) - The next web node in the path.
  - **Returns**: `boolean` - True if the node was executed successfully, false otherwise.

- `double getRandomizationFactor()`
  - **Description**: Gets the randomization factor for this web node.
  - **Returns**: `double` - The current randomization factor.

- `WebNodeType getType()`
  - **Description**: Returns the type of the web node, used in pathfinding to check if the node is disabled.
  - **Returns**: `WebNodeType` - The type of the web node.

- `Condition getValid()`
  - **Description**: Gets the condition that determines the validity of this web node.
  - **Returns**: `Condition` - The validity condition.

- `boolean hasRequirements()`
  - **Description**: Checks if the current player meets the requirements to use this web node during pathfinding.
  - **Returns**: `boolean` - True if requirements are met, false otherwise.

- `boolean isValid()`
  - **Description**: Checks if the web node is valid and should be considered during pathfinding.
  - **Returns**: `boolean` - True if the node is valid, false otherwise.

- `void setRandomizationFactor(double randomizationFactor)`
  - **Description**: Sets the randomization factor for this web node.
  - **Parameters**:
    - `randomizationFactor` (double) - The new randomization factor.

- `void setValid(Condition valid)`
  - **Description**: Sets the condition that determines the validity of this web node.
  - **Parameters**:
    - `valid` (Condition) - The new validity condition.
```

--------------------------------

### GET getActiveInstances

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/ScriptManager.md

Retrieves the number of active instances for a specific script ID.

```APIDOC
## GET getActiveInstances

### Description
Get the active number of instances purchased (or trialed) to a user for a script currently in use.

### Method
GET

### Parameters
#### Query Parameters
- **scriptId** (int) - Required - The ID of the script to check.
```

--------------------------------

### MountainGuideWebNode Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/MountainGuideWebNode.md

This section outlines the available methods for interacting with MountainGuideWebNode.

```APIDOC
## MountainGuideWebNode Class

### Description
This class is the same as AbstractWebNode.execute() except the web walker will pass the next web node in the path after this node.

### Methods

#### `boolean execute(AbstractWebNode next)`

##### Description
This is the same as AbstractWebNode.execute() except the web walker will pass the next web node in the path after this node.

##### Method
`execute`

##### Parameters
- **next** (AbstractWebNode) - The next web node in the path.

#### `java.util.List<ConditionalLocation> getLocations()`

##### Description
Retrieves the list of conditional locations associated with this node.

##### Method
`getLocations`

#### `static java.util.List<MountainGuideWebNode> getMountainGuideNodes()`

##### Description
Retrieves a static list of all available MountainGuideWebNodes.

##### Method
`getMountainGuideNodes`

#### `WebNodeType getType()`

##### Description
Returns the WebNodeType of this node, used during path finding to ensure they're not disabled by the script.

##### Method
`getType`

##### Returns
- **WebNodeType** - The type of the web node.
```

--------------------------------

### ScheduleSettings API

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/ScheduleSettings.md

Provides methods to get and set schedules for the ScheduleSettings class.

```APIDOC
## ScheduleSettings API

### Description
This API provides methods to interact with schedule settings, allowing you to retrieve the current list of schedules and set a new list of schedules.

### Methods

#### Get Schedules

##### Description
Retrieves the current list of schedules associated with the ScheduleSettings.

##### Method
GET

##### Endpoint
`/api/settings/schedules`

##### Response

###### Success Response (200)
- **schedules** (List<ScriptSchedule>) - A list of ScriptSchedule objects representing the current schedules.

###### Response Example
```json
{
  "schedules": [
    {
      "startTime": "08:00",
      "endTime": "17:00",
      "days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"]
    }
  ]
}
```

#### Set Schedules

##### Description
Sets a new list of schedules for the ScheduleSettings.

##### Method
POST

##### Endpoint
`/api/settings/schedules`

##### Parameters

###### Request Body
- **schedules** (List<ScriptSchedule>) - Required - A list of ScriptSchedule objects to set as the new schedules.

##### Request Example
```json
{
  "schedules": [
    {
      "startTime": "09:00",
      "endTime": "18:00",
      "days": ["Saturday", "Sunday"]
    }
  ]
}
```

##### Response

###### Success Response (200)
- **message** (string) - A confirmation message indicating the schedules have been updated.

###### Response Example
```json
{
  "message": "Schedules updated successfully."
}
```
```

--------------------------------

### Client Utility Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/Client.md

A collection of static methods for managing client state, rendering, and camera behavior.

```APIDOC
## GET /seededRandom

### Description
Returns a random number seeded by account name between 0.9 and 1.1.

### Method
GET

### Response
#### Success Response (200)
- **value** (double) - The generated random number.

---

## POST /setCameraInMotion

### Description
Sets the camera in motion.

### Method
POST

### Request Body
- **cameraInMotion** (boolean) - Required - The state to set the camera motion to.

---

## POST /setViewport

### Description
Sets the viewport for the client.

### Method
POST

### Request Body
- **viewport** (Viewport) - Required - The viewport object to apply.

---

## POST /setRenderingDisabled

### Description
Enables or disables client rendering.

### Method
POST

### Request Body
- **disabled** (boolean) - Required - True to disable rendering, false to enable.

---

## POST /setForcedFPS

### Description
Sets the forced frames per second for the client.

### Method
POST

### Request Body
- **fps** (int) - Required - The target FPS value.

---

## POST /setIdleTime

### Description
Sets the idle time for the client.

### Method
POST

### Request Body
- **idleTime** (int) - Required - The idle time in milliseconds.

---

## POST /setMapAngleDirect

### Description
Sets the map angle directly.

### Method
POST

### Request Body
- **angle** (int) - Required - The angle to set.

---

## POST /removeIgnoreScriptId

### Description
Removes a script ID from the ignore list.

### Method
POST

### Request Body
- **id** (int) - Required - The script ID to remove.
```

--------------------------------

### GET getClickTimingInMilliseconds

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/MouseTiming.md

Retrieves the configured click timing in milliseconds for mouse operations.

```APIDOC
## GET getClickTimingInMilliseconds

### Description
Retrieves the current click timing setting in milliseconds used by the mouse input system.

### Method
GET

### Response
#### Success Response (200)
- **timing** (int) - The click timing value in milliseconds.
```

--------------------------------

### GET /org/dreambot/api/methods/worldhopper/JSocket/getSocket

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/JSocket.md

Retrieves the underlying java.net.Socket instance used by the JSocket class.

```APIDOC
## GET /org/dreambot/api/methods/worldhopper/JSocket/getSocket

### Description
Retrieves the underlying java.net.Socket instance associated with the current JSocket object.

### Method
GET

### Endpoint
/org/dreambot/api/methods/worldhopper/JSocket/getSocket

### Response
#### Success Response (200)
- **socket** (java.net.Socket) - The underlying socket instance.
```

--------------------------------

### Add Account with Basic Credentials

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/AccountManager.md

Use this method to add a new account with only nickname, username, and password. Ensure all parameters are valid strings.

```java
static boolean addAccount(java.lang.String nickname,
          java.lang.String username,
          java.lang.String password)()
```

--------------------------------

### POST /client/window/show

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/Instance.md

Brings the DreamBot program to the front of the desktop and un-minimizes it.

```APIDOC
## POST /client/window/show

### Description
This method will un-minimize and bring the whole DreamBot program to the front of your desktop.

### Method
POST
```

--------------------------------

### GET /client/version

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/Instance.md

Retrieves the current version string of the running DreamBot client.

```APIDOC
## GET /client/version

### Description
Returns the current DreamBot client version as a string.

### Method
GET

### Response
#### Success Response (200)
- **version** (String) - The current version of the DreamBot client.
```

--------------------------------

### Quest Status Checks

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/Quests.md

Provides methods to check if a quest is finished or started.

```APIDOC
## GET /api/quests/isFinished

### Description
Checks if the provided quest is finished.

### Method
GET

### Endpoint
/api/quests/isFinished

### Parameters
#### Query Parameters
- **quest** (Quest) - Required - The quest to check.

### Response
#### Success Response (200)
- **result** (boolean) - True if the quest is finished, false otherwise.

### Response Example
```json
{
  "result": true
}
```

## GET /api/quests/isStarted

### Description
Checks if the provided quest is currently in progress.

### Method
GET

### Endpoint
/api/quests/isStarted

### Parameters
#### Query Parameters
- **quest** (Quest) - Required - The quest to check.

### Response
#### Success Response (200)
- **result** (boolean) - True if the quest is started, false otherwise.

### Response Example
```json
{
  "result": true
}
```
```

--------------------------------

### Utility and Configuration Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/Map.md

Methods for managing obstacles and resetting the state.

```APIDOC
## POST /removeObstacleActions
### Description
Deprecated. No longer used, please use PathFinder.removeObstacle(PathObstacle) instead.
### Parameters
#### Request Body
- **actions** (String...) - Required - The actions to remove.

## POST /reset
### Description
Resets the current state.
```

--------------------------------

### GET getAccountNickname

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/ScriptManager.md

Retrieves the currently selected account nickname from the DreamBot account manager.

```APIDOC
## GET getAccountNickname

### Description
Gets the currently selected account nickname from the DreamBot account manager.

### Method
GET

### Response
#### Success Response (200)
- **nickname** (String) - The nickname of the currently selected account.
```

--------------------------------

### StandardMouseAlgorithm Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/StandardMouseAlgorithm.md

A collection of methods for calculating mouse movement dynamics and handling interactions.

```APIDOC
## StandardMouseAlgorithm Methods

### Description
Methods for calculating mouse movement dynamics and handling user interactions.

### Methods
- **dynamicRandom()** (double) - Returns a dynamic random value based on the current character's username.
- **getAccelerationDeviation()** (double) - Calculates acceleration deviation.
- **getAccelerationRate()** (double) - Calculates acceleration rate.
- **getAngleDeviationRate()** (double) - Calculates angle deviation rate.
- **getCanvasReportRate()** (double) - Calculates canvas report rate.
- **getDecayDistanceExponent()** (double) - Calculates the decay distance exponent.
- **getDecelDecayRate()** (double) - Calculates deceleration decay rate.
- **getDecelRadiusDeviation()** (double) - Calculates deceleration radius deviation.
- **getMaxDecelDistance()** (double) - Calculates max deceleration distance.
- **getMaxdTheta()** (double) - Calculates max theta value (d).
- **getMaxMagnitude()** (double) - Calculates max magnitude.
- **getMeanDecelRadius()** (double) - Calculates mean deceleration radius.
- **getMinDecelMagnitude()** (double) - Calculates minimum deceleration magnitude.
- **getMinMagnitude()** (double) - Calculates minimum magnitude.
- **handleClick(MouseButton button)** (boolean) - Handles the clicking process.
- **handleMovement(AbstractMouseDestination destination)** (boolean) - Handles the movement process to a specified destination.
```

--------------------------------

### GET /client/proxy

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/Instance.md

Retrieves the nickname of the currently active proxy, or null if none is selected.

```APIDOC
## GET /client/proxy

### Description
Gets the client's proxy nickname.

### Method
GET

### Response
#### Success Response (200)
- **proxyName** (String|null) - The nickname of the proxy or null if no proxy is selected.
```

--------------------------------

### PlayerSettings Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/PlayerSettings.md

Methods for retrieving game configuration values and bitwise settings.

```APIDOC
## GET /methods/settings/PlayerSettings

### Description
Provides access to player settings, including varbits and varps (configs) from the game cache.

### Methods
- **getBitValue(int id)**: Gets the specified bit value using the cache's varbit ID.
- **getCleanedConfig(int id, int and)**: Gets the specified config value, cleaned with given bitwise and value.
- **getConfig(int id)**: Gets the specified config value (also known as varps or varplayers).
- **getConfigs()**: Gets all player settings.
- **getVarBits()**: Gets all varbits.
- **getVarBitsForVarp(int varp)**: Gets a set of varbits associated with a specific varp.
```

--------------------------------

### TileDestination Class Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/TileDestination.md

Overview of methods available in the TileDestination class for interacting with mouse destinations.

```APIDOC
## TileDestination Class Methods

### Description
Methods for managing mouse destination interactions, spatial area calculations, and visibility verification.

### Methods
- **contains(java.awt.Point point)** (boolean) - Determines if the specified point is contained inside the destination shape.
- **getArea()** (java.awt.geom.Area) - Gets the area of the abstract destination shape.
- **getDestinationShape()** (java.awt.Shape) - Gets the abstract destination shape.
- **getSuitablePoint()** (java.awt.Point) - Gets a gaussian distributed offset point within the bounding box of this mouse destination.
- **handleCamera(boolean withZoom, Condition interrupt)** (boolean) - Handles the camera portion of event interaction.
- **isVisible()** (boolean) - Determines whether this destination is visible.
- **type()** (int) - Returns the mouse destination type ID.
- **verifyPostInteract()** (boolean) - Verification callback after interaction has been completed.
```

--------------------------------

### Get Account Username

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/AccountManager.md

Retrieves the username of the currently selected account. Returns a string.

```java
static java.lang.String getAccountUsername()
```

--------------------------------

### ScriptSettings Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/ScriptSettings.md

Methods for managing script settings persistence.

```APIDOC
## STATIC boolean exists(Class<T> clazz, String... fileLocationSteps)

### Description
Checks if a saved file exists at the provided file location steps and optionally verifies if it can be loaded as the provided class.

### Parameters
#### Path Parameters
- **clazz** (Class<T>) - Optional - The class type to validate against.
- **fileLocationSteps** (String...) - Required - The path steps to the settings file.

---

## STATIC T load(Class<T> clazz, String... fileLocationSteps)

### Description
Loads a given class from a settings object. The location base is the scripts path.

### Parameters
#### Path Parameters
- **clazz** (Class<T>) - Required - The class type to deserialize into.
- **fileLocationSteps** (String...) - Required - The path steps to the settings file.

---

## STATIC boolean save(Object obj, String... fileLocationSteps)

### Description
Saves a given object using GSON pretty print to the specified file location.

### Parameters
#### Path Parameters
- **obj** (Object) - Required - The object to serialize and save.
- **fileLocationSteps** (String...) - Required - The path steps to the destination file.
```

--------------------------------

### Get Account Nickname

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/AccountManager.md

Retrieves the nickname of the currently selected account. Returns a string.

```java
static java.lang.String getAccountNickname()
```

--------------------------------

### RSScriptEventListener Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/RSScriptEventListener.md

Documentation for the event listener methods triggered at the start of the runScript method.

```APIDOC
## Methods for RSScriptEventListener

### Description
These methods are triggered at the start of the runScript method execution.

### Methods
- **onPreFired(RuneScriptEvent event)**: Fires off at the start of the runScript method.
- **preFired(RuneScriptEvent event)**: Fires off at the start of the runScript method.
```

--------------------------------

### Walking - Navigation and Pathfinding

Source: https://context7.com/bandit-haxunit/dreambot-mcp/llms.txt

Provides methods for navigating the game world using web and local pathfinders, handling obstacles and supporting various walking methods.

```APIDOC
## Walking - Navigation and Pathfinding

### Description
Provides methods for navigating the game world using a combination of web and local pathfinders. Handles obstacles automatically and supports both minimap clicking and on-screen tile clicking.

### Method
```java
import org.dreambot.api.methods.walking.impl.Walking;
import org.dreambot.api.methods.map.Tile;

// Walk to a specific tile
Tile destination = new Tile(3270, 3167);
if (destination.distance() > 5 && Walking.shouldWalk()) {
    Walking.walk(destination);
}

// Check and enable running
if (!Walking.isRunEnabled() && Walking.getRunEnergy() > 30) {
    Walking.toggleRun();
}

// Set run threshold for automatic toggling
Walking.setRunThreshold(40);

// Walk to exact tile (no randomization)
Walking.walkExact(new Tile(3200, 3200));

// Check if destination is reachable locally
if (Walking.canWalk(destination)) {
    Walking.walk(destination);
}

// Get current destination (red flag on minimap)
Tile currentDest = Walking.getDestination();
int distToDest = Walking.getDestinationDistance();
```
```

--------------------------------

### DismissSolver Class Overview

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/DismissSolver.md

Provides an overview of the DismissSolver class and its primary methods.

```APIDOC
## DismissSolver Class

### Description

The `DismissSolver` class is an abstract class within the DreamBot API used to handle random events. It requires subclasses to implement specific methods for execution logic and condition checking.

### Methods

#### `int onLoop()`

- **Description**: This method contains the core logic that runs as long as the `shouldExecute()` method returns true. It must be overridden by subclasses to define the behavior for handling a random event.
- **Return Type**: `int`

#### `boolean shouldExecute()`

- **Description**: This method determines whether the random event solver should be activated. It must be overridden by subclasses to define the conditions under which the random event should be handled.
- **Return Type**: `boolean`
```

--------------------------------

### Fairy Ring Code Management

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/FairyRings.md

Methods for checking, getting, and entering fairy ring codes.

```APIDOC
## GET /api/fairyring/code

### Description
Retrieves the current fairy ring code.

### Method
GET

### Endpoint
/api/fairyring/code

### Parameters
None

### Response
#### Success Response (200)
- **code** (String[]) - The current fairy ring code.

#### Response Example
```json
{
  "code": ["A", "B", "C", "D"]
}
```

## POST /api/fairyring/code/equals

### Description
Checks if the current fairy ring code matches the provided code.

### Method
POST

### Endpoint
/api/fairyring/code/equals

### Parameters
#### Request Body
- **code** (String[]) - The code to compare against.

### Request Example
```json
{
  "code": ["A", "B", "C", "D"]
}
```

### Response
#### Success Response (200)
- **result** (boolean) - True if the codes match, false otherwise.

#### Response Example
```json
{
  "result": true
}
```

## POST /api/fairyring/code/enter

### Description
Enters a letter for a specific slot in the fairy ring code.

### Method
POST

### Endpoint
/api/fairyring/code/enter

### Parameters
#### Request Body
- **slot** (int) - Required - The slot number (0-indexed).
- **letter** (String) - Required - The letter to enter.

### Request Example
```json
{
  "slot": 0,
  "letter": "A"
}
```

### Response
#### Success Response (200)
- **result** (boolean) - True if the letter was entered successfully, false otherwise.

#### Response Example
```json
{
  "result": true
}
```

## POST /api/fairyring/code/enterTravel

### Description
Enters the code for a given fairy location.

### Method
POST

### Endpoint
/api/fairyring/code/enterTravel

### Parameters
#### Request Body
- **location** (FairyLocation) - Required - The fairy location to set the code for.

### Request Example
```json
{
  "location": "ZANARIS"
}
```

### Response
#### Success Response (200)
- **result** (boolean) - True if the code was entered successfully, false otherwise.

#### Response Example
```json
{
  "result": true
}
```

## GET /api/fairyring/code/get

### Description
Gets the current letter of a given slot in the fairy code.

### Method
GET

### Endpoint
/api/fairyring/code/get

### Parameters
#### Query Parameters
- **slot** (int) - Required - The slot number (0-indexed).

### Response
#### Success Response (200)
- **letter** (String) - The letter at the specified slot.

#### Response Example
```json
{
  "letter": "A"
}
```
```

--------------------------------

### AbstractWebNode Class Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/AbstractWebNode.md

Overview of the primary methods available for managing and executing web nodes within the DreamBot pathfinding system.

```APIDOC
## AbstractWebNode Methods

### Description
Methods used to manage node connections, validate pathfinding requirements, and execute navigation logic.

### Core Methods
- **execute()** (boolean) - Called by the walker to handle the actual walking or entity interaction. Returns true if successful.
- **hasRequirements()** (boolean) - Used by the WebFinder to determine if the player meets the requirements to use this node.
- **isValid()** (boolean) - Checks if the node is valid for use during pathfinding.
- **forceNext()** (boolean) - Determines if the walker should prioritize this node even if a further node is reachable.

### Connection Management
- **addDualConnections(AbstractWebNode... nodes)** - Adds a two-way connection between this node and the provided nodes.
- **addIncomingConnections(AbstractWebNode... connections)** - Adds incoming connections to this node.
- **addOutgoingConnections(AbstractWebNode... connections)** - Adds outgoing connections from this node.
- **removeDualConnections(AbstractWebNode... connections)** - Removes two-way connections.

### Utility Methods
- **distance(Tile tile)** (double) - Calculates the straight-line distance to a tile.
- **walkingDistance(Tile tile)** (double) - Calculates the walking distance to a tile based on pathfinding.
- **getTile()** (Tile) - Returns the tile associated with the node.
- **getWeight()** (int) - Returns the extra cost weight of the node.
- **setWeight(int weight)** (void) - Sets the extra cost weight of the node.
```

--------------------------------

### Get Account TOTP Key

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/AccountManager.md

Retrieves the TOTP key for the currently selected account. Returns a string.

```java
static java.lang.String getAccountTOTPKey()
```

--------------------------------

### GnomeGliderWebNode Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/GnomeGliderWebNode.md

API methods available for interacting with GnomeGliderWebNode objects.

```APIDOC
## boolean execute(AbstractWebNode next)

### Description
Executes the node logic. This is the same as AbstractWebNode.execute() except the web walker will pass the next web node in the path after this node.

### Parameters
- **next** (AbstractWebNode) - Required - The next web node in the path.

## static java.util.List<GnomeGliderWebNode> getGnomeGliderNodes()

### Description
Retrieves a list of all available Gnome Glider nodes.

## java.util.List<ConditionalLocation> getLocations()

### Description
Retrieves the list of locations associated with this node.

## WebNodeType getType()

### Description
Returns the WebNodeType of this node, used during path finding to ensure they're not disabled by the script.
```

--------------------------------

### Get Account Bank PIN

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/AccountManager.md

Retrieves the bank PIN for the currently selected account. Returns a string.

```java
static java.lang.String getAccountBankPin()
```

--------------------------------

### Deprecated: Get All Premium Scripts

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/NetworkLoader.md

This method is deprecated and should not be used. It was intended to retrieve a list of all available premium scripts.

```APIDOC
## GET /api/scripts/premium

### Description
Deprecated method to retrieve a list of all premium scripts.

### Method
GET

### Endpoint
/api/scripts/premium

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **scripts** (List<ScriptWrapper>) - A list of ScriptWrapper objects representing premium scripts.

#### Response Example
```json
{
  "scripts": [
    {
      "name": "ExamplePremiumScript",
      "version": "1.0.0",
      "author": "ExampleAuthor"
    }
  ]
}
```
```

--------------------------------

### AgilityWebNode Class Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/AgilityWebNode.md

This section outlines the methods available within the AgilityWebNode class, detailing their functionality for handling agility nodes during web walking.

```APIDOC
## AgilityWebNode Class

### Description
Represents an agility node used in the DreamBot web walking system.

### Methods

- `boolean execute()`
  - **Description**: This is called by the walker to handle the actual walking, entity handling, or whatever else needed to get past this node.
  - **Return Type**: `boolean`

- `boolean forceNext()`
  - **Description**: This is used to see if the walker should `AbstractWebNode.execute()` this node even if there's a web node further along the GlobalPath that it can reach.
  - **Return Type**: `boolean`

- `String getAction()`
  - **Description**: Gets the action associated with this agility node.
  - **Return Type**: `java.lang.String`

- `int getLevel()`
  - **Description**: Gets the agility level requirement for this node.
  - **Return Type**: `int`

- `String getObjectName()`
  - **Description**: Gets the name of the object associated with this agility node.
  - **Return Type**: `java.lang.String`

- `WebNodeType getType()`
  - **Description**: Returns the `WebNodeType` of this node, used during path finding to ensure they're not disabled by the script.
  - **Return Type**: `WebNodeType`

- `boolean hasRequirements()`
  - **Description**: This is used to determine during path finding if the current player can use this node.
  - **Return Type**: `boolean`

- `boolean isValid()`
  - **Description**: Checks the validity of this web node to see if it should be considered at all during path finding.
  - **Return Type**: `boolean`

- `void setAction(String action)`
  - **Description**: Sets the action for this agility node.
  - **Parameters**:
    - `action` (String) - The action to set.
  - **Return Type**: `void`

- `void setLevel(int level)`
  - **Description**: Sets the agility level requirement for this node.
  - **Parameters**:
    - `level` (int) - The agility level to set.
  - **Return Type**: `void`

- `void setObjectName(String objectName)`
  - **Description**: Sets the name of the object associated with this agility node.
  - **Parameters**:
    - `objectName` (String) - The object name to set.
  - **Return Type**: `void`
```

--------------------------------

### Deprecated: Get All Free Scripts

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/NetworkLoader.md

This method is deprecated and should not be used. It was intended to retrieve a list of all available free scripts.

```APIDOC
## GET /api/scripts/free

### Description
Deprecated method to retrieve a list of all free scripts.

### Method
GET

### Endpoint
/api/scripts/free

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **scripts** (List<ScriptWrapper>) - A list of ScriptWrapper objects representing free scripts.

#### Response Example
```json
{
  "scripts": [
    {
      "name": "ExampleFreeScript",
      "version": "1.0.0",
      "author": "ExampleAuthor"
    }
  ]
}
```
```

--------------------------------

### Method: execute

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/PathAwareWebNode.md

Executes the web node logic while receiving the next node in the path.

```APIDOC
## execute(AbstractWebNode next)

### Description
Executes the current web node logic. Unlike standard web nodes, this method receives the next web node in the path, allowing the node to be aware of the upcoming navigation step.

### Parameters
- **next** (AbstractWebNode) - Required - The next web node in the path.

### Returns
- **boolean** - Returns true if the execution was successful, false otherwise.
```

--------------------------------

### DBMouseEvent Class Overview

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/DBMouseEvent.md

Provides details about the DBMouseEvent class, its type, and source link. It also lists available methods.

```APIDOC
## DBMouseEvent Class

### Description
DreamBot implementation of MouseEvent. Sets all required internal fields. Primarily used internally; you should be using AbstractMouseEvent implementations for sending mouse events.

### Type
`class`

### Source
[View Javadoc](https://dreambot.org/javadocs/org/dreambot/api/input/event/impl/mouse/awt/DBMouseEvent.html)

### Methods

#### `java.lang.String toString()`

- **Description**: Returns a string representation of the object.
- **Returns**: (String) A string representation of the DBMouseEvent object.
```

--------------------------------

### Get All Account Nicknames

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/AccountManager.md

Retrieves a list containing the nicknames of all accounts managed by the client. Returns a List of strings.

```java
static java.util.List<java.lang.String> getAll()
```

--------------------------------

### ClanChatTab Enum Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/ClanChatTab.md

Provides methods to retrieve ClanChatTab enum constants by name or to get all available constants.

```APIDOC
## ClanChatTab Enum

### Description
Represents the different states or tabs within the clan chat interface.

### Methods

#### `valueOf(String name)`

##### Description
Returns the enum constant of this type with the specified name.

##### Method
`static ClanChatTab valueOf(String name)`

##### Parameters
- **name** (String) - Required - The name of the enum constant to return.

#### `values()`

##### Description
Returns an array containing the constants of this enum type, in the order they are declared.

##### Method
`static ClanChatTab[] values()`

##### Parameters
None

### Response
#### Success Response (200)
- **ClanChatTab** (Enum Constant) - The requested enum constant or an array of all enum constants.

#### Response Example
```json
{
  "example": "ClanChatTab.GENERAL"
}
```

```json
{
  "example": "[ClanChatTab.GENERAL, ClanChatTab.MINIGAME, ClanChatTab.TRADE]"
}
```
```

--------------------------------

### BankWebNode Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/BankWebNode.md

This section details the methods available for interacting with BankWebNode objects.

```APIDOC
## BankWebNode

### Description
Represents a bank web node used in pathfinding.

### Methods

- `WebNodeType getType()`
  - **Description**: Returns the WebNodeType of this node, used during path finding to ensure they're not disabled by the script.
  - **Return Type**: `WebNodeType`

- `boolean isValid()`
  - **Description**: Checks the validity of this web node to see if it should be considered at all during path finding.
  - **Return Type**: `boolean`
```

--------------------------------

### pressEnter

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/StandardKeyboardAlgorithm.md

Simulates pressing the Enter key.

```APIDOC
## pressEnter()

### Description
Handles pressing enter, called when the message has been typed successfully if required.
```

--------------------------------

### Jewellery Box Level API

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/TeleportSettings.md

Provides methods to get and set the required level for using the jewellery box for teleportation.

```APIDOC
## getJewelleryBoxLevel

### Description
Retrieves the required level for using the jewellery box for teleportation.

### Method
`static int`

### Endpoint
`TeleportSettings.getJewelleryBoxLevel()`

## setJewelleryBoxLevel

### Description
Sets the required level for using the jewellery box for teleportation.

### Method
`static void`

### Endpoint
`TeleportSettings.setJewelleryBoxLevel(int jewelleryBoxLevel)`

### Parameters
#### Path Parameters
- **jewelleryBoxLevel** (int) - Required - The minimum level required to use the jewellery box.
```

--------------------------------

### WebPathQuery Class Overview

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/WebPathQuery.md

Provides methods for building and calculating web paths between tiles, with options to include bank cache for item requirements.

```APIDOC
## WebPathQuery Class

### Description
Web Path Query to calculate a possible web path from a tile to a tile with the option of including the bank cache for required items.

### Methods

- `static WebPathQuery.WebPathQueryBuilder builder()` - Creates a new builder instance for WebPathQuery.
- `WebPathResponse calculate()` - Calculates and returns a WebPathResponse. Sets the calculated response to the field `calculated`.
- `boolean canUseBankCache()` - Checks if the bank cache can be used.
- `WebPathResponse getCalculated()` - Gets the calculated WebPathResponse.
- `Tile getFrom()` - Gets the starting tile for the path query.
- `GlobalPath<AbstractWebNode> getGlobalPath()` - Returns a GlobalPath containing all web nodes from the calculated response.
- `Tile getTo()` - Gets the destination tile for the path query.
- `java.util.List<Item> getWithItems()` - Gets the list of items required for the path.
- `boolean hasRequiredItems()` - Checks if all required items are present for the calculated WebPathResponse.
- `boolean isUseBankCache()` - Checks if bank cache usage is enabled.
- `void setCalculated(WebPathResponse calculated)` - Sets the calculated WebPathResponse.
- `void setFrom(Tile from)` - Sets the starting tile for the path query.
- `void setTo(Tile to)` - Sets the destination tile for the path query.
- `void setUseBankCache(boolean useBankCache)` - Enables or disables bank cache usage.
- `void setWithItems(java.util.List<Item> withItems)` - Sets the list of items required for the path.
```

--------------------------------

### Get Item Container by ID

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/ItemContainers.md

Retrieves a specific item container using its unique ID. Known IDs can be found in ItemContainerId.

```APIDOC
## GET /api/itemcontainers

### Description
Retrieves an item container based on its ID.

### Method
GET

### Endpoint
/api/itemcontainers

### Parameters
#### Query Parameters
- **id** (int) - Required - The ID of the item container to retrieve. Known IDs can be found in ItemContainerId.

### Response
#### Success Response (200)
- **ItemContainer** (object) - The retrieved item container object.

#### Response Example
```json
{
  "container": {
    "id": 123,
    "name": "Example Container",
    "items": [
      {
        "id": 456,
        "name": "Example Item",
        "quantity": 10
      }
    ]
  }
}
```
```

--------------------------------

### CharterWebNode Class Methods

Source: https://github.com/bandit-haxunit/dreambot-mcp/blob/main/dreambot/CharterWebNode.md

This section details the available methods within the CharterWebNode class, including execution, retrieval of nodes, connections, locations, required items, and node type.

```APIDOC
## CharterWebNode Class

### Description
This class is the same as AbstractWebNode.execute() except the web walker will pass the next web node in the path after this node.

### Methods

#### `boolean execute(AbstractWebNode next)`

##### Description
This is the same as AbstractWebNode.execute() except the web walker will pass the next web node in the path after this node.

##### Method
`execute`

##### Parameters
- **next** (AbstractWebNode) - The next web node in the path.

#### `static List<CharterWebNode> getCharterNodes()`

##### Description
Retrieves a list of all available charter nodes.

##### Method
`getCharterNodes`

##### Return Value
- `List<CharterWebNode>` - A list of charter nodes.

#### `List<AbstractWebNode> getConnections()`

##### Description
Retrieves the connections for this web node.

##### Method
`getConnections`

##### Return Value
- `List<AbstractWebNode>` - A list of connected web nodes.

#### `List<ConditionalLocation> getLocations()`

##### Description
Retrieves the conditional locations associated with this web node.

##### Method
`getLocations`

##### Return Value
- `List<ConditionalLocation>` - A list of conditional locations.

#### `List<RequiredItem> getRequiredItems()`

##### Description
Retrieves the required items for this web node.

##### Method
`getRequiredItems`

##### Return Value
- `List<RequiredItem>` - A list of required items.

#### `WebNodeType getType()`

##### Description
Returns the WebNodeType of this node, used during path finding to ensure they're not disabled by the script.

##### Method
`getType`

##### Return Value
- `WebNodeType` - The type of the web node.
```