RuneMate Client

https://runemate.gitlab.io/community/runemate-game-api/runemate-client
Admin
RuneMate Client is a game client that provides an API for scripting and interacting with game...
Tokens:53,493
Snippets:340
Trust Score:7
Update:9 months ago
Show doc for...
Tokens:
Raw
### Initialize and Use StopWatch

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/hybrid/util/StopWatch

Demonstrates how to create, start, stop, and retrieve the runtime from a StopWatch instance. This is useful for measuring task durations or performance.

```java
import com.runemate.game.api.hybrid.util.StopWatch;
import java.util.concurrent.TimeUnit;

public class StopWatchExample {
    public static void main(String[] args) {
        StopWatch watch = new StopWatch();

        // Start the stopwatch
        watch.start();
        System.out.println("StopWatch started. Is running: " + watch.isRunning());

        // Simulate some work
        try {
            Thread.sleep(2000);
        } catch (InterruptedException e) {
            Thread.currentThread().interrupt();
        }

        // Get runtime in milliseconds
        long runtimeMillis = watch.getRuntime();
        System.out.println("Runtime in milliseconds: " + runtimeMillis);

        // Get runtime in seconds
        long runtimeSeconds = watch.getRuntime(TimeUnit.SECONDS);
        System.out.println("Runtime in seconds: " + runtimeSeconds);

        // Get runtime as formatted string
        String runtimeString = watch.getRuntimeAsString();
        System.out.println("Runtime as HH:mm:ss: " + runtimeString);

        // Stop the stopwatch
        watch.stop();
        System.out.println("StopWatch stopped. Is running: " + watch.isRunning());

        // Attempt to get runtime after stopping (should be the same as before stopping)
        System.out.println("Runtime after stopping: " + watch.getRuntimeAsString());

        // Reset the stopwatch
        watch.reset();
        System.out.println("StopWatch reset. Runtime after reset: " + watch.getRuntimeAsString());

        // Start again after reset
        watch.start();
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            Thread.currentThread().interrupt();
        }
        System.out.println("Runtime after reset and starting again: " + watch.getRuntimeAsString());
    }
}
```

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

### ScriptMetaData - Get Description

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/data/ScriptMetaData

Retrieves the description of the script.

```APIDOC
## GET /script/metadata/description

### Description
Gets the description of the script.

### Method
GET

### Endpoint
/script/metadata/description

### Parameters
#### Query Parameters
- **botMetaData** (BotMetadata) - Required - The bot's metadata object.

### Response
#### Success Response (200)
- **description** (String) - The description of the script.

#### Response Example
```json
{
  "description": "This script does amazing things."
}
```
```

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

### ScriptMetaData - Get Version

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/data/ScriptMetaData

Retrieves the version of the script.

```APIDOC
## GET /script/metadata/version

### Description
Gets the version of the script.

### Method
GET

### Endpoint
/script/metadata/version

### Parameters
#### Query Parameters
- **botMetaData** (BotMetadata) - Required - The bot's metadata object.

### Response
#### Success Response (200)
- **version** (String) - The version of the script.

#### Response Example
```json
{
  "version": "1.0.0"
}
```
```

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

### Bot Lifecycle Management

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/framework/AbstractBot

Methods for controlling the lifecycle of a Runemate bot, including starting, stopping, pausing, and resuming.

```APIDOC
## Bot Lifecycle Management

### start

```java
public final void start(@NotNull @NotNull String... arguments)
```

Starts the bot with the provided command-line arguments.

### stop

```java
public final void stop(String reason)
```

Stops the bot and initiates the shutdown process, providing a reason for stopping.

### pause

```java
public final void pause()
public final void pause(String reason)
```

Puts the bot into a paused state. An optional reason can be provided.

### resume

```java
public final void resume()
```

Resumes the bot from a paused state, returning it to the running state.

### onStart

```java
public void onStart(String... arguments)
```

A callback method invoked when a script is first started. It receives command-line arguments.

### onPause

```java
public void onPause()
```

A callback method invoked when the bot is paused.

### onResume

```java
public void onResume()
```

A callback method invoked when the bot resumes from a paused state.

### onStop

```java
public void onStop()
public void onStop(String reason)
```

A callback method invoked when the bot is stopped. The version accepting a reason is preferred.

### isRunning

```java
public final boolean isRunning()
```

Checks if the bot is currently running.

### isPaused

```java
public final boolean isPaused()
```

Checks if the bot is currently paused.

### isStopped

```java
public final boolean isStopped()
```

Checks if the bot has been stopped.
```

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

### ScriptMetaData - Get Compatibility

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/data/ScriptMetaData

Retrieves the game types the script is compatible with.

```APIDOC
## GET /script/metadata/compatibility

### Description
Gets the game types the script is compatible with.

### Method
GET

### Endpoint
/script/metadata/compatibility

### Parameters
#### Query Parameters
- **botMetaData** (BotMetadata) - Required - The bot's metadata object.

### Response
#### Success Response (200)
- **compatibility** (List<GameType>) - A list of game types the script is compatible with.

#### Response Example
```json
{
  "compatibility": ["OSRS", "RS3"]
}
```
```

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

### PlayerSense.Key Methods

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Methods related to PlayerSense keys, including getting the generator for initial values and the underlying string key.

```APIDOC
## PlayerSense.Key Methods

### Description
Methods associated with the PlayerSense.Key enum, providing access to the generator for player sense profiles and the string representation of the key.

### Methods
- `getGenerator()`
- `getKey()`

### Endpoint
N/A (Enum methods)
```

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

### Pair and PairList Utility Methods

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Utility methods for working with pairs and lists of pairs, including getting left elements.

```APIDOC
## Pair and PairList Utility Methods

### Description
Utility methods for the `Pair` and `PairList` classes, allowing retrieval of the left elements within these structures.

### `Pair` Methods
- `getLeft()`

### `PairList` Methods
- `getLefts()`
- `getLefts(R)`

### Endpoint
N/A (Utility methods)
```

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

### Get Storage Directories - Java

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/hybrid/Environment

Provides access to storage directories for bots. `getSharedStorageDirectory()` offers a common location for shared resources, while `getStorageDirectory(AbstractBot bot)` and `getStorageDirectory()` provide bot-specific or general storage locations respectively.

```java
@Nonnull public static File getSharedStorageDirectory()
Gets a shared storage directory which be be used to share resources between bots. This can improve startup times and save bandwidth. 

Returns:
    A File object that is a folder.
```

```java
@Nonnull public static File getStorageDirectory(AbstractBot bot)
Gets the recommended storage directory for the active botController (and the general directory if a botController isn't running). Usage is not currently required, but is highly recommended. 

Returns:
    A File object that is a folder.
```

```java
@Nonnull public static File getStorageDirectory()

```

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

### AbstractBot Lifecycle Management

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Manages the lifecycle of an AbstractBot, including starting and stopping the bot with reasons and state tracking.

```APIDOC
## AbstractBot Lifecycle

### Description
Manages the execution and termination of an `AbstractBot` instance.

### Methods

- **start(String...)**
  - Starts the bot execution with specified arguments.
- **stop()** (Deprecated)
  - Stops the bot. Replaced by `AbstractBot#stop(String reason)`.
- **stop(String)**
  - Stops the bot and initiates shutdown procedures, providing a reason for termination.

### Enum Constants

- **START** (Enum constant in `com.runemate.game.api.hybrid.util.StringFormat.SubstringPosition`)
  - Indicates the starting position of a substring.
- **STOPPED** (Enum constant in `com.runemate.game.api.script.framework.AbstractBot.State`)
  - Represents the state where the bot has been stopped.
```

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

### StopWatch Utility

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

A utility class for tracking elapsed time, allowing for starting, resuming, and stopping the stopwatch.

```APIDOC
## StopWatch Utility

### Description
A utility class for measuring and tracking time intervals.

### Class

- **StopWatch**
  - A utility class for counting runtime.

### Constructor

- **StopWatch()**
  - Initializes a new StopWatch instance.

### Methods

- **start()**
  - Starts or resumes the stopwatch.
- **stop()**
  - Stops or pauses the stopwatch.
```

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

### Manage Account Aliases - Java

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/hybrid/Environment

Provides methods for retrieving and setting account aliases. `getAccountAlias()` gets the current account's alias, `getAccountAliases()` lists all available aliases, and `setAccount(String alias)` switches the active account.

```java
public static String getAccountAlias()
Gets the alias of the current account if the currently running account has an alias assigned. 

Returns:
    the active account's alias as a `String`, otherwise null if the account doesn't have an alias assigned.
```

```java
public static String getAccountAlias(AbstractBot bot)
Gets the alias of the current account if the currently running account has an alias assigned. 

Returns:
    the active account's alias as a `String`, otherwise null if the account doesn't have an alias assigned.
```

```java
@Nonnull public static List<String> getAccountAliases()
Gets a list of account aliases for all accounts with an alias assigned. 

Returns:
    A non-null List of account aliases as `String`s
```

```java
public static boolean setAccount(String alias)
Sets the active account associated with the current session to the account with the supplied alias. 

Parameters:
    `alias` - An alias representing an account stored by the user within the client. 

Returns:
    true if an account with the given alias exists and was able to be changed within the current session.
```

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

### Environment Settings

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Allows setting the active account and frame bounds for the Runemate environment.

```APIDOC
## Environment Settings

### Description
Provides static methods to configure the Runemate environment, including setting the active user account and adjusting the game frame dimensions.

### Methods

#### `setAccount(String alias)`
- **Description**: Sets the active account associated with the current session to the account with the supplied alias.
- **Method**: STATIC
- **Class**: `com.runemate.game.api.hybrid.Environment`
- **Parameters**:
  - `alias` (String) - The alias of the account to set as active.

#### `setFrameBounds(Rectangle bounds)`
- **Description**: Sets the boundaries of the game frame.
- **Method**: STATIC
- **Class**: `com.runemate.game.api.hybrid.Environment`
- **Parameters**:
  - `bounds` (Rectangle) - The new bounds for the game frame.
```

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

### ScriptMetaData - Get Tagline

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/data/ScriptMetaData

Retrieves the tagline of the script.

```APIDOC
## GET /script/metadata/tagline

### Description
Gets the tagline of the script.

### Method
GET

### Endpoint
/script/metadata/tagline

### Parameters
#### Query Parameters
- **botMetaData** (BotMetadata) - Required - The bot's metadata object.

### Response
#### Success Response (200)
- **tagLine** (String) - The tagline of the script.

#### Response Example
```json
{
  "tagLine": "A great script!"
}
```
```

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

### AbstractBot - run() Method

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

The main entry point for script execution within the AbstractBot framework.

```APIDOC
## AbstractBot - run()

### Description
The main point of execution for a script framework.

### Method
`run()`

### Class
`com.runemate.game.api.script.framework.AbstractBot`
```

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

### Settings Listener

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Documentation for methods related to settings changes and confirmation.

```APIDOC
## Settings Listener

### Description
This section covers methods for reacting to changes in game settings.

### Methods

- **onSettingChanged(SettingChangedEvent)**
  - Description: Called when a specific setting has changed.
  - Interface: `com.runemate.game.api.script.framework.listeners.SettingsListener`

- **onSettingsConfirmed()**
  - Description: Called when the user confirms their settings.
  - Interface: `com.runemate.game.api.script.framework.listeners.SettingsListener`
```

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

### ScriptMetaData - Get Author

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/data/ScriptMetaData

Retrieves the author of the script.

```APIDOC
## GET /script/metadata/author

### Description
Gets the author of the script.

### Method
GET

### Endpoint
/script/metadata/author

### Parameters
#### Query Parameters
- **botMetaData** (BotMetadata) - Required - The bot's metadata object.

### Response
#### Success Response (200)
- **author** (String) - The author of the script.

#### Response Example
```json
{
  "author": "John Doe"
}
```
```

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

### SettingDescriptor Constructor and Methods (Java)

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/ui/setting/descriptor/open/SettingDescriptor

This snippet shows the default constructor for SettingDescriptor and its key methods such as key(), title(), order(), hidden(), and getProperty(). These methods are essential for defining and retrieving settings properties within the Runemate client.

```java
public class SettingDescriptor extends Object implements SettingObject {
  
  public SettingDescriptor() {}

  public String key() {}

  public String title() {}

  public int order() {}

  public boolean hidden() {}

  public <T extends Annotation> T getProperty(Class<? extends T> type) {}
}
```

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

### ScriptMetaData - Get Name

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/data/ScriptMetaData

Retrieves the name of the script.

```APIDOC
## GET /script/metadata/name

### Description
Gets the name of the script.

### Method
GET

### Endpoint
/script/metadata/name

### Parameters
#### Query Parameters
- **botMetaData** (BotMetadata) - Required - The bot's metadata object.

### Response
#### Success Response (200)
- **name** (String) - The name of the script.

#### Response Example
```json
{
  "name": "ExampleScript"
}
```
```

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

### Feature Methods

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Method for getting the display name of a feature.

```APIDOC
## Feature Methods

### Description
Method to retrieve the display name associated with a feature. This method is deprecated.

### Method
- `getDisplayName()`

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

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

### Setting Annotations and Descriptors

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Documentation for annotations and descriptor classes related to UI settings.

```APIDOC
## Settings API

### Description
This section details annotations and descriptor classes used for configuring and managing UI settings within Runemate.

### Methods & Elements

- **order()**
  - Description: Defines the order or position for settings or sections.
  - Used in: `com.runemate.ui.setting.annotation.open.Setting` (annotation element)
  - Used in: `com.runemate.ui.setting.annotation.open.SettingsSection` (annotation element)
  - Used in: `com.runemate.ui.setting.descriptor.open.SettingDescriptor` (method)
  - Used in: `com.runemate.ui.setting.descriptor.open.SettingsSectionDescriptor` (method)
  - Used in: `com.runemate.ui.setting.open.SettingObject` (method)
```

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

### ScriptMetaData - Get Categories

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/data/ScriptMetaData

Retrieves the categories associated with the script.

```APIDOC
## GET /script/metadata/categories

### Description
Gets the categories of the script.

### Method
GET

### Endpoint
/script/metadata/categories

### Parameters
#### Query Parameters
- **botMetaData** (BotMetadata) - Required - The bot's metadata object.

### Response
#### Success Response (200)
- **categories** (List<Category>) - A list of categories the script belongs to.

#### Response Example
```json
{
  "categories": ["TRAINING", "QUESTING"]
}
```
```

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

### Environment Methods

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Static methods for interacting with the game environment, such as retrieving forum IDs, names, ranks, frame bounds, and game types.

```APIDOC
## Environment Methods

### Description
Static methods to query information about the game environment, including details about forums, display settings, and the current game type. Many of these are deprecated.

### Methods
- `getFrameBounds()`
- `getGameType()`

### Deprecated Static Methods
- `getForumId()`
- `getForumName()`
- `getForumRank()`
- `getGameType()`

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

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

### ScriptMetaData - Get ID

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/data/ScriptMetaData

Retrieves the unique identifier for the script.

```APIDOC
## GET /script/metadata/id

### Description
Gets the scripts unique identifier.

### Method
GET

### Endpoint
/script/metadata/id

### Parameters
#### Query Parameters
- **botMetaData** (BotMetadata) - Required - The bot's metadata object.

### Response
#### Success Response (200)
- **id** (int) - The unique identifier of the script.

#### Response Example
```json
{
  "id": 12345
}
```
```

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

### Implement SettingsListener: onSettingChanged and onSettingsConfirmed

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/framework/listeners/SettingsListener

This Java interface extends EventListener and provides callbacks for when game settings change or are confirmed. Implement these methods to integrate custom logic into the Runemate client's setting management.

```java
public interface SettingsListener extends EventListener {
    /**
     * Called when a setting has been changed.
     *
     * @param event The event containing information about the changed setting.
     */
    void onSettingChanged(SettingChangedEvent event);

    /**
     * Called when settings have been confirmed.
     */
    void onSettingsConfirmed();
}
```

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

### CachedQuestStatus Methods

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Method for getting the name of a cached quest status.

```APIDOC
## CachedQuestStatus Methods

### Description
Method to retrieve the name of a cached quest status.

### Method
- `getName()`

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

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

### CachedBankItem Constructor and Methods

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/client/game/account/open/CachedBankItem

Provides details on creating CachedBankItem objects and accessing their properties.

```APIDOC
## CachedBankItem Constructor

### Description
Creates a new CachedBankItem instance.

### Method
`CachedBankItem`

### Endpoint
N/A (Constructor)

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

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```json
{
  "id": 123,
  "quantity": 10,
  "index": 0
}
```

### Response
#### Success Response (200)
N/A (Constructor)

#### Response Example
N/A (Constructor)

---

## fromString

### Description
Creates a CachedBankItem instance from a string representation.

### Method
`static CachedBankItem`

### Endpoint
N/A (Static Method)

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

#### Query Parameters
N/A

#### Request Body
- **string** (String) - Required - The string representation of the CachedBankItem.

### Request Example
```json
{
  "string": "item_id:quantity:index"
}
```

### Response
#### Success Response (200)
- **CachedBankItem** (CachedBankItem) - The created CachedBankItem object.

#### Response Example
```json
{
  "id": 123,
  "quantity": 10,
  "index": 0
}
```

---

## getId

### Description
Retrieves the ID of the bank item.

### Method
`int`

### Endpoint
N/A (Instance Method)

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

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **id** (int) - The ID of the bank item.

#### Response Example
```json
{
  "id": 123
}
```

---

## getQuantity

### Description
Retrieves the quantity of the bank item.

### Method
`int`

### Endpoint
N/A (Instance Method)

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

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **quantity** (int) - The quantity of the bank item.

#### Response Example
```json
{
  "quantity": 10
}
```

---

## getIndex

### Description
Retrieves the index of the bank item in the bank.

### Method
`int`

### Endpoint
N/A (Instance Method)

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

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **index** (int) - The index of the bank item.

#### Response Example
```json
{
  "index": 0
}
```

---

## toString

### Description
Returns a string representation of the CachedBankItem.

### Method
`String`

### Endpoint
N/A (Instance Method)

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

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **stringRepresentation** (String) - The string representation of the CachedBankItem.

#### Response Example
```json
{
  "stringRepresentation": "123:10:0"
}
```
```

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

### BotLogger.Level Methods

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Method for getting the description of a bot logger level.

```APIDOC
## BotLogger.Level Methods

### Description
Method to get a description of the bot logger level. This method is deprecated.

### Method
- `getDescription()`

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

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

### ClientUI Alerts and Toasts

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Provides methods for displaying various types of alerts and progress toasts to the user within the RuneMate client interface.

```APIDOC
## ClientUI Alert and Toast Methods

### Description
Methods for displaying messages and notifications to the user in the RuneMate client.

### Methods

- **showAlert(ClientUI.AlertLevel, String)**
  - Displays a message with a specified alert level and text.
- **showAlert(ClientUI.AlertLevel, String, long, TimeUnit)**
  - Displays a message with a specified alert level, text, and duration.
- **showAlert(String)**
  - Displays a message with the default alert level.
- **showAlert(String, long, TimeUnit)**
  - Displays a message with the default alert level and duration.
- **showError(String)**
  - Displays an error message with the ERROR alert level.
- **showProgressToast()**
  - Displays a default progress toast.
- **showProgressToast(String)**
  - Displays a progress toast with a custom message.
- **showProgressToast(String, long)**
  - Displays a progress toast with a custom message and duration.
- **showProgressToast(String, long, TimeUnit)**
  - Displays a progress toast with a custom message, duration, and time unit.
```

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

### AbstractBot Class Overview

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/framework/AbstractBot

Provides an overview of the AbstractBot class, its purpose, and recommended usage.

```APIDOC
## AbstractBot Class

### Description
The raw form of a script. It is not recommended to extend this directly, and instead it is advised to build your framework off of a `com.runemate.game.api.script.framework.LoopingBot`.

### Fields
- **cache** (Map<String, Object>) - A map for caching data.

### Constructors
- **AbstractBot()** - Constructs an AbstractBot instance.

### Methods
- **detach()**: Detaches the bot.
- **equals(Object o)**: Checks for equality with another object.
- **getCache()**: Returns the cache map.
- **getConfiguration()**: Returns the bot's configuration.
- **getEmbeddableUI()**: Returns the embeddable UI component.
- **getEventDispatcher()**: Returns the event dispatcher.
- **getGameEventController()**: Returns the game event controller.
- **getInputManager()**: Returns the input manager.
- **getMetadata()**: Returns the bot's metadata.
- **getPlatform()**: Returns the bot's platform.
- **getProperties()**: Returns stored properties for the bot.
- **getSettings()**: Deprecated. Use `getProperties()` instead.
- **getSettingsManager()**: Returns the settings manager.
- **getState()**: Returns the current execution state of the script.
- **hashCode()**: Returns the hash code of the bot.
- **isPaused()**: Checks if the bot is paused.
- **isRestarting()**: Deprecated. Checks if the bot is restarting.
- **isRunning()**: Checks if the bot is running.
- **isStopped()**: Checks if the bot is stopped.
- **isUnstarted()**: Checks if the bot is unstarted.
- **onPause()**: Called when the bot is paused.
- **onResume()**: Called when the bot resumes execution.
- **onStart(String... arguments)**: Called when the script starts.
- **onStop()**: Deprecated. Use `onStop(String reason)` instead.
- **onStop(String reason)**: Called when the script stops, with a reason.
- **pause()**: Pauses the bot.
- **pause(String reason)**: Pauses the bot with a reason.
- **resume()**: Resumes the bot's execution.
- **run()**: The main execution method for the script.
- **setEmbeddableUI(EmbeddableUI embeddableUI)**: Sets the embeddable UI.
- **setEmbeddableUI(Callable<javafx.scene.Node> callableNode)**: Sets the embeddable UI using a callable node.
- **start(String... arguments)**: Starts the bot with arguments.
- **stop()**: Deprecated. Use `stop(String reason)` instead.
- **stop(String reason)**: Stops the bot and initiates shutdown.
```

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

### GameType Enum Methods

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Method for getting the full name of a game type.

```APIDOC
## GameType Enum Methods

### Description
Method to retrieve the full name of a specific game type. This method is deprecated.

### Method
- `getFullName()`

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

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

### EventDispatcher Constructor

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/framework/core/EventDispatcher

Initializes the EventDispatcher with a reference to the AbstractBot.

```APIDOC
## EventDispatcher Constructor

### Description
Initializes the EventDispatcher with a reference to the AbstractBot.

### Method
Constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
EventDispatcher dispatcher = new EventDispatcher(abstractBotInstance);
```

### Response
#### Success Response (N/A)
This is a constructor.

#### Response Example
N/A
```

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

### ScriptMetaData - Get Declared Resources

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/data/ScriptMetaData

Retrieves a list of resources declared by the script.

```APIDOC
## GET /script/metadata/declared-resources

### Description
Gets a list of resources declared by the script.

### Method
GET

### Endpoint
/script/metadata/declared-resources

### Parameters
#### Query Parameters
- **botMetaData** (BotMetadata) - Required - The bot's metadata object.

### Response
#### Success Response (200)
- **declaredResources** (List<String>) - A list of declared resource names.

#### Response Example
```json
{
  "declaredResources": ["resource1.dat", "resource2.png"]
}
```
```

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

### Instantiate SettingsConfirmedEvent in Java

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/framework/listeners/events/SettingsConfirmedEvent

This snippet shows how to instantiate the `SettingsConfirmedEvent` class. This class is part of the `com.runemate.game.api.script.framework.listeners.events` package and implements the `Event` interface. No specific dependencies are mentioned beyond the core Runemate API.

```java
import com.runemate.game.api.script.framework.listeners.events.SettingsConfirmedEvent;

// ...

SettingsConfirmedEvent event = new SettingsConfirmedEvent();
```

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

### Event Creation Methods

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/framework/core/EventDispatcher

Abstract methods for creating various types of game events.

```APIDOC
## Event Creation Methods

### Description
Abstract factory methods for creating specific types of game events. These are intended to be implemented by subclasses to provide concrete event instances.

### Method
`createMenuInteractionEvent(...)`
`createServerTickEvent(...)`
`createEngineCycleEvent(...)`
`createRegionLoadedEvent(...)`
`createAnimationEvent(...)`
`createTargetEvent(...)`
`createHitsplatEvent(...)`
`createDeathEvent(...)`
`createPlayerMovedEvent(...)`
`createNpcSpawnEvent(...)`
`createNpcDefinitionChangeEvent(...)`
`createNpcDespawnEvent(...)`
`createProjectileMovedEvent(...)`
`createProjectileLaunchedEvent(...)`
`createScriptStartEvent(...)`
`createChatboxEvent(...)`
`createConnectionStateEvent(...)`
`createGroundItemEvent(...)`
`createVarcIntEvent(...)`
`createVarcStringEvent(...)`
`createVarbitEvent(...)`
`createVarpEvent(...)`
`createEventObjectSpawnEvent(...)`
`createEventObjectDespawnEvent(...)`
`createSpotAnimationEvent(...)` (two overloads)
`processItemEventsFromChange(...)`
`onCurrentLevelUpdated(...)`
`onExperienceUpdated(...)`
`onEntityHovered(...)`

### Endpoint
N/A (Instance methods)

### Parameters
Each method has specific parameters corresponding to the event data. See specific method signatures for details.

### Request Example
```java
// Example for createMenuInteractionEvent
dispatcher.createMenuInteractionEvent(1, 2, 3, 4, 5, "click", "item", 10, 20);

// Example for createAnimationEvent
dispatcher.createAnimationEvent(openActorInstance, 12345);
```

### Response
#### Success Response (200)
Each method typically returns a specific event type or void. These are abstract methods and expected to be implemented by subclasses.

#### Response Example
N/A (These are abstract factory methods)
```

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

### ScriptMetaData - Get Author ID

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/data/ScriptMetaData

Retrieves the author's ID for the script.

```APIDOC
## GET /script/metadata/author-id

### Description
Gets the author's unique identifier for the script.

### Method
GET

### Endpoint
/script/metadata/author-id

### Parameters
#### Query Parameters
- **botMetaData** (BotMetadata) - Required - The bot's metadata object.

### Response
#### Success Response (200)
- **authorId** (int) - The author's unique identifier.

#### Response Example
```json
{
  "authorId": 54321
}
```
```

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

### ScriptMetaData - Get Hourly Price

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/data/ScriptMetaData

Retrieves the hourly price associated with the script.

```APIDOC
## GET /script/metadata/hourly-price

### Description
Gets the hourly price for the script.

### Method
GET

### Endpoint
/script/metadata/hourly-price

### Parameters
#### Query Parameters
- **botMetaData** (BotMetadata) - Required - The bot's metadata object.

### Response
#### Success Response (200)
- **hourlyPrice** (BigDecimal) - The hourly price of the script.

#### Response Example
```json
{
  "hourlyPrice": "5.00"
}
```
```

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

### AccountData Class

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Handles account data, including constructors for initializing with a string and GameType.

```APIDOC
## Class AccountData<T extends AccountData>

### Description
Handles account data.

### Class
com.runemate.client.game.account.open.AccountData

### Constructors
- **AccountData(String, GameType)** - Constructor for class com.runemate.client.game.account.open.AccountData
```

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

### PairList Methods

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/hybrid/util/collections/PairList

This section details the methods available for the PairList class.

```APIDOC
## Methods

### add(L left, R right)

Adds a new pair to the list.

- **left** (L) - The left element of the pair.
- **right** (R) - The right element of the pair.

### contains(L left, R right)

Checks if the list contains the specified pair.

- **left** (L) - The left element of the pair to check.
- **right** (R) - The right element of the pair to check.

- **Returns** (boolean) - True if the pair is found, false otherwise.

### getRights(L left)

Gets all the right elements associated with a given left element.

- **left** (L) - The left element to search for.

- **Returns** (List<R>) - A list of right elements.

### getRights()

Gets all the right elements in the list.

- **Returns** (List<R>) - A list of all right elements.

### getLefts(R right)

Gets all the left elements associated with a given right element.

- **right** (R) - The right element to search for.

- **Returns** (List<L>) - A list of left elements.

### getLefts()

Gets all the left elements in the list.

- **Returns** (List<L>) - A list of all left elements.
```

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

### ScriptMetaData - Get Discussion Thread

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/data/ScriptMetaData

Retrieves the link to the script's discussion thread.

```APIDOC
## GET /script/metadata/discussion-thread

### Description
Gets the link to the discussion thread when called from a bot that's not being ran locally.

### Method
GET

### Endpoint
/script/metadata/discussion-thread

### Parameters
#### Query Parameters
- **botMetaData** (BotMetadata) - Required - The bot's metadata object.

### Response
#### Success Response (200)
- **discussionThread** (String) - The URL to the discussion thread.

#### Response Example
```json
{
  "discussionThread": "https://www.example.com/forums/script-thread"
}
```
```

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

### ClientUI

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/client/package-summary

Provides utilities for manipulating the client's user interface.

```APIDOC
## ClientUI

### Description
A utility for manipulating the clients user-interface.

### Method
N/A (Class definition)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

```

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

### Java Enum Access Constants and Methods

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/data/Access

This snippet shows the deprecated enum constants PUBLIC, SUPPORTER, and PRIVATE, along with the static methods 'values()' to get all constants and 'valueOf(String name)' to get a specific constant by name. These were part of the Runemate Game API.

```java
public enum Access extends Enum<Access>
{
    PRIVATE
    PUBLIC
    SUPPORTER

    public static Access[] values()
    {
        // Implementation omitted for brevity
    }

    public static Access valueOf(String name)
    {
        // Implementation omitted for brevity
    }
}
```

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

### BotService Methods

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/client/framework/open/BotService

This section details the various methods available in the BotService interface, including methods for managing the user interface, event dispatching, input management, and bot lifecycle.

```APIDOC
## BotService API

### Description
Provides access to core bot functionalities and services.

### Methods

#### `getEventController()`
* **Description**: Retrieves the event controller.
* **Returns**: `Task`

#### `getEventDispatcher()`
* **Description**: Retrieves the event dispatcher.
* **Returns**: `EventDispatcher`

#### `getInputManager()`
* **Description**: Retrieves the input manager service.
* **Returns**: `com.runemate.client.framework.open.BotInputService`

#### `createDefaultUserInterface()`
* **Description**: Creates and returns a default user interface.
* **Returns**: `EmbeddableUI`

#### `close()`
* **Description**: Closes the bot service.
* **Returns**: `void`

#### `getInstance(AbstractBot bot)`
* **Description**: Gets an instance of the BotService for a given bot.
* **Parameters**:
    * **bot** (AbstractBot) - The bot instance.
* **Returns**: `static BotService`
```

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

### EmbeddableUI Interface

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Interface for embeddable UI components, providing a method to get the bot interface property.

```APIDOC
## Interface EmbeddableUI

### Description
Interface for embeddable UI components.

### Methods
- **botInterfaceProperty()** - Returns the bot interface property.
```

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

### AbstractBot - resume() Method

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/index-all

Resumes the bot's execution, placing it back into the RUNNING state.

```APIDOC
## AbstractBot - resume()

### Description
Places the bot back into `AbstractBot.State.RUNNING`.

### Method
`resume()`

### Class
`com.runemate.game.api.script.framework.AbstractBot`
```

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

### PlayerSense Management API

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/hybrid/player_sense/PlayerSense

This section details the methods for interacting with PlayerSense, including getting, setting, and clearing data.

```APIDOC
## PlayerSense Management

### Description
Provides methods to interact with player-specific sense data.

### Methods

#### `get(PlayerSense.Key key)`

##### Description
Gets the value of the player sense element with the given predefined key.

##### Method
GET

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

##### Parameters
*   **key** (PlayerSense.Key) - Required - The predefined key for the player sense element.

##### Response
*   **Success Response (200)**: `Object` - The value associated with the key.

#### `get(String key)`

##### Description
Gets the value of the player sense element with the given key.

##### Method
GET

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

##### Parameters
*   **key** (String) - Required - The custom key for the player sense element.

##### Response
*   **Success Response (200)**: `Object` - The value associated with the key.

#### `getAsBoolean(PlayerSense.Key key)`

##### Description
Gets the value of the player sense element with the given predefined key as a Boolean.

##### Method
GET

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

##### Parameters
*   **key** (PlayerSense.Key) - Required - The predefined key for the player sense element.

##### Response
*   **Success Response (200)**: `Boolean` - The boolean value associated with the key.

#### `getAsBoolean(String key)`

##### Description
Gets the value of the player sense element with the given key as a Boolean.

##### Method
GET

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

##### Parameters
*   **key** (String) - Required - The custom key for the player sense element.

##### Response
*   **Success Response (200)**: `Boolean` - The boolean value associated with the key.

#### `getAsBoolean(String key, Supplier<Boolean> generator)`

##### Description
Gets the value of the player sense element with the given key as a Boolean, using a generator if the key is not found.

##### Method
GET

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

##### Parameters
*   **key** (String) - Required - The custom key for the player sense element.
*   **generator** (Supplier<Boolean>) - Required - A supplier function to generate the value if the key is absent.

##### Response
*   **Success Response (200)**: `Boolean` - The boolean value associated with the key or generated.

#### `getAsDouble(PlayerSense.Key key)`

##### Description
Gets the value of the player sense element with the given predefined key as a Double.

##### Method
GET

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

##### Parameters
*   **key** (PlayerSense.Key) - Required - The predefined key for the player sense element.

##### Response
*   **Success Response (200)**: `Double` - The double value associated with the key.

#### `getAsDouble(String key)`

##### Description
Gets the value of the player sense element with the given key as a Double.

##### Method
GET

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

##### Parameters
*   **key** (String) - Required - The custom key for the player sense element.

##### Response
*   **Success Response (200)**: `Double` - The double value associated with the key.

#### `getAsDouble(String key, Supplier<Double> generator)`

##### Description
Gets the value of the player sense element with the given key as a Double, using a generator if the key is not found.

##### Method
GET

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

##### Parameters
*   **key** (String) - Required - The custom key for the player sense element.
*   **generator** (Supplier<Double>) - Required - A supplier function to generate the value if the key is absent.

##### Response
*   **Success Response (200)**: `Double` - The double value associated with the key or generated.

#### `getAsInteger(PlayerSense.Key key)`

##### Description
Gets the value of the player sense element with the given predefined key as an Integer.

##### Method
GET

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

##### Parameters
*   **key** (PlayerSense.Key) - Required - The predefined key for the player sense element.

##### Response
*   **Success Response (200)**: `Integer` - The integer value associated with the key.

#### `getAsInteger(String key)`

##### Description
Gets the value of the player sense element with the given key as an Integer.

##### Method
GET

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

##### Parameters
*   **key** (String) - Required - The custom key for the player sense element.

##### Response
*   **Success Response (200)**: `Integer` - The integer value associated with the key.

#### `getAsInteger(String key, Supplier<Integer> generator)`

##### Description
Gets the value of the player sense element with the given key as an Integer, using a generator if the key is not found.

##### Method
GET

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

##### Parameters
*   **key** (String) - Required - The custom key for the player sense element.
*   **generator** (Supplier<Integer>) - Required - A supplier function to generate the value if the key is absent.

##### Response
*   **Success Response (200)**: `Integer` - The integer value associated with the key or generated.

#### `getAsLong(PlayerSense.Key key)`

##### Description
Gets the value of the player sense element with the given predefined key as a Long.

##### Method
GET

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

##### Parameters
*   **key** (PlayerSense.Key) - Required - The predefined key for the player sense element.

##### Response
*   **Success Response (200)**: `Long` - The long value associated with the key.

#### `getAsLong(String key)`

##### Description
Gets the value of the player sense element with the given key as a Long.

##### Method
GET

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

##### Parameters
*   **key** (String) - Required - The custom key for the player sense element.

##### Response
*   **Success Response (200)**: `Long` - The long value associated with the key.

#### `getAsLong(String key, Supplier<Long> generator)`

##### Description
Gets the value of the player sense element with the given key as a Long, using a generator if the key is not found.

##### Method
GET

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

##### Parameters
*   **key** (String) - Required - The custom key for the player sense element.
*   **generator** (Supplier<Long>) - Required - A supplier function to generate the value if the key is absent.

##### Response
*   **Success Response (200)**: `Long` - The long value associated with the key or generated.

#### `put(PlayerSense.Key key, Object data)`

##### Description
Puts the given data into the player sense element with the given predefined key.

##### Method
PUT

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

##### Parameters
*   **key** (PlayerSense.Key) - Required - The predefined key for the player sense element.
*   **data** (Object) - Required - The data to store.

##### Response
*   **Success Response (200)**: void

#### `put(String key, Object data)`

##### Description
Puts the given data into the player sense element with the given key.

##### Method
PUT

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

##### Parameters
*   **key** (String) - Required - The custom key for the player sense element.
*   **data** (Object) - Required - The data to store.

##### Response
*   **Success Response (200)**: void

#### `clear(PlayerSense.Key key)`

##### Description
Clears the player sense element with the given predefined key.

##### Method
DELETE

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

##### Parameters
*   **key** (PlayerSense.Key) - Required - The predefined key for the player sense element.

##### Response
*   **Success Response (200)**: void

#### `clear(String key)`

##### Description
Clears the player sense element with the given key.

##### Method
DELETE

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

##### Parameters
*   **key** (String) - Required - The custom key for the player sense element.

##### Response
*   **Success Response (200)**: void

```

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

### LoopingThread Constructors

Source: https://runemate.gitlab.io/community/runemate-game-api/runemate-client/com/runemate/game/api/script/framework/core/LoopingThread

Details on the various constructors available for the LoopingThread class.

```APIDOC
## LoopingThread Constructors

### Description
Details on the various constructors available for the LoopingThread class.

### Constructors

*   **LoopingThread(AbstractBot bot, Runnable runnable, int minLoopDelay, int maxLoopDelay)**
    *   Creates a new LoopingThread with a specified bot, runnable task, and delay range.

*   **LoopingThread(Runnable runnable, int loopDelay)**
    *   Creates a new LoopingThread with a runnable task and a fixed loop delay.

*   **LoopingThread(Runnable runnable, int minLoopDelay, int maxLoopDelay)**
    *   Creates a new LoopingThread with a runnable task and a minimum and maximum loop delay.

*   **LoopingThread(ThreadGroup group, Runnable runnable, int loopDelay)**
    *   Creates a new LoopingThread within a specified thread group, with a runnable task and a fixed loop delay.

*   **LoopingThread(ThreadGroup group, Runnable runnable, int minLoopDelay, int maxLoopDelay)**
    *   Creates a new LoopingThread within a specified thread group, with a runnable task and a delay range.
```
Tokens:
Raw