Inubot API Documentation

https://javadocs.inubot.com/
Admin
Inubot is a Java API documentation providing comprehensive tools and functionalities for developing...
Tokens:3,255,090
Snippets:32,816
Trust Score:5.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### Setup Constructor

Source: https://javadocs.inubot.com/org/rspeer/game/component/tdi/Prayers.Quick.Setup.html

Details of the default constructor for the Setup class.

```APIDOC
## Constructor: Setup()

### Description
Initializes a new instance of the `Setup` class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
Initializes the Setup object.

#### Response Example
```json
{}
```
```

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

### Apply Provided Setup

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/loadout/InventoryLoadout.html

Applies a predefined setup for a given ItemEntry's key. This method is useful for initializing or configuring items based on stored setups.

```java
default void applyProvidedSetup (ItemEntry entry)
```

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

### ChatchannelCurrent Field: SETUP

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.ChatchannelCurrent.html

Represents the SETUP component of the chat channel interface. Use this constant when referring to setup actions.

```java
public static final	int SETUP
```

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

### Get Rune Pouch Configuration Prompts

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/setup/provided/RunePouchSetup.html

Retrieves a list of prompts required to configure the rune pouch item. These prompts guide the user through the necessary setup steps.

```java
public	List<Prompt>	getPrompts()

```

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

### WebClient start Method

Source: https://javadocs.inubot.com/org/rspeer/game/web/test/netty/WebClient.html

Starts the WebClient, requiring an EventLoopGroup.

```java
public void start (io.netty.channel.EventLoopGroup group)
```

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

### Get Start Method

Source: https://javadocs.inubot.com/jag/RSInterfaceComponentConfig.html

Returns the starting position or index for the interface component. This method is part of the RSInterfaceComponentConfig interface.

```java
int getStart()
```

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

### WebSegment getStart Method

Source: https://javadocs.inubot.com/org/rspeer/game/web/path/WebSegment.html

Gets the starting position of the WebSegment. Returns a Position object.

```java
public Position getStart()
```

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

### open Method

Source: https://javadocs.inubot.com/org/rspeer/game/component/tdi/Prayers.Quick.Setup.html

Opens the prayer setup interface.

```APIDOC
## Method: open()

### Description
Opens the prayer setup interface.

### Method
Static

### Endpoint
N/A

### Parameters
None

### Request Example
```json
{}
```

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

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

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

### Toggle Prayer in Quick Setup

Source: https://javadocs.inubot.com/org/rspeer/game/component/tdi/Prayers.Quick.Setup.html

Toggles a specific prayer on or off within the quick setup interface. Ensure the interface is open before calling this method.

```java
public static boolean toggle (boolean on,
                             Prayer prayer)
```

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

### Clan Wars Setup Constant

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.html

Represents the setup phase for Clan Wars. Use this constant for initializing or configuring Clan Wars matches.

```java
public static final int CLANWARS_SETUP
```

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

### Specific Setup Prompt Retrieval

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/setup/prompt/class-use/Prompt.html

Methods for retrieving prompts from specific setup configurations like Blowpipe, Divine Rune Pouch, and Rune Pouch.

```APIDOC
## Specific Setups

### Description
Provides methods to retrieve lists of prompts for specialized item entry setups.

### Methods

#### `BlowpipeSetup.getPrompts()`

##### Description
Retrieves the prompts associated with the Blowpipe setup.

##### Method
GET

##### Endpoint
N/A (Method within a class)

#### `DivineRunePouchSetup.getPrompts()`

##### Description
Retrieves the prompts associated with the Divine Rune Pouch setup.

##### Method
GET

##### Endpoint
N/A (Method within a class)

#### `RunePouchSetup.getPrompts()`

##### Description
Retrieves the prompts associated with the Rune Pouch setup.

##### Method
GET

##### Endpoint
N/A (Method within a class)

### Response
#### Success Response (200)
- **List<Prompt>** - A list of Prompt objects.

#### Response Example
```json
{
  "prompts": [
    {
      "type": "PromptTypeA",
      "message": "Blowpipe prompt"
    },
    {
      "type": "PromptTypeB",
      "message": "Rune Pouch prompt"
    }
  ]
}
```
```

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

### Initialize Prayers.Quick.Setup

Source: https://javadocs.inubot.com/org/rspeer/game/component/tdi/Prayers.Quick.Setup.html

Constructs a new Setup object. This is boilerplate and typically not called directly.

```java
public Setup()
```

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

### Prayers.Quick.Setup Class Overview

Source: https://javadocs.inubot.com/org/rspeer/game/component/tdi/Prayers.Quick.Setup.html

Provides an overview of the Prayers.Quick.Setup class and its methods.

```APIDOC
## Class: Prayers.Quick.Setup

### Description
Represents the setup for quick prayers in the game.

### Enclosing Class
Prayers.Quick

### Constructor Summary
Constructors | Description
---|---
`Setup()` | Initializes a new instance of the `Setup` class.

### Method Summary
All Methods | Static Methods | Concrete Methods | Modifier and Type | Method | Description
---|---|---|---|---|---
 | `isOpen()` |  | `static boolean` | `isOpen()` | Checks if the prayer setup is currently open.
 | `open()` |  | `static boolean` | `open()` | Opens the prayer setup.
 | `toggle(boolean on, Prayer prayer)` |  | `static boolean` | `toggle(boolean on, Prayer prayer)` | Toggles a specific prayer on or off.

### Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
```

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

### Get StopWatch Start Time

Source: https://javadocs.inubot.com/org/rspeer/commons/StopWatch.html

Retrieves the Instant at which the StopWatch was started.

```java
public Instant getStartTime()
```

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

### Get Start Position Method

Source: https://javadocs.inubot.com/org/rspeer/game/web/net/response/WebPathResponse.html

Returns the starting Position of the web path. This method is part of the WebPathResponse class.

```java
public
Position
getStart()
```

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

### Get Start Cycle

Source: https://javadocs.inubot.com/jag/game/scene/entity/RSEffectObject.html

Retrieves the starting cycle or tick count for the effect. This method is part of the RSEffectObject interface.

```java
int getStartCycle()
```

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

### BlowpipeSetup.getPrompts()

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/setup/provided/BlowpipeSetup.html

Retrieves a list of prompts required to configure this item.

```APIDOC
## getPrompts()

### Description
Retrieves a list of `Prompt` to configure this item.

### Method
GET

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- **prompts** (List<Prompt>) - A list of `Prompt` to configure this item.

#### Response Example
```json
{
  "prompts": [
    {
      "type": "string",
      "message": "string"
    }
  ]
}
```
```

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

### Get Start Point - RSAudioEnvelope

Source: https://javadocs.inubot.com/jag/audio/RSAudioEnvelope.html

Retrieves the start point of the audio envelope. This method is part of the RSAudioEnvelope interface.

```java
int getStart()
```

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

### getStart Method

Source: https://javadocs.inubot.com/org/rspeer/game/web/net/request/WebPathRequest.html

Retrieves the starting position for the web path request.

```java
public Position getStart()
```

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

### Get Audio Effect Start Time

Source: https://javadocs.inubot.com/jag/audio/RSAudioEffect.html

Retrieves the start time of the audio effect. This method is part of the RSAudioEffect interface.

```java
int
getStart()
```

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

### Constructor Detail

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.WelcomeScreen.html

Details of the WelcomeScreen constructor.

```APIDOC
## Constructor Detail

### WelcomeScreen
```java
public WelcomeScreen()
```
```

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

### onStart Method

Source: https://javadocs.inubot.com/org/rspeer/game/script/Script.html

Callback method executed when the script starts. It receives arguments as a JsonElement for initialization.

```java
public
void onStart(com.google.gson.JsonElement args)
```

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

### Break getStartTime Method

Source: https://javadocs.inubot.com/org/rspeer/game/script/component/Break.html

Gets the timestamp when the current break duration started.

```java
public Instant getStartTime()
```

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

### Get Alchemy Warning Value

Source: https://javadocs.inubot.com/org/rspeer/game/component/tdi/Settings.html

Retrieves the current value for the alchemy warning setting. No setup required.

```java
public static int getAlchemyWarningValue()
```

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

### isOpen Method

Source: https://javadocs.inubot.com/org/rspeer/game/component/tdi/Prayers.Quick.Setup.html

Checks if the prayer setup interface is currently open.

```APIDOC
## Method: isOpen()

### Description
Checks if the prayer setup interface is currently open.

### Method
Static

### Endpoint
N/A

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **isOpen** (boolean) - True if the setup is open, false otherwise.

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

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

### Constructor Detail: _100GuideFlourDisplay()

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId._100GuideFlourDisplay.html

Details for the default constructor of the InterfaceId._100GuideFlourDisplay class.

```APIDOC
## Constructor Detail: _100GuideFlourDisplay()

### Description
Default constructor for the `InterfaceId._100GuideFlourDisplay` class.

### Signature
`public _100GuideFlourDisplay()`
```

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

### Get Elapsed Time

Source: https://javadocs.inubot.com/org/rspeer/commons/StopWatch.html

Returns the total elapsed time as a Duration object since the StopWatch was started or resumed.

```java
public Duration getElapsed()
```

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

### Get Path Between Area

Source: https://javadocs.inubot.com/org/rspeer/game/web/Web.html

Requests a path from the web server between a starting SceneNode and an ending Area. This is useful for navigating to a region.

```java
public static WebPath pathBetween(SceneNode start, Area end)
```

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

### RunePouchSetup Methods

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/setup/provided/RunePouchSetup.html

Details the instance methods available in the RunePouchSetup class.

```APIDOC
## getPrompts()

### Description
Retrieves a list of prompts required to configure this item.

### Method
GET

### Endpoint
N/A (Instance Method)

### Parameters
None

### Request Example
```java
List<Prompt> prompts = runePouchSetup.getPrompts();
```

### Response
#### Success Response (200)
- **prompts** (List<Prompt>) - A list of `Prompt` objects to configure the item.

#### Response Example
```json
{
  "prompts": [
    {
      "type": "PromptType",
      "message": "Configure your rune pouch"
    }
  ]
}
```

## isRequired(InventoryLoadout loadout)

### Description
Checks if the given inventory loadout requires specific configuration for this item.

### Method
GET

### Endpoint
N/A (Instance Method)

### Parameters
- **loadout** (InventoryLoadout) - Required - The inventory loadout to check against.

### Request Example
```java
boolean requiresConfig = runePouchSetup.isRequired(currentLoadout);
```

### Response
#### Success Response (200)
- **required** (boolean) - `true` if the loadout requires configuration for this item, `false` otherwise.

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

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

### Initiate Production with Index

Source: https://javadocs.inubot.com/org/rspeer/game/component/Production.html

Initiates a production process using an integer index. This is a simpler way to start production when an index is readily available.

```java
boolean initiate(int index)
```

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

### Get Center Y Coordinate

Source: https://javadocs.inubot.com/jag/game/scene/entity/RSAxisAlignedBoundingBox.html

Retrieves the Y-coordinate of the center of the bounding box. No specific setup is required beyond implementing the interface.

```java
int getCenterY()
```

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

### DelegatingBorder Usage Example

Source: https://javadocs.inubot.com/org/rspeer/commons/DelegatingBorder.html

Demonstrates how to create and use a DelegatingBorder with a TitledBorder and a custom child component. No explicit install() needed.

```java
TitledBorder titled = BorderFactory.createTitledBorder("Dataset");  DelegatingBorder border = new DelegatingBorder(   titled,   () -> {     JLabel sub = new JLabel("ⓘ");     sub.setCursor(Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));     sub.setToolTipText("Click for details");     sub.addMouseListener(new MouseAdapter() {       public void mouseClicked(MouseEvent e) {         JOptionPane.showMessageDialog(SwingUtilities.getWindowAncestor(sub), "Clicked!");       }     });     return sub;   },   DelegatingBorder.Anchor.SOUTH_EAST,   new Insets(4,6,4,6)  );
 panel.setBorder(border);
```

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

### getPrompts Method Implementation

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/setup/ItemEntrySetup.html

Abstract method to retrieve a list of prompts needed to configure the item. Implementations should define the user interaction for setup.

```java
public abstract List<Prompt> getPrompts()
```

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

### DivineRunePouchSetup Constructor

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/setup/provided/DivineRunePouchSetup.html

Initializes a new instance of the DivineRunePouchSetup class.

```APIDOC
## DivineRunePouchSetup()

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

### Method
CONSTRUCTOR

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

### Response Example
None
```

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

### Get Loaded Projectiles

Source: https://javadocs.inubot.com/org/rspeer/game/scene/Projectiles.html

Retrieves all loaded projectiles without considering a started check. This is a convenient method for accessing all active projectiles.

```java
public static
SceneNodeQueryResults<Projectile>
getLoaded()
```

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

### SkillGuideV2 Constructor

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.SkillGuideV2.html

Default constructor for the SkillGuideV2 class. It does not perform any specific initialization.

```java
public
SkillGuideV2()
```

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

### Get Center Z Coordinate

Source: https://javadocs.inubot.com/jag/game/scene/entity/RSAxisAlignedBoundingBox.html

Retrieves the Z-coordinate of the center of the bounding box. No specific setup is required beyond implementing the interface.

```java
int getCenterZ()
```

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

### Get Center X Coordinate

Source: https://javadocs.inubot.com/jag/game/scene/entity/RSAxisAlignedBoundingBox.html

Retrieves the X-coordinate of the center of the bounding box. No specific setup is required beyond implementing the interface.

```java
int getCenterX()
```

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

### InterfaceId.TutorialPlayerExperience Class

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.TutorialPlayerExperience.html

Details about the TutorialPlayerExperience class, including its fields and constructor.

```APIDOC
## Class InterfaceId.TutorialPlayerExperience

### Description
Represents tutorial player experience related interface IDs.

### Fields
- **BUTTON_EXPERIENCED** (int) - Constant for the experienced button.
- **BUTTON_NEW** (int) - Constant for the new player button.
- **BUTTON_RETURNING** (int) - Constant for the returning player button.
- **CONTENT** (int) - Constant for the content area.
- **FRAME** (int) - Constant for the frame.
- **MAIN** (int) - Constant for the main interface.
- **NOCLICK** (int) - Constant for no click.
- **UNIVERSE** (int) - Constant for the universe.

### Constructor
- **TutorialPlayerExperience()** - Initializes a new instance of the TutorialPlayerExperience class.
```

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

### setSetup Method

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/ItemEntry.html

Assigns a required setup configuration to this item entry.

```java
default void setSetup (ItemEntrySetup setup)
```

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

### Get Loaded Projectiles (with check)

Source: https://javadocs.inubot.com/org/rspeer/game/scene/Projectiles.html

Retrieves all loaded projectiles, optionally considering a started check. Use this method to access projectiles that are currently active in the game.

```java
public static
SceneNodeQueryResults<Projectile>
getLoaded(boolean
ignoreStartedCheck)
```

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

### Get Friends Chat Channel Name

Source: https://javadocs.inubot.com/jag/game/relationship/RSFriendsChatSystem.html

Retrieves the name of the current friends chat channel. No specific setup is required beyond having an instance of RS বন্ধুদেরChatSystem.

```java
String getChannelName()
```

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

### Get Data Types Method

Source: https://javadocs.inubot.com/jag/game/type/RSDBRow.html

Retrieves the data types associated with the row as a 2D array of Objects. No specific setup is required beyond implementing the RSDBRow interface.

```java
Object[][] getDataTypes()
```

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

### getConfig Methods

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/setup/ItemEntrySetup.html

Retrieves configuration details for the item setup.

```APIDOC
## GET /api/itementrysetup/config

### Description
Retrieves configuration details for the item setup.

### Method
GET

### Endpoint
/api/itementrysetup/config

### Parameters
#### Query Parameters
- **promptTitle** (String) - Optional - The title of the prompt to get the config for.
- **prompt** (Prompt) - Optional - The Prompt object to get the config for.

### Response
#### Success Response (200)
- **config** (Map<String, Object>) - A map containing configuration details. The key is a Prompt title and the value can be a boolean, String, int, or Item.

#### Response Example
```json
{
  "config": {
    "Dart Type": "Adamant Dart",
    "Quantity": 1000
  }
}
```
```

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

### Get Minimum Consumable Quantity

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/impl/DefaultFuzzyItemEntry.html

Retrieves the minimum number of charges or doses this item allows in a loadout. For example, to avoid withdrawing 1-dose items, this can be set to 2.

```java
public int getMinimumConsumableQuantity()
```

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

### RunePouchSetup Class Overview

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/setup/provided/RunePouchSetup.html

Provides an overview of the RunePouchSetup class, its inheritance, and implemented interfaces.

```APIDOC
## RunePouchSetup Class

### Description
Represents the setup configuration for a Rune Pouch item, extending the general `ItemEntrySetup`.

### Class Hierarchy
- `java.lang.Object`
  - `org.rspeer.game.config.item.entry.setup.ItemEntrySetup`
    - `org.rspeer.game.config.item.entry.setup.provided.RunePouchSetup`

### Implemented Interfaces
- `Serializable`
```

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

### Constructor Detail: PohBoard

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.PohBoard.html

Information about the PohBoard constructor.

```APIDOC
## Constructor Detail

### PohBoard
```public PohBoard()```
```

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

### Start a StopWatch with Custom Start Time

Source: https://javadocs.inubot.com/org/rspeer/commons/StopWatch.html

Starts a StopWatch with a custom start time. Requires a Supplier for the start Instant.

```java
public static StopWatch start(Supplier<Instant> start)
```

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

### Constructor Detail

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.Settings.html

Details of the Settings constructor.

```APIDOC
## Constructor Detail

### Settings
```java
public Settings()
```

#### Description
Initializes a new instance of the Settings class.
```

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

### Create and Start a Fixed StopWatch with Custom Start Time

Source: https://javadocs.inubot.com/org/rspeer/commons/StopWatch.html

Creates and starts a StopWatch with a custom start time and a specified duration. Requires a Supplier for the start Instant and a Duration object.

```java
public static StopWatch fixed(Supplier<Instant> start, Duration duration)
```

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

### Constructor Detail: OsmHotkeys()

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.OsmHotkeys.html

Details for the OsmHotkeys constructor.

```APIDOC
## Constructor Detail: OsmHotkeys()

### Description
Default constructor for the InterfaceId.OsmHotkeys class.

### Signature
`public OsmHotkeys()`
```

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

### PREPOT_DEVICE_LOADOUTS_1 Constant

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Constant for the first pre-pot device loadout.

```java
public static final int PREPOT_DEVICE_LOADOUTS_1
```

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

### Start a StopWatch

Source: https://javadocs.inubot.com/org/rspeer/commons/StopWatch.html

Starts a StopWatch from the current time.

```java
public static StopWatch start()
```

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

### Initiate Production with Item Function

Source: https://javadocs.inubot.com/org/rspeer/game/component/Production.html

Initiates a production process using a function that queries and returns an item. This method is useful for complex item-based production setups.

```java
boolean initiate(Function<ItemQuery,Item> item)
```

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

### RunePouchSetup Constructor

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/setup/provided/RunePouchSetup.html

Initializes a new instance of the RunePouchSetup class. No specific setup is required beyond the default ItemEntrySetup initialization.

```java
public	RunePouchSetup()

```

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

### Constructor Detail

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.BrLoadout.html

Details about the BrLoadout constructor.

```APIDOC
## Constructor Detail

### BrLoadout()
- **Description**: Constructs a new BrLoadout object.
- **Method**: public
- **Parameters**: None
```

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

### Constructor Details for InterfaceId.SkillGuideV2

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.SkillGuideV2.html

Details about the constructor for the InterfaceId.SkillGuideV2 class.

```APIDOC
## Constructor Details

### SkillGuideV2
```java
public SkillGuideV2()
```
Initializes a new instance of the SkillGuideV2 class.
```

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

### FontAwesome get Method

Source: https://javadocs.inubot.com/org/rspeer/ui/commons/FontAwesome.html

Information about the static get method in the FontAwesome class.

```APIDOC
## GET FontAwesome Font

### Description
Retrieves the Font object associated with FontAwesome.

### Method
- **get**()
  - Returns: Font - The Font object.

### Endpoint
N/A (Static method)
```

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

### initiate Method (String)

Source: https://javadocs.inubot.com/org/rspeer/game/component/EnterInput.html

Initiates the enter input interface with a string value.

```APIDOC
## initiate(String entry)

### Description
Initiates the enter input interface with a string value.

### Method
`public static boolean initiate(String entry)`

### Parameters
#### Path Parameters
- **entry** (String) - Description of the string entry
```

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

### ItemCache Get Methods

Source: https://javadocs.inubot.com/org/rspeer/game/service/inventory/ItemCache.html

Documentation for the various get methods available in ItemCache.

```APIDOC
## ItemCache Get Methods

### Description
Methods to retrieve information about items and slots within the `ItemCache`.

### Method
`List<Item> getValidSlots()`

### Endpoint
N/A

### Parameters
None

### Request Example
```java
List<Item> items = itemCache.getValidSlots();
```

### Response
#### Success Response (200)
- **items** (List<Item>) - A list of valid items currently in the cache.

#### Response Example
```json
[
  {
    "id": 1234,
    "amount": 5
  }
]
```

---

### Description
Methods to retrieve information about items and slots within the `ItemCache`.

### Method
`int getValidSlotCount()`

### Endpoint
N/A

### Parameters
None

### Request Example
```java
int count = itemCache.getValidSlotCount();
```

### Response
#### Success Response (200)
- **count** (int) - The number of valid slots occupied by items.

#### Response Example
```json
10
```

---

### Description
Methods to retrieve information about items and slots within the `ItemCache`.

### Method
`int getRemainingSlots()`

### Endpoint
N/A

### Parameters
None

### Request Example
```java
int remaining = itemCache.getRemainingSlots();
```

### Response
#### Success Response (200)
- **remaining** (int) - The number of empty slots available in the cache.

#### Response Example
```json
18
```

---

### Description
Methods to retrieve information about items and slots within the `ItemCache`.

### Method
`int getSlotCount()`

### Endpoint
N/A

### Parameters
None

### Request Example
```java
int totalSlots = itemCache.getSlotCount();
```

### Response
#### Success Response (200)
- **totalSlots** (int) - The total number of slots in the cache.

#### Response Example
```json
28
```

---

### Description
Methods to retrieve information about items and slots within the `ItemCache`.

### Method
`boolean contains(Function<ItemQuery, ItemQueryResults> function)`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **function** (Function<ItemQuery, ItemQueryResults>) - Required - A function that defines the query to check for item existence.

### Request Example
```java
boolean hasItem = itemCache.contains(query -> query.id(1234));
```

### Response
#### Success Response (200)
- **result** (boolean) - True if items matching the query are found, false otherwise.

#### Response Example
```json
true
```

---

### Description
Methods to retrieve information about items and slots within the `ItemCache`.

### Method
`int getCount(Function<ItemQuery, ItemQueryResults> function)`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **function** (Function<ItemQuery, ItemQueryResults>) - Required - A function that defines the query to count items.

### Request Example
```java
int count = itemCache.getCount(query -> query.id(1234));
```

### Response
#### Success Response (200)
- **count** (int) - The number of items matching the query.

#### Response Example
```json
5
```

---

### Description
Methods to retrieve information about items and slots within the `ItemCache`.

### Method
`int getCount(Function<ItemQuery, ItemQueryResults> function, boolean includeStacks)`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **function** (Function<ItemQuery, ItemQueryResults>) - Required - A function that defines the query to count items.
- **includeStacks** (boolean) - Required - Whether to include stacked item amounts in the count.

### Request Example
```java
int count = itemCache.getCount(query -> query.id(1234), true);
```

### Response
#### Success Response (200)
- **count** (int) - The number of items matching the query, considering stacks.

#### Response Example
```json
25
```
```

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

### Define Hunter Experience Drop Start

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Represents the starting value for experience drops related to Hunter.

```java
public static final int XPDROPS_HUNTER_START
```

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

### Shop Constructor

Source: https://javadocs.inubot.com/org/rspeer/game/adapter/component/inventory/Shop.html

Initializes a new instance of the Shop class. No specific setup is detailed.

```java
public
Shop()
```

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

### Define Construction Experience Drop Start

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Represents the starting value for experience drops related to Construction.

```java
public static final int XPDROPS_CONSTRUCTION_START
```

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

### Define Farming Experience Drop Start

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Represents the starting value for experience drops related to Farming.

```java
public static final int XPDROPS_FARMING_START
```

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

### Constructor Details

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/DBTableId.PrepotDeviceLoadoutUi.html

Details of the constructor for DBTableId.PrepotDeviceLoadoutUi.

```APIDOC
## Constructor Details

### PrepotDeviceLoadoutUi
```java
public PrepotDeviceLoadoutUi()
```
```

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

### Define Slayer Experience Drop Start

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Represents the starting value for experience drops related to Slayer.

```java
public static final int XPDROPS_SLAYER_START
```

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

### getSetup Method

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/ItemEntry.html

Retrieves the ItemEntrySetup associated with this entry. Returns null if no setup is required.

```java
default ItemEntrySetup getSetup()
```

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

### Define Fletching Experience Drop Start

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Represents the starting value for experience drops related to Fletching.

```java
public static final int XPDROPS_FLETCHING_START
```

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

### Define Woodcutting Experience Drop Start

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Represents the starting value for experience drops related to Woodcutting.

```java
public static final int XPDROPS_WOODCUTTING_START
```

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

### Define Firemaking Experience Drop Start

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Represents the starting value for experience drops related to Firemaking.

```java
public static final int XPDROPS_FIREMAKING_START
```

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

### BlowpipeSetup Constructor

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/setup/provided/BlowpipeSetup.html

Initializes a new instance of the BlowpipeSetup class.

```APIDOC
## BlowpipeSetup()

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

### Method
CONSTRUCTOR

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

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

### Define Cooking Experience Drop Start

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Represents the starting value for experience drops related to Cooking.

```java
public static final int XPDROPS_COOKING_START
```

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

### JagexAccount Constructor

Source: https://javadocs.inubot.com/org/rspeer/game/script/component/JagexAccount.html

Initializes a new JagexAccount instance with a code and an ID token.

```APIDOC
## JagexAccount Constructor

### Description
Initializes a new JagexAccount instance.

### Method
Constructor

### Parameters
- **code** (String) - Required - The account code.
- **idToken** (String) - Required - The ID token for the account.

### Request Example
```java
JagexAccount account = new JagexAccount("sample_code", "sample_id_token");
```

### Response
N/A (Constructors do not return values in the same way as methods.)
```

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

### Define Fishing Experience Drop Start

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Represents the starting value for experience drops related to Fishing.

```java
public static final int XPDROPS_FISHING_START
```

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

### Incoming Constructor

Source: https://javadocs.inubot.com/org/rspeer/game/component/Trade.Incoming.html

Initializes a new instance of the Incoming class. No specific setup is required.

```java
public Incoming()
```

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

### Define Smithing Experience Drop Start

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Represents the starting value for experience drops related to Smithing.

```java
public static final int XPDROPS_SMITHING_START
```

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

### Define Mining Experience Drop Start

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Represents the starting value for experience drops related to Mining.

```java
public static final int XPDROPS_MINING_START
```

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

### Constructor Detail

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.WildwarsHud.html

Details of the WildwarsHud constructor.

```APIDOC
## Constructor Detail

### WildwarsHud
```
public WildwarsHud()
```
```

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

### Define RuneCraft Experience Drop Start

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Represents the starting value for experience drops related to RuneCrafting.

```java
public static final int XPDROPS_RUNECRAFT_START
```

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

### Constructor Detail

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.LotgMakeover.html

Information about the LotgMakeover constructor.

```APIDOC
## Constructor Detail

### LotgMakeover()

This is the default constructor for the LotgMakeover class.
```

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

### Start a ScriptSchedule

Source: https://javadocs.inubot.com/org/rspeer/game/script/scheduler/class-use/ScriptSchedule.html

Use this method to start a script schedule. It must only be called when a script is not already running.

```java
boolean ScriptScheduleManager.start(ScriptSchedule schedule, GameAccount account)
```

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

### Constructor Detail: BrewOverlay

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.BrewOverlay.html

Details of the BrewOverlay constructor.

```APIDOC
## Constructor Detail: BrewOverlay

### BrewOverlay()

- **Description**: Constructs a new BrewOverlay object.
```

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

### IntPair Constructor Summary

Source: https://javadocs.inubot.com/org/rspeer/commons/IntPair.html

Lists the constructors available for creating IntPair objects.

```APIDOC
### Constructor Summary

Constructors Constructor | Description  
---|---  
`IntPair(int left, int right)` | Constructs an IntPair with the specified left and right integer values.
```

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

### Get Key

Source: https://javadocs.inubot.com/org/rspeer/game/service/telemetry/model/item/ChargeItem.html

Abstract method to get a unique identifier string for this item. Used for referencing the item.

```java
public abstractStringgetKey()
```

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

### get Method Implementation

Source: https://javadocs.inubot.com/org/rspeer/game/provider/callback/manager/cs2/loot/StringVectors.html

Implements the get method for StringVector. It retrieves a StringVector associated with the given key.

```java
public	StringVector	get(int	key)
```

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

### IntPair Class Overview

Source: https://javadocs.inubot.com/org/rspeer/commons/IntPair.html

Provides an overview of the IntPair class structure and its inheritance.

```APIDOC
## Class Overview

```java
public class IntPair
extends Object
```

This class represents a pair of integers.
```

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

### Get ItemEntry by Key

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/loadout/EquipmentLoadout.html

Retrieves an ItemEntry using its key. Implements the get method from the InventoryLoadout interface.

```java
public ItemEntry get(String key)
```

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

### ItemEntrySetup Subclasses in org.rspeer.game.config.item.entry.setup.provided

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/setup/class-use/ItemEntrySetup.html

Lists the subclasses of ItemEntrySetup provided in the org.rspeer.game.config.item.entry.setup.provided package.

```APIDOC
## Classes extending ItemEntrySetup

### Description
These classes extend the ItemEntrySetup class, providing specific implementations.

### Classes
- **BlowpipeSetup** (class) - Represents the setup for a blowpipe.
- **DivineRunePouchSetup** (class) - Represents the setup for a divine rune pouch.
- **RunePouchSetup** (class) - Represents the setup for a rune pouch.

### Usage
These classes can be instantiated and used where an ItemEntrySetup object is expected.
```

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

### Get Quest Progress Method

Source: https://javadocs.inubot.com/org/rspeer/game/component/tdi/Quests.html

Gets the progress of a specific quest. Requires a Quest object as input.

```java
public static Quest.Progress getProgress(Quest quest)
```

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

### _100GuideFlourOverlay Constructor

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId._100GuideFlourOverlay.html

Default constructor for the _100GuideFlourOverlay class. It does not perform any explicit initialization.

```java
public _100GuideFlourOverlay()
```

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

### CombatMonitoringService Constructor

Source: https://javadocs.inubot.com/org/rspeer/game/service/combat/CombatMonitoringService.html

Initializes a new instance of the CombatMonitoringService.

```APIDOC
## CombatMonitoringService Constructor

### Description
Initializes a new instance of the CombatMonitoringService.

### Method
`CombatMonitoringService()`

### Endpoint
N/A (Constructor)

### Request Body
None

### Response
None
```

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

### Color Decoding Example

Source: https://javadocs.inubot.com/org/rspeer/game/script/meta/paint/CoordOverlayBinding.html

Provides an example of decoding an ARGB hex string into a Java Color object.

```java
new Color(Integer.parseUnsignedInt(hex.substring(1), 16), true)
```

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

### DelegatingBorder Usage Example

Source: https://javadocs.inubot.com/org/rspeer/commons/DelegatingBorder.html

Example demonstrating how to use DelegatingBorder to create a titled border with an overlaid component.

```APIDOC
## DelegatingBorder Usage Example

### Description
This example shows how to create a `DelegatingBorder` that wraps a `TitledBorder` and adds a custom `JLabel` component overlaid on the border.

### Code Example
```java
TitledBorder titled = BorderFactory.createTitledBorder("Dataset");
DelegatingBorder border = new DelegatingBorder(
    titled,
    () -> {
        JLabel sub = new JLabel("ⓘ");
        sub.setCursor(Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
        sub.setToolTipText("Click for details");
        sub.addMouseListener(new MouseAdapter() {
            public void mouseClicked(MouseEvent e) {
                JOptionPane.showMessageDialog(SwingUtilities.getWindowAncestor(sub), "Clicked!");
            }
        });
        return sub;
    },
    DelegatingBorder.Anchor.SOUTH_EAST,
    new Insets(4,6,4,6)
);
panel.setBorder(border);
```
```

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

### Constructor Detail

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.BrewWaitingRoomOverlay.html

Details of the constructor for the BrewWaitingRoomOverlay class.

```APIDOC
## Constructor Detail

### BrewWaitingRoomOverlay
```java
public BrewWaitingRoomOverlay()
```
```

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

### TutorialOverlay Constructor

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.TutorialOverlay.html

The default constructor for the TutorialOverlay class. No specific setup or constraints are mentioned.

```java
public
TutorialOverlay()
```

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

### Carpentry Boat Skill Guide Constant

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InventoryId.html

Represents the constant value for the carpentry boat skill guide.

```java
public static final int SKILL_GUIDE_CARPENTRY_BOAT2
```

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

### Constructor Detail

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.Adventurepath.html

Details on the Adventurepath constructor.

```APIDOC
## Constructor Detail

### Adventurepath
```java
public Adventurepath()
```

This is the default constructor for the Adventurepath class.
```

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

### Declare GUIDE Constant

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/DBTableId.Synth.Row.html

Represents the GUIDE constant. Used to identify specific game elements or events.

```java
public static final	int GUIDE
```

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

### Constructor Detail: PvpArenaSideoptions

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.PvpArenaSideoptions.html

Details for the PvpArenaSideoptions constructor.

```APIDOC
## Constructor Detail: PvpArenaSideoptions

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

### Constructor
- **PvpArenaSideoptions()** - Default constructor.
```

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

### Create and Start a Fixed StopWatch

Source: https://javadocs.inubot.com/org/rspeer/commons/StopWatch.html

Creates and starts a StopWatch that will end after a specified duration. Requires a Duration object.

```java
public static StopWatch fixed(Duration duration)
```

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

### Prayer.Modern values() Method Usage Example

Source: https://javadocs.inubot.com/org/rspeer/game/component/tdi/Prayer.Modern.html

Example of how to iterate over the Prayer.Modern enum constants using the values() method.

```java
for (Prayer.Modern c : Prayer.Modern.values())
    System.out.println(c);
```

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

### Constructor Details

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.PrepotDeviceDebug.html

Details of the constructor for the InterfaceId.PrepotDeviceDebug class.

```APIDOC
## Constructor Details

### PrepotDeviceDebug
```java
public PrepotDeviceDebug()
```
```

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

### Declare Woodcutting Skill Guide Constant

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InventoryId.html

Represents woodcutting for guide purposes. Use this constant when referencing woodcutting data.

```java
public static final int SKILL_GUIDE_WOODCUTTING
```

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

### Initialize House.JewelleryBox

Source: https://javadocs.inubot.com/org/rspeer/game/House.JewelleryBox.html

Constructs a new JewelleryBox object. No specific setup is required.

```java
public JewelleryBox()
```

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

### Declare Runecrafting Skill Guide Constant

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InventoryId.html

Represents runecrafting for guide purposes. Use this constant when referencing runecrafting data.

```java
public static final int SKILL_GUIDE_RUNECRAFTING
```

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

### TUTORIAL_HIGHLIGHT

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.League3Unlocks.html

Represents the TUTORIAL_HIGHLIGHT constant.

```APIDOC
## Constant Field Values

### TUTORIAL_HIGHLIGHT
```java
public static final int TUTORIAL_HIGHLIGHT
```
```

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

### getPrompts Method

Source: https://javadocs.inubot.com/org/rspeer/game/config/item/entry/setup/provided/DivineRunePouchSetup.html

Retrieves a list of prompts required for configuring the Divine Rune Pouch setup.

```APIDOC
## getPrompts()

### Description
Retrieves a list of `Prompt` to configure this item.

### Method
GET

### Endpoint
N/A (Instance Method)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **prompts** (List<Prompt>) - A list of `Prompt` objects required for configuration.

### Response Example
```json
{
  "prompts": [
    {
      "type": "PromptType",
      "message": "Prompt message"
    }
  ]
}
```
```

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

### COA Start Message Constant

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/ItemId.html

Represents the starting message for COA. Use this constant to trigger or identify the initial COA message.

```java
public static final int COA_START_MESSAGE
```

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

### Chat Channel Setup Constant

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.html

Represents the setup for chat channels. Use this constant for configuring or managing chat channel settings.

```java
public static final int CHATCHANNEL_SETUP
```

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

### init Method

Source: https://javadocs.inubot.com/org/rspeer/game/provider/callback/proxy/SocketProvider.html

Initializes the socket provider with a host and port. This method is final.

```java
public finalvoidinit(
                       Stringhost,
                       intport)
```

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

### Get Active Production Instance

Source: https://javadocs.inubot.com/org/rspeer/game/component/Production.html

Retrieves the currently active instance of the Production interface. Use this to get a handle to the production system.

```java
static Production getActive()
```

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

### ConfigPanelEvent Class Overview

Source: https://javadocs.inubot.com/org/rspeer/game/script/event/ConfigPanelEvent.html

Provides an overview of the ConfigPanelEvent class, its inheritance, and implemented interfaces.

```APIDOC
## ConfigPanelEvent Class

### Description
Represents an event related to a configuration panel, extending the generic Event class.

### Inheritance
- `java.lang.Object`
  - `java.util.EventObject`
    - `org.rspeer.event.Event<ConfigPanelManager>`
      - `org.rspeer.game.script.event.ConfigPanelEvent`

### Implemented Interfaces
- `Serializable`
```

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

### Get Inventory by Composite Type

Source: https://javadocs.inubot.com/org/rspeer/game/component/Inventories.html

Retrieves an inventory using an InventoryType composite. This is a convenient way to get common inventory types.

```java
public static Inventory get(InventoryType composite)

```

```java
public static Inventory get(InventoryType composite,
                            boolean extractFromProvider)

```

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

### PREPOT_DEVICE_LOADOUTS_2 Constant

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/VarpId.html

Constant for the second pre-pot device loadout.

```java
public static final int PREPOT_DEVICE_LOADOUTS_2
```

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

### Constructor Detail

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.PvpArena1V1Info.html

Details of the PvpArena1V1Info constructor.

```APIDOC
## Constructor Detail

### PvpArena1V1Info

- **Signature**: public PvpArena1V1Info()
- **Description**: Initializes a new instance of the PvpArena1V1Info class.
```

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

### EdtProvider get Method

Source: https://javadocs.inubot.com/org/rspeer/commons/EdtProvider.html

The get method, as specified by the com.google.inject.Provider and jakarta.inject.Provider interfaces. This method is responsible for providing an instance of type T.

```java
public T get()
```

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

### SKILL_GUIDE_CARPENTRY_BOAT Constant

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InventoryId.html

Represents a carpentry boat within the skill guide. Use this constant to reference this specific skill guide element.

```java
public static final	int SKILL_GUIDE_CARPENTRY_BOAT
```

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

### Constructor Detail

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.MistmystPiano.html

Details of the MistmystPiano constructor.

```APIDOC
## Constructor Detail

### MistmystPiano

This is the constructor for the MistmystPiano class.
```

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

### IntPair Method Summary

Source: https://javadocs.inubot.com/org/rspeer/commons/IntPair.html

Lists the methods available in the IntPair class.

```APIDOC
### Method Summary

All Methods Instance Methods Concrete Methods Modifier and Type | Method | Description  
---|---|---  
`int` | `accumulate(IntBinaryOperator function)` | Applies a binary operator to the pair and returns the result.
`int` | `getLeft()` | Returns the left integer value of the pair.
`int` | `getRight()` | Returns the right integer value of the pair.
`String` | `toString()` | Returns a string representation of the IntPair.
```

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

### Declare Fishing Skill Guide Constant

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InventoryId.html

Represents the fishing skill for guide purposes. Use this constant when referencing fishing-related data.

```java
public static final int SKILL_GUIDE_FISHING
```

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

### CombatMonitoringService Constructor

Source: https://javadocs.inubot.com/org/rspeer/game/service/combat/CombatMonitoringService.html

Initializes a new instance of the CombatMonitoringService. No specific setup is required beyond instantiation.

```java
public CombatMonitoringService()

```

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

### Initialize Definitions Class

Source: https://javadocs.inubot.com/org/rspeer/game/Definitions.html

Default constructor for the Definitions class. No specific setup is required.

```java
public Definitions()
```

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

### Constructor Detail - TeleportOther

Source: https://javadocs.inubot.com/org/rspeer/game/gameval/InterfaceId.TeleportOther.html

Documentation for the TeleportOther constructor.

```APIDOC
## Constructor Detail - TeleportOther

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

### Signature
`public TeleportOther()`
```

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

### Get Loaded Pickables

Source: https://javadocs.inubot.com/org/rspeer/game/scene/Pickables.html

Retrieves all currently loaded pickables in the game. This method is useful for getting a general overview of all visible ground items.

```java
public static SceneNodeQueryResults<Pickable> getLoaded()
```

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

### Get Text Representation of Setting Option

Source: https://javadocs.inubot.com/org/rspeer/game/component/tdi/Settings.Option.html

Retrieves the text representation for a given Settings.Option. This method is used to get a user-friendly string for each option.

```java
public String getText()
```
Tokens:
Raw