DreamBot

https://dreambot.org/javadocs/
Admin
DreamBot is a Java API that provides methods and wrappers for interacting with game elements,...
Tokens:731,500
Snippets:9,214
Trust Score:8.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Started Setting

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/quest/book/FreeQuest.html

Returns the integer value of the setting that indicates if the quest has started. Specified by the Quest interface.

```java
public	int	getStartedSetting()
```

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

### Get Quest Started Setting

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/quest/book/Quest.html

Retrieves the setting value indicating if the quest has started.

```java
int getStartedSetting()
```

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

### Get Starting Experience

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/skills/SkillTracker.html

Returns the experience value of a skill at the moment tracking began. This is the baseline experience from which gains are measured.

```java
public static int getStartExperience(Skill s)

```

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

### Get Start Tile

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/web/WebPathQuery.html

Retrieves the starting tile for the path query.

```java
public Tile getFrom()
```

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

### Get Start Tile

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/web/WebPathQuery.html

Retrieves the starting tile for the path query.

```APIDOC
## getFrom

### Description
Gets the starting `Tile` for the path query.

### Method
Instance

### Returns
- `Tile`: The starting tile.
```

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

### Get Start Node

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/CustomWebPath.html

Retrieves the first AbstractWebNode in the CustomWebPath.

```java
AbstractWebNode getStart()
```

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

### Get Mountain Guide Nodes Method

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/impl/pathaware/MountainGuideWebNode.html

Retrieves a list of all available MountainGuideWebNode instances. This is a static method.

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

```

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

### Set Start Tile

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/web/WebPathQuery.html

Sets the starting tile for the path query.

```java
public void setFrom(Tile from)
```

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

### Get Starting Level

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/skills/SkillTracker.html

Retrieves the level of a skill at the point when tracking was started. This provides the initial level for comparison with current progress.

```java
public static int getStartLevel(Skill s)

```

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

### Example Usage of LocalPathFinder

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/local/LocalPathFinder.html

Demonstrates how to use LocalPathFinder to calculate a path and then walk it. This example shows the typical workflow when pathfinding is needed directly.

```java
LocalPath path = LocalPathFinder.getLocalPathFinder().calculate(Players.getLocal().getServerTile(), new Tile(1234, 2345, 1));

if (path != null && !path.isEmpty()) {
	Logger.log("We found a path: " + path);
	path.walk();
} else {
	Logger.warn("No path found!");
}
```

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

### Start Tracking All Skills

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/skills/SkillTracker.html

Begins tracking experience and level progress for all skills. If tracking has already started, it will be reset.

```java
public static void start()

```

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

### Getting Started Setting ID

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/quest/book/PaidQuest.html

Retrieves the setting ID that indicates if a PaidQuest has been started. Implements the getStartedSetting() method from the Quest interface.

```java
public int getStartedSetting()

Specified by:
    `getStartedSetting` in interface `Quest`
```

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

### Set Start Tile

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/web/WebPathQuery.html

Sets the starting tile for the path query.

```APIDOC
## setFrom

### Description
Sets the starting `Tile` for the path query.

### Parameters
#### Path Parameters
- **from** (Tile) - Required - The starting tile.
```

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

### ScriptManager Method: start with script name and args

Source: https://dreambot.org/javadocs/org/dreambot/api/script/ScriptManager.html

Starts a script by its name and provides arguments.

```java
public void start(java.lang.String scriptName,
                  java.lang.String... args)
```

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

### CameraEvent start Method

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/event/CameraEvent.html

Initiates the execution of the camera event. Returns true if the event started successfully, false otherwise.

```java
public boolean start()
```

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

### Get Starting Skill Level

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/skills/SkillTracker.html

Retrieves the initial level of a specified skill. Requires the Skill enum as input.

```java
public static int getStartLevel(Skill s)
```

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

### Get Start Node of Custom Path

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/CustomWebPath.html

Retrieves the first web node in this custom path.

```java
public AbstractWebNode getStart()
```

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

### Start Timer

Source: https://dreambot.org/javadocs/org/dreambot/api/utilities/Timer.html

Starts or restarts the timer from the beginning.

```java
public void start()
```

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

### onStart Method (With Parameters)

Source: https://dreambot.org/javadocs/org/dreambot/api/script/AbstractScript.html

This method is invoked when the script is initiated and receives parameters as a String array.

```java
public void onStart(java.lang.String... params)
```

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

### WorldBuilder withFreshStart()

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/world/World.WorldBuilder.html

Sets the fresh start status for the World. Use this to indicate if the world is a fresh start server.

```java
public
World.WorldBuilder
withFreshStart(boolean freshStart)
```

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

### WelcomeScreenSolver Constructor

Source: https://dreambot.org/javadocs/org/dreambot/api/randoms/WelcomeScreenSolver.html

Initializes a new instance of the WelcomeScreenSolver class.

```APIDOC
## WelcomeScreenSolver()

### Description
Initializes a new instance of the WelcomeScreenSolver class.

### Method
```java
public WelcomeScreenSolver()
```
```

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

### Get Starting Plane Method

Source: https://dreambot.org/javadocs/org/dreambot/api/input/mouse/destination/impl/EntityDestination.html

Retrieves the starting plane for the entity destination. This method is part of the AbstractMouseDestination class.

```java
public int getStartingPlane()

```

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

### StandardKeyboardAlgorithm Constructor

Source: https://dreambot.org/javadocs/org/dreambot/api/input/keyboard/StandardKeyboardAlgorithm.html

Initializes a new instance of the StandardKeyboardAlgorithm class.

```APIDOC
## StandardKeyboardAlgorithm()

### Description
Initializes a new instance of the StandardKeyboardAlgorithm class.

### Method
```java
public StandardKeyboardAlgorithm()
```
```

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

### getStart()

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/CustomWebPath.html

Retrieves the starting node of this custom web path.

```APIDOC
## getStart()

### Description
Retrieves the starting node of this custom web path.

### Method
```
public AbstractWebNode getStart()
```
```

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

### BankPinSolver onStart Method

Source: https://dreambot.org/javadocs/org/dreambot/api/randoms/BankPinSolver.html

Runs once when the random solver first activates. This method can be optionally overridden and is inherited from the RandomSolver class.

```java
public void onStart()
```

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

### ScriptManager Method: start with script class

Source: https://dreambot.org/javadocs/org/dreambot/api/script/ScriptManager.html

Starts a script using its class object.

```java
public void start(java.lang.Class<? extends AbstractScript> scriptClass)
```

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

### getStartTile

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/obstacle/PathObstacle.html

Retrieves the starting tile for the obstacle.

```APIDOC
## getStartTile

### Description
Gets the start tile for the obstacle.

### Returns
* Tile - the start tile of the obstacle
```

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

### Get Start Cycle

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/graphics/Projectile.html

Retrieves the cycle at which the projectile begins its trajectory.

```Java
public
int
getStartCycle()
```

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

### Get Direction Between Tiles

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/PathFinder.html

Calculates the direction string from a starting tile to an ending tile.

```java
public java.lang.String getDirection(
    int sx,
    int sy,
    int ex,
    int ey
)
```

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

### setShouldStart

Source: https://dreambot.org/javadocs/org/dreambot/core/Instance.html

Sets whether the script should start.

```APIDOC
## setShouldStart

### Description
Sets whether the script should start.

### Method
static void

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Parameters
* **shouldStart** (boolean) - Description of the parameter is not provided in the source.
```

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

### Get Absolute Y Coordinate

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/ViewportTools.html

Retrieves the absolute Y-coordinate on the game canvas. No setup required.

```java
public static int getAbsoluteYCoordinate()
```

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

### Set Start Tile for ClimbableObstacleBuilder

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/obstacle/impl/ClimbableObstacle.ClimbableObstacleBuilder.html

Sets the starting tile for the climbable obstacle. Returns the builder instance for chaining.

```java
public ClimbableObstacle.ClimbableObstacleBuilder startTile(Tile startTile)
```

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

### Set as Entry Point

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/TileObstacle.html

Marks this obstacle as an entry point.

```java
public void setEntry()
```

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

### Get Absolute X Coordinate

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/ViewportTools.html

Retrieves the absolute X-coordinate on the game canvas. No setup required.

```java
public static int getAbsoluteXCoordinate()
```

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

### Tile Constructors

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/map/Tile.html

Demonstrates the different ways to instantiate a Tile object.

```java
public Tile()

```

```java
public Tile(int x,
            int y)

```

```java
public Tile(int x,
            int y,
            int z)

```

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

### Get Elapsed Time

Source: https://dreambot.org/javadocs/org/dreambot/api/utilities/Timer.html

Returns the amount of time that has passed since the timer started or was last reset, in milliseconds.

```java
public long elapsed()
```

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

### Start Tracking Multiple Skills

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/skills/SkillTracker.html

Begins tracking progress for one or more specified skills. If tracking has already started for any of these skills, it will be reset.

```java
public static void start(Skill... skill)

```

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

### EntranceWebNode Constructors

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/impl/EntranceWebNode.html

Initializes an EntranceWebNode with specified coordinates, entity name, and action. Use these constructors to create custom web nodes for navigation.

```java
public EntranceWebNode
(int x,
                       int y)
```

```java
public EntranceWebNode
(int x,
                       int y,
                       int z)
```

```java
public EntranceWebNode
(int x,
                       int y,
                       int z,
                       java.lang.String entityName,
                       java.lang.String action)
```

```java
public EntranceWebNode
(Tile tile,
                       java.lang.String entityName,
                       java.lang.String action)
```

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

### Initialize Connections Method

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/AbstractWebNode.html

Initializes the web node connections with a given list of nodes.

```java
public	void	initializeConnections	(java.util.List<AbstractWebNode>	connections)
```

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

### Get Skill Start Time

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/skills/SkillTracker.html

Retrieves the timestamp (in milliseconds) when tracking for a specific skill was initiated. This is crucial for calculating rates and time-to-level estimates.

```java
public static long getStartTime(Skill s)

```

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

### EntranceWebNode Constructors

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/impl/EntranceWebNode.html

Constructors for creating an EntranceWebNode. These allow initialization with coordinates, entity names, actions, and tiles.

```APIDOC
## EntranceWebNode Constructors

### EntranceWebNode(int x, int y)

Initializes a new EntranceWebNode with the specified x and y coordinates.

### EntranceWebNode(int x, int y, int z)

Initializes a new EntranceWebNode with the specified x, y, and z coordinates.

### EntranceWebNode(int x, int y, int z, String entityName, String action)

Initializes a new EntranceWebNode with the specified coordinates, entity name, and action.

### EntranceWebNode(Tile tile, String entityName, String action)

Initializes a new EntranceWebNode with the specified Tile, entity name, and action.
```

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

### Get Play Now Button Rectangle

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/login/LoginUtility.html

Returns the rectangular bounds of the 'Play Now' button. This is typically used to start the game or proceed to the main interface.

```java
public static java.awt.Rectangle getPlayNowButton()
```

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

### onSolverStart Method

Source: https://dreambot.org/javadocs/org/dreambot/api/script/AbstractScript.html

Called during the random solver reset phase, before the solver's onStart method is executed. Returning true allows the solver to start.

```java
public boolean onSolverStart(RandomSolver solver)
```

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

### Check Level Up Guide List Enabled

Source: https://dreambot.org/javadocs/org/dreambot/api/ClientSettings.html

Checks if the guide list is shown after level-up is enabled.

```Java
public static boolean isLevelUpGuideListEnabled()
```

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

### Get Quick Prayers List

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/prayer/Prayers.html

Returns a list of all prayers that are currently selected as quick prayers. This helps in understanding the configured quick prayer setup.

```Java
public static java.util.List<Prayer> getQuickPrayers()
```

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

### open()

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/container/impl/Inventory.html

Opens the player's inventory interface.

```APIDOC
## open()

### Description
Opens the player's inventory interface if it is not already open.

### Method
static boolean

### Returns
`true` if the inventory was opened or already open, `false` otherwise.
```

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

### setStartTile

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/obstacle/PathObstacle.html

Sets the starting tile for the obstacle.

```APIDOC
## setStartTile

### Description
Sets the start tile of the obstacle.

### Parameters
* **start** (Tile) - Required - Tile expected to be at before solving the obstacle
```

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

### Get Play Now Try Again Button Rectangle

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/login/LoginUtility.html

Returns the rectangular bounds of the 'Play Now Try Again' button. This button likely appears after a failed attempt to start the game.

```java
public static java.awt.Rectangle getPlayNowTryAgainButton()
```

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

### WebPathQueryBuilder from() Method

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/web/WebPathQuery.WebPathQueryBuilder.html

Sets the starting tile for the path query. Returns the builder instance for chaining.

```java
public WebPathQuery.WebPathQueryBuilder from (Tile from)
```

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

### getHeuristicCost(int x, int y, int tx, int ty)

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/local/LocalPathFinder.html

Gets the heuristic cost for the given start location (x, y) to the target location (tx, ty).

```APIDOC
## getHeuristicCost(int x, int y, int tx, int ty)

### Description
Get the heuristic cost for the given location.

### Method
`float getHeuristicCost(int x, int y, int tx, int ty)`

### Parameters
#### Path Parameters
- **x** (int) - The starting X coordinate.
- **y** (int) - The starting Y coordinate.
- **tx** (int) - The destination X coordinate.
- **ty** (int) - The destination Y coordinate.

### Returns
The heuristic cost as a `float`.
```

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

### Get Gained Experience Per Hour

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/skills/SkillTracker.html

Calculates and returns the experience gained per hour for a given skill, based on its start time and current progress. This provides an average rate of experience gain.

```java
public static int getGainedExperiencePerHour(Skill s)

```

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

### open

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/container/impl/equipment/Equipment.html

Opens the equipment tab.

```APIDOC
## open

### Description
Opens the equipment tab.

### Method
```java
public static boolean open()
```

### Returns
true if successfully opened or already open.
```

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

### Get Formatted Clan Member Name

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/clan/guild/ClanMember.html

Returns a formatted version of the clan member's name. Non-alphabetical and non-numeric characters are replaced with spaces. For example, 'jack_sparrow' would be returned as 'jack sparrow'.

```java
public java.lang.String getName()
```

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

### getHeuristicCost(int x, int y, int z, int tx, int ty, int tz)

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/local/LocalPathFinder.html

Gets the heuristic cost for the given start location (x, y, z) to the target location (tx, ty, tz).

```APIDOC
## getHeuristicCost(int x, int y, int z, int tx, int ty, int tz)

### Description
Get the heuristic cost for the given location.

### Method
`float getHeuristicCost(int x, int y, int z, int tx, int ty, int tz)`

### Parameters
#### Path Parameters
- **x** (int) - The starting X coordinate.
- **y** (int) - The starting Y coordinate.
- **z** (int) - The starting Z coordinate.
- **tx** (int) - The destination X coordinate.
- **ty** (int) - The destination Y coordinate.
- **tz** (int) - The destination Z coordinate.

### Returns
The heuristic cost as a `float`.
```

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

### Get Destination Coordinates

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/world/WorldEntity.html

Gets the coordinates of the entity destination. You can >> 7 on the x/y values to get the Tile location.

```java
public int[] getDestinationCoordinates()
```

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

### Get Overworld Coordinates

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/world/WorldEntity.html

Gets the coordinates of the entity on the overworld map. You can >> 7 on the x/y values to get the Tile location.

```java
public int[] getOverworldCoordinates()
```

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

### StandardKeyboardAlgorithm Constructor

Source: https://dreambot.org/javadocs/org/dreambot/api/input/keyboard/StandardKeyboardAlgorithm.html

Initializes a new instance of the StandardKeyboardAlgorithm class.

```Java
public StandardKeyboardAlgorithm()
```

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

### connectToStart(int nodeIndex)

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/CustomWebPath.html

Connects the start of this custom path to a specific node within the path. This connection is established when the path is attached to the web.

```APIDOC
## connectToStart(int nodeIndex)

### Description
Connects the start of this path to the provided node index when `attachToWeb()` or `WebFinder.addCustomWebPath(CustomWebPath)` is called for this path. This method does NOT add this path to the full global web.

### Method
```
public void connectToStart(int nodeIndex)
```

### Parameters
* **nodeIndex** (`int`) - The index of the `AbstractWebNode` to attach this path's start to.
```

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

### Get Y Coordinate Method

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/AbstractWebNode.html

Gets the Y coordinate of the object.

```java
public	int	getY	()
```

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

### Check if Quest is Started

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/quest/book/Quest.html

Checks if the quest has been started.

```java
default boolean isStarted()
```

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

### getExperience()

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/skills/Skill.html

Gets the current experience points for the skill.

```APIDOC
### Method Detail

#### getExperience

```java
public int getExperience()
```

Gets the current experience points for the skill.
```

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

### Get Indices Count

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/interactive/Model.html

Gets the count of indices for the model.

```java
public int getIndicesCount()
```

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

### get

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/container/impl/bank/Bank.html

Gets the first Item that matches the given Filter.

```APIDOC
## get

### Description
Gets the first `Item` that matches the given `Filter`.

### Method
static @Nullable Item

### Endpoint
get(Filter<Item> filter)

### Parameters
#### Path Parameters
- **filter** (Filter<Item>) - Required - Filter to match the item against

### Returns
`Item` that matches the filter or null
```

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

### readyToLoad

Source: https://dreambot.org/javadocs/org/dreambot/api/Client.html

Checks if the client is ready to load.

```APIDOC
## readyToLoad

### Description
Checks if the client is ready to load.

### Method
GET

### Endpoint
/client/readyToLoad

### Parameters
None

### Response
#### Success Response (200)
- **readyToLoad** (boolean) - True if the client is ready to load, false otherwise.

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

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

### Connect Start to Specific Node Index

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/CustomWebPath.html

Establishes a connection from the start of this CustomWebPath to a specific node identified by its index. This connection is made when the path is attached to the web.

```java
public void connectToStart(int nodeIndex)
```

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

### Get Vertex Count

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/interactive/Model.html

Gets the total number of vertices in the model.

```java
public int getVertexCount()
```

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

### Basic Walking to a Tile

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/impl/Walking.html

This snippet demonstrates how to walk to a specific tile. It checks the distance to the destination and ensures walking is enabled before initiating the walk. It's recommended to call this repeatedly in your script's onLoop until you are close to your destination.

```java
Tile destination = new Tile(3270, 3167);

if (destination.distance() > 5 && Walking.shouldWalk()) {
    Walking.walk(destination);
}
```

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

### Get Z Coordinate Method

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/AbstractWebNode.html

Gets the Z coordinate of the object.

```java
public	int	getZ	()
```

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

### Get Welcome Screen Solver

Source: https://dreambot.org/javadocs/org/dreambot/api/randoms/RandomManager.html

Retrieves the specific solver designed to handle the welcome screen.

```Java
public WelcomeScreenSolver getWelcomeScreenSolver()
```

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

### Get X Coordinate Method

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/AbstractWebNode.html

Gets the X coordinate of the object.

```java
public	int	getX	()
```

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

### EntranceWebNode Methods

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/impl/EntranceWebNode.html

Methods for interacting with and retrieving information about an EntranceWebNode, including execution, requirements checking, and node type retrieval.

```APIDOC
## EntranceWebNode Methods

### getType()

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

**Overrides**: `getType` in class `AbstractWebNode`

**Returns**: The type of web node.

### execute(AbstractWebNode nextNode)

**Description**: Handles the execution logic for the web node, potentially involving walking or entity interaction, considering the next node in the path.

### execute()

**Description**: This is called by the walker to handle the actual walking, entity handling, or whatever else needed to get past this node.

**Overrides**: `execute` in class `AbstractWebNode`

**Returns**: `true` if the node is successfully handled, `false` otherwise.

### hasRequirements()

**Description**: This is used to determine during path finding if the current player can use this node.

**Overrides**: `hasRequirements` in class `AbstractWebNode`

**Returns**: `true` if it's usable by the current player, `false` otherwise.

### 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.
```

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

### WorldBuilder.withFreshStart()

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/world/World.WorldBuilder.html

Sets the FreshStart status for the World being built.

```APIDOC
## withFreshStart(boolean freshStart)

### Description
Sets the FreshStart status for the World being built.

### Method
`withFreshStart(boolean freshStart)`

### Parameters
#### Path Parameters
- **freshStart** (boolean) - Description for freshStart parameter
```

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

### Get Crosshair State

Source: https://dreambot.org/javadocs/org/dreambot/api/input/Mouse.html

Gets the current crosshair state of the mouse.

```java
public static	CrosshairState	getCrosshairState()
```

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

### initializeConnections(List<AbstractWebNode> connections)

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/AbstractWebNode.html

Initializes the connections for this web node. This method is generally reserved for internal use; consider using `addDualConnections` for connecting new nodes.

```APIDOC
## initializeConnections(List<AbstractWebNode> connections)

### Description
Initializes the web node connections. Generally reserved for internal use. See `addDualConnections(AbstractWebNode...)` for connecting new nodes.

### Parameters
- `connections` (List<AbstractWebNode>) - Required - The list of connections to initialize.
```

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

### Get Current Mouse Y Coordinate

Source: https://dreambot.org/javadocs/org/dreambot/api/input/Mouse.html

Gets the current mouse Y coordinate.

```java
public static	int	getY()
```

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

### open

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/container/impl/Shop.html

Opens the shop interface, optionally by name or ID.

```APIDOC
## open ()

### Description
Attempts to open the default or currently targeted shop interface.

### Method
static boolean

### Returns
- **boolean** - True if the shop was successfully opened, false otherwise.
```

```APIDOC
## open (String shopName)

### Description
Attempts to open a specific shop interface by its name.

### Method
static boolean

### Parameters
#### Path Parameters
- **shopName** (String) - Required - The name of the shop to open.

### Returns
- **boolean** - True if the shop was successfully opened, false otherwise.
```

```APIDOC
## open (int shopId)

### Description
Attempts to open a specific shop interface by its ID.

### Method
static boolean

### Parameters
#### Path Parameters
- **shopId** (int) - Required - The ID of the shop to open.

### Returns
- **boolean** - True if the shop was successfully opened, false otherwise.
```

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

### Toggle Level Up Guide List

Source: https://dreambot.org/javadocs/org/dreambot/api/ClientSettings.html

Toggles whether the guide list is shown after level-up is enabled. Returns true if the operation succeeds.

```Java
public static boolean toggleLevelUpGuideList(boolean on)
```

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

### Create and Add Web Node

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/web/WebFinder.html

Creates and adds a new BasicWebNode at the provided tile and connects it to the nearest web node. Returns the created node if successful, otherwise null.

```java
public @Nullable AbstractWebNode createAndAddNode(@NonNull Tile newNodeTarget)
```

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

### getConfigs

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/settings/PlayerSettings.html

Retrieves all player settings as an array of integers.

```APIDOC
## getConfigs

### Description
Gets player settings.

### Method
static int[]

### Response
#### Success Response (200)
- **return value** (int[]) - player settings
```

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

### Get GroundItem Renderable Height

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/items/GroundItem.html

Gets the renderable height of the ground item.

```java
public int getRenderableHeight()
```

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

### Get Spot Animation Cycle

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/graphics/SpotAnimation.html

Gets the current cycle of the spot animation.

```java
public int getCycle()
```

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

### connectStartToClosestNode()

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/CustomWebPath.html

Connects the start of this custom path to the nearest `BasicWebNode`. This is useful for automatically linking the path to the existing web structure.

```APIDOC
## connectStartToClosestNode()

### Description
Connects the start of this path to the nearest `BasicWebNode` when `attachToWeb()` or `WebFinder.addCustomWebPath(CustomWebPath)` is called for this path. This method does NOT add this path to the full global web.

### Method
```
public boolean connectStartToClosestNode()
```

### Returns
* `true` if there's a node within 32 tiles to attach it to, `false` otherwise.
```

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

### Get Overworld Tile

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/world/WorldEntity.html

Gets the Tile of this entity on the top level map.

```java
public Tile getOverworldTile()
```

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

### Get Tile Reference Method

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/AbstractWebNode.html

Gets the TileReference object for this web node.

```java
public	TileReference	getTileReference	()
```

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

### open()

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/widgets/GameMenu.html

Opens the game menu. The specific behavior might depend on the game context.

```APIDOC
## open()

### Description
Opens the game menu.

### Returns
- **boolean** - Indicates if the menu was successfully opened.
```

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

### Get Tile Method

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/AbstractWebNode.html

Gets the Tile object associated with this web node.

```java
public	Tile	getTile	()
```

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

### Open Settings Interface

Source: https://dreambot.org/javadocs/org/dreambot/api/ClientSettings.html

Opens the settings interface.

```java
public static boolean open()
```

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

### Get Grid Y Coordinate Method

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/AbstractWebNode.html

Gets the local grid Y coordinate of the object.

```java
public	int	getGridY	()
```

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

### Get Destination Distance

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/impl/Walking.html

Gets the current distance from the player's destination.

```java
public static int getDestinationDistance()

```

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

### Example Usage of ClimbableObstacleBuilder

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/obstacle/impl/ClimbableObstacle.ClimbableObstacleBuilder.html

Demonstrates how to use the ClimbableObstacleBuilder to construct a new climbable obstacle with specified properties.

```java
new ClimbableObstacle.ClimbableObstacleBuilder("Staircase","Climb-up").createClimbableObstacle();
```

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

### Get Entities on Cursor

Source: https://dreambot.org/javadocs/org/dreambot/api/input/Mouse.html

Gets a list of entities that the cursor is currently hovering over.

```java
public static	java.util.List<Entity>	getEntitiesOnCursor()
```

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

### SpotAnimation Constructor

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/graphics/SpotAnimation.html

Initializes a new SpotAnimation wrapper with a reference to a Runelite ActorSpotAnim.

```java
public SpotAnimation(net.runelite.api.ActorSpotAnim ref)
```

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

### Get Last Clicked Y Coordinate

Source: https://dreambot.org/javadocs/org/dreambot/api/input/Mouse.html

Gets the last clicked y position by the client.

```java
public static	int	getLastClickedY()
```

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

### Get Last Clicked Position

Source: https://dreambot.org/javadocs/org/dreambot/api/input/Mouse.html

Gets the last clicked position by the client.

```java
public static	java.awt.Point	getLastClicked()
```

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

### Walk to Tile with Pathfinding

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/impl/Walking.html

Walks to the given tile using a combination of web and local pathfinders, handling obstacles. Returns true if progress was made or the tile was reached. Example usage provided.

```java
public static boolean walk(@NonNull Tile tile)

Walks to the given tile, using a combination of web and local pathfinders, handling obstacles along the way as necessary.
If you find any obstacles that aren't handled, take a look at `LocalPathFinder` and `WebFinder` for adding custom obstacles or web nodes.
Example usage: 

 Tile tile = new Tile(1500, 1500);
 if (Walking.shouldWalk(5) && Walking.walk(tile)) {
     Sleep.sleep(1000, 1500);
 }
 
```

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

### DismissBankTutorial Constructor

Source: https://dreambot.org/javadocs/org/dreambot/api/randoms/DismissBankTutorial.html

Initializes a new instance of the DismissBankTutorial class.

```APIDOC
## DismissBankTutorial()

### Description
Initializes a new instance of the DismissBankTutorial class.

### Constructor
`public DismissBankTutorial()`
```

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

### ScriptManager Method: start with ScriptWrapper

Source: https://dreambot.org/javadocs/org/dreambot/api/script/ScriptManager.html

Starts a script using a ScriptWrapper object.

```java
public void start(org.dreambot.internal.scripts.ScriptWrapper scriptWrapper)
```

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

### all

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/container/impl/equipment/Equipment.html

Retrieves a list of all items currently in the equipment interface.

```APIDOC
## all

### Description
Retrieves a list of all items currently in the equipment interface.

### Method
```java
public static @NonNull java.util.List<@Nullable Item> all()
```
```

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

### DestructableObstacleBuilder Set Start Tile

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/obstacle/impl/DestructableObstacle.DestructableObstacleBuilder.html

Sets the starting tile for the destructable obstacle.

```java
public DestructableObstacle.DestructableObstacleBuilder startTile(Tile startTile)
```

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

### MiniQuest Enum Constant Example

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/quest/book/MiniQuest.html

Example of a MiniQuest enum constant declaration.

```java
public static final
MiniQuest ALFRED_GRIMHANDS_BARCRAWL
```

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

### WorldBuilder withHost()

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/world/World.WorldBuilder.html

Sets the host for the World. Use this to specify the server host address.

```java
public
World.WorldBuilder
withHost(java.lang.String host)
```

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

### Initialize StatusBar

Source: https://dreambot.org/javadocs/org/dreambot/api/utilities/StatusBar.html

Constructs a new StatusBar instance. This is typically not called directly as the methods are static.

```java
public StatusBar()
```

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

### Get Items from Trade Screen (Java)

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/trade/Trade.html

Retrieves all items from either your or the other player's trade screen. Specify 'true' for 'mine' to get your items, or 'false' to get the other player's items.

```java
public static @NonNull Item @Nullable [] getItems(boolean mine)
```

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

### Get Original Y Coordinates

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/interactive/Model.html

Gets the array of original Y coordinates for the model's vertices.

```java
public int[] getOriginalY()
```

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

### WorldBuilder.withBeta()

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/world/World.WorldBuilder.html

Sets the Beta status for the World being built.

```APIDOC
## withBeta(boolean beta)

### Description
Sets the Beta status for the World being built.

### Method
`withBeta(boolean beta)`

### Parameters
#### Path Parameters
- **beta** (boolean) - Description for beta parameter
```

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

### BankPinConfirmSolver Constructor

Source: https://dreambot.org/javadocs/org/dreambot/api/randoms/BankPinConfirmSolver.html

Initializes a new instance of the BankPinConfirmSolver class.

```APIDOC
## BankPinConfirmSolver()

### Description
Initializes a new instance of the BankPinConfirmSolver class.

### Constructor
`public BankPinConfirmSolver()`
```

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

### Get Entity Renderable Height

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/interactive/Entity.html

Abstract method to get the renderable height of the entity.

```java
public abstract int getRenderableHeight()
```

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

### Perform Login

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/login/LoginUtility.html

Initiates the login process using the currently set account details. This method is used when account details have been pre-configured.

```java
public static RSLoginResponse login()
```

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

### Get Destination Tile

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/world/WorldEntity.html

Gets the destination Tile of this entity on the top level map.

```java
public Tile getDestination()
```

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

### LoginSolver Constructors

Source: https://dreambot.org/javadocs/org/dreambot/api/randoms/LoginSolver.html

Provides details on how to instantiate the LoginSolver, including a default constructor and one that allows overriding the event name.

```APIDOC
## LoginSolver()

### Description
Default constructor for the LoginSolver.

### Constructor
```java
public LoginSolver()
```
```

```APIDOC
## LoginSolver(String override)

### Description
A constructor that allows you to override the event name. This is used for extending our login solver.

### Parameters
- **override** (java.lang.String) - Required - name of your random event

### Constructor
```java
public LoginSolver(java.lang.String override)
```
```

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

### Get Tile Grid Y Position

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/map/Map.html

Gets the Y-coordinate of a tile within the region grid.

```java
public static int getGridY(Tile tile)
```

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

### HoldKey Constructors

Source: https://dreambot.org/javadocs/org/dreambot/api/input/event/impl/keyboard/type/HoldKey.html

Demonstrates the various ways to instantiate a HoldKey object, allowing for character or key specification, release conditions, timeouts, and key locations.

```java
public HoldKey(char character)
```

```java
public HoldKey(char character,
               Condition release)
```

```java
public HoldKey(char character,
               Condition release,
               long timeout)
```

```java
public HoldKey(Key key)
```

```java
public HoldKey(Key key,
               Condition release)
```

```java
public HoldKey(Key key,
               Condition release,
               long timeout)
```

```java
public HoldKey(Key key,
               Condition release,
               long timeout,
               KeyLocation location)
```

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

### Get Current Mouse Position

Source: https://dreambot.org/javadocs/org/dreambot/api/input/Mouse.html

Gets the current mouse position as a Point object.

```java
public static	java.awt.Point	getPosition()
```

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

### WorldBuilder.withHost()

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/world/World.WorldBuilder.html

Sets the host for the World being built.

```APIDOC
## withHost(String host)

### Description
Sets the host for the World being built.

### Method
`withHost(String host)`

### Parameters
#### Path Parameters
- **host** (String) - Description for host parameter
```

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

### Get Current Mouse X Coordinate

Source: https://dreambot.org/javadocs/org/dreambot/api/input/Mouse.html

Gets the current mouse X coordinate.

```java
public static	int	getX()
```

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

### ShipWebNode Constructor with Requirements

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/impl/pathaware/ShipWebNode.html

Initializes a ShipWebNode with starting and ending tiles, entity details, and specific requirements.

```java
public	ShipWebNode	(Tile	startingTile,
                   Tile	endingTile,
                   java.lang.String	entity,
                   java.lang.String	action,
                   Condition	requirements)
```

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

### Get Renderable Height

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/interactive/Character.html

Gets the renderable height of this character. This value is specified in the Entity class.

```java
public int getRenderableHeight()

```

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

### run Method

Source: https://dreambot.org/javadocs/org/dreambot/api/input/event/impl/mouse/type/EnterEvent.html

Executes the mouse event, simulating the mouse entering the specified area.

```APIDOC
## run()

### Description
Executes the mouse event.

### Method
`public void run()`
```

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

### Get Hull Bounds with Specified Scale

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/interactive/Model.html

Gets the hull bounds of the model with a specified scale.

```java
public java.awt.Shape getHullBounds(float scale)
```

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

### open

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/container/impl/Inventory.html

Opens the inventory interface.

```APIDOC
## open

### Description
Opens the inventory interface.

### Method
GET (simulated)

### Endpoint
Inventory.open()

### Response
#### Success Response (200)
- **boolean** - True if the inventory was opened successfully, false otherwise.
```

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

### Start Tracking All Skills with Reset Option

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/skills/SkillTracker.html

Begins tracking all skills, with an option to reset existing tracked values. Use this if you need to ensure a fresh start for all skill tracking.

```java
public static void start(boolean reset)

```

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

### Get Z Coordinate

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/graphics/Projectile.html

Gets the Z coordinate of the projectile. This method is inherited from the Locatable interface.

```Java
public
int
getZ()
```

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

### AgilityWebNode Constructor with Tile

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/impl/AgilityWebNode.html

Initializes an AgilityWebNode using a Tile object, encapsulating all coordinate information.

```java
public	AgilityWebNode	(Tile	tile)
```

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

### Get Real World ID (Deprecated)

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/world/World.html

Deprecated method to get the real ID of the world.

```java
@Deprecated
public int getRealID() {
}
```

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

### Get Grid X Coordinate Method

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/AbstractWebNode.html

Gets the local grid X coordinate of the object.

```java
public	int	getGridX	()
```

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

### Get Tile Grid X Position

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/map/Map.html

Gets the X-coordinate of a tile within the region grid.

```java
public static int getGridX(Tile tile)
```

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

### BankWebNode Constructor (Tile)

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/impl/BankWebNode.html

Initializes a new BankWebNode using a Tile object.

```Java
public BankWebNode(Tile tile)
```

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

### Equipment Methods

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/container/impl/equipment/Equipment.html

This section details the various methods available for interacting with the player's equipment.

```APIDOC
## add

### Description
Adds an item to the equipment.

### Method Signature
`static void add(int index, Item t)`
`static boolean add(Item t)`
```

```APIDOC
## all

### Description
Retrieves a list of all items in the equipment, optionally filtered.

### Method Signature
`static @NonNull java.util.List<@Nullable Item> all()`
`static @NonNull java.util.List<@NonNull Item> all(@NonNull Filter<Item> filter)`
```

```APIDOC
## capacity

### Description
Gets the capacity for the equipment interface.

### Method Signature
`static int capacity()`
```

```APIDOC
## contains

### Description
Checks if the equipment contains specific items based on ID, filter, or name.

### Method Signature
`static boolean contains(int id)`
`static boolean contains(int[] ids)`
`static boolean contains(@NonNull java.lang.Object o)`
`static boolean contains(@NonNull Filter<Item> filter)`
`static boolean contains(java.lang.Integer... ids)`
`static boolean contains(java.lang.String string)`
`static boolean contains(java.lang.String... names)`
```

```APIDOC
## containsAll

### Description
Checks if the equipment contains all specified items.

### Method Signature
`static boolean containsAll(int... ids)`
`static boolean containsAll(@NonNull java.util.Collection<?> collection)`
`static boolean containsAll(java.lang.String... names)`
```

```APIDOC
## count

### Description
Counts the number of items in the equipment that match a given criteria.

### Method Signature
`static int count(int id)`
`static int count(@NonNull Filter<Item> filter)`
`static int count(java.lang.String name)`
```

```APIDOC
## emptySlotCount

### Description
Gets the number of empty slots in the equipment.

### Method Signature
`static int emptySlotCount()`
```

```APIDOC
## equip

### Description
Equips an item to a specified equipment slot based on IDs, filter, or names.

### Method Signature
`static boolean equip(@NonNull EquipmentSlot slot, int[] ids)`
`static boolean equip(@NonNull EquipmentSlot slot, @NonNull Filter<Item> filter)`
`static boolean equip(@NonNull EquipmentSlot slot, java.lang.Integer... ids)`
`static boolean equip(@NonNull EquipmentSlot slot, java.lang.String... names)`
```

```APIDOC
## except

### Description
Retrieves a list of items in the equipment that do not match the given filter.

### Method Signature
`static @NonNull java.util.List<@NonNull Item> except(@NonNull Filter<Item> filter)`
```

```APIDOC
## fullSlotCount

### Description
Gets the number of slots in the equipment that contain items.

### Method Signature
`static int fullSlotCount()`
```

```APIDOC
## get

### Description
Retrieves an item from the equipment based on ID, filter, or name.

### Method Signature
`static @Nullable Item get(int id)`
`static @Nullable Item get(int[] ids)`
`static @Nullable Item get(@NonNull Filter<Item> filter)`
`static @Nullable Item get(java.lang.Integer... ids)`
`static @Nullable Item get(java.lang.String name)`
`static @Nullable Item get(java.lang.String... names)`
```

```APIDOC
## getFirstEmptySlot

### Description
Gets the index of the first empty slot in the equipment.

### Method Signature
`static int getFirstEmptySlot()`
```

```APIDOC
## getFirstFullSlot

### Description
Gets the index of the first full slot in the equipment.

### Method Signature
`static int getFirstFullSlot()`
```

```APIDOC
## getIdForSlot

### Description
Gets the ID of the item in the specified equipment slot.

### Method Signature
`static int getIdForSlot(int slot)`
`static int getIdForSlot(@NonNull EquipmentSlot slot)`
```

```APIDOC
## getItemInSlot

### Description
Gets the item located in the specified equipment slot.

### Method Signature
`static @Nullable Item getItemInSlot(int slot)`
`static @Nullable Item getItemInSlot(@NonNull EquipmentSlot equipmentSlot)`
```

```APIDOC
## getNameForSlot

### Description
Gets the name of the item in the specified equipment slot.

### Method Signature
`static @NonNull java.lang.String getNameForSlot(int slot)`
`static @NonNull java.lang.String getNameForSlot(@NonNull EquipmentSlot slot)`
```

```APIDOC
## getRaw

### Description
Retrieves the raw list of items in the equipment.

### Method Signature
`static java.util.List<Item> getRaw()`
```

```APIDOC
## getSlotBounds

### Description
Gets the rectangular bounds of the widget child for the given equipment slot.

### Method Signature
`static @Nullable java.awt.Rectangle getSlotBounds(@NonNull EquipmentSlot slot)`
```

```APIDOC
## getSlotForItem

### Description
Gets the equipment slot for a given item filter.

### Method Signature
`static @Nullable EquipmentSlot getSlotForItem(@NonNull Filter<Item> filter)`
```

```APIDOC
## getWidgetForSlot

### Description
Gets the widget child for the specified equipment slot.

### Method Signature
`static @Nullable WidgetChild getWidgetForSlot(@NonNull EquipmentSlot slot)`
```

```APIDOC
## interact

### Description
Interacts with the specified equipment slot using the given action. Opens the Equipment tab if necessary.

### Method Signature
`static boolean interact(@NonNull EquipmentSlot slot, @Nullable java.lang.String action)`
```

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

### Get Deprecated Crosshair Color ID

Source: https://dreambot.org/javadocs/org/dreambot/api/input/Mouse.html

Deprecated method for getting the crosshair color ID.

```java
@Deprecated
public static	int	getCrosshairColorID()
```

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

### readyToEnterPrice

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/grandexchange/GrandExchange.html

Checks if the dialogue is ready to accept input for the price.

```APIDOC
## readyToEnterPrice

### Description
Checks to see if the Dialogue can enter input with text "Set a price for each item:".

### Method Signature
```java
public static boolean readyToEnterPrice()
```
```

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

### Get Last Clicked X Coordinate

Source: https://dreambot.org/javadocs/org/dreambot/api/input/Mouse.html

Gets the last clicked x position by the client.

```java
public static	int	getLastClickedX()
```

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

### AgilityWebNode Constructor with X, Y

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/impl/AgilityWebNode.html

Initializes an AgilityWebNode with X and Y coordinates, assuming a default Z-axis value.

```java
public	AgilityWebNode	(int	x,
                      int	y)
```

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

### Deprecated MiniQuest Enum Constant Example

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/quest/book/MiniQuest.html

Example of a deprecated MiniQuest enum constant declaration.

```java
@Deprecated
public static final
MiniQuest ENCHANTED_KEY
```

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

### SOSDoor Constructor

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/obstacle/impl/SOSDoor.html

Initializes a new SOSDoor instance with a given name.

```APIDOC
## SOSDoor(String name)

### Description
Constructs a new SOSDoor with the specified name.

### Parameters
* **name** (String) - The name of the door obstacle.
```

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

### Food Enum Constant Example

Source: https://dreambot.org/javadocs/org/dreambot/api/data/consumables/Food.html

Example of a specific food enum constant declaration, such as ANCHOVIES.

```java
public static final Food ANCHOVIES
```

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

### AgilityWebNode Constructor with X, Y, Z

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/web/node/impl/AgilityWebNode.html

Initializes an AgilityWebNode with specific coordinates.

```java
public	AgilityWebNode	(int	x,
                      int	y,
                      int	z)
```

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

### PaidQuest.getStartedSetting()

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/quest/book/PaidQuest.html

Returns the setting value that indicates if this quest has been started. This is likely a game state variable.

```APIDOC
## PaidQuest.getStartedSetting()

### Description
Returns the game setting value that signifies whether this quest has been started.

### Method
`int getStartedSetting()`

### Returns
The integer value representing the started state of the quest.
```

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

### Get GameObject Orientation

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/interactive/GameObject.html

Abstract method to get the orientation of the game object. This must be implemented by subclasses.

```java
public abstract int getOrientation()
```

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

### Get Interactable Tiles

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/interactive/GameObject.html

Gets a list of valid tiles from which the player can interact with the GameObject, excluding diagonals.

```java
public java.util.List<Tile> getInteractableFrom()
```

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

### GameLayoutSolver Constructor

Source: https://dreambot.org/javadocs/org/dreambot/api/randoms/GameLayoutSolver.html

Initializes a new instance of the GameLayoutSolver class.

```APIDOC
## GameLayoutSolver()

### Description
Initializes a new instance of the GameLayoutSolver class.

### Constructor
`public GameLayoutSolver()`
```

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

### Get Original Z Coordinates

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/interactive/Model.html

Gets the array of original Z coordinates for the model's vertices.

```java
public int[] getOriginalZ()
```

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

### WelcomeScreenSolver Constructor

Source: https://dreambot.org/javadocs/org/dreambot/api/randoms/WelcomeScreenSolver.html

The default constructor for the WelcomeScreenSolver class.

```java
public
WelcomeScreenSolver()
```

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

### Get Original X Coordinates

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/interactive/Model.html

Gets the array of original X coordinates for the model's vertices.

```java
public int[] getOriginalX()
```

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

### KeyboardProfile Constructor

Source: https://dreambot.org/javadocs/org/dreambot/api/input/keyboard/KeyboardProfile.html

Initializes a new KeyboardProfile instance. No specific setup is required.

```java
public KeyboardProfile()
```

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

### startTile

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/walking/pathfinding/impl/obstacle/impl/DestructableObstacle.DestructableObstacleBuilder.html

Sets the starting tile for the destructable obstacle.

```APIDOC
## startTile(Tile startTile)

### Description
Sets the starting tile for the destructable obstacle.

### Method
`DestructableObstacle.DestructableObstacleBuilder`

### Parameters
* **startTile** (Tile) - Required - The starting tile of the obstacle.
```

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

### Get Hull Bounds with Default Scale

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/interactive/Model.html

Gets the hull bounds of the model with a default scale of 1.0F.

```java
public java.awt.Shape getHullBounds()
```

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

### getGuidePriceButton

Source: https://dreambot.org/javadocs/org/dreambot/api/methods/grandexchange/GrandExchange.html

Retrieves the WidgetChild for the 'Guide Price' button in the offer screen.

```APIDOC
## getGuidePriceButton

### Description
Gets the Guide Price WidgetChild in the offer screen.

### Method Signature
```java
public static WidgetChild getGuidePriceButton()
```

### Returns
`WidgetChild` of the guide price button or null.
```

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

### Get Character's Orientation

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/interactive/Character.html

Gets the orientation of the character. This can be used to determine which way the character is facing.

```Java
int orientation = character.getOrientation();
```

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

### run

Source: https://dreambot.org/javadocs/org/dreambot/api/script/AbstractScript.html

The main entry point for the script's execution, implementing the Runnable interface.

```APIDOC
## run

### Description
Main execution method for the script.

### Method
void

### Specified by
- `run` in interface `java.lang.Runnable`
```

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

### Get Character Interacting With

Source: https://dreambot.org/javadocs/org/dreambot/api/wrappers/interactive/Character.html

Gets the character that this character is currently interacting with. Returns null if not interacting with any character.

```Java
Character interactingCharacter = character.getInteractingCharacter();
```
Tokens:
Raw