### Quest.getQuestPointsRequired() Method API Documentation

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/Quest

Gets the total number of quest points required from other quests before this quest can be started.

```APIDOC
Method: getQuestPointsRequired
Signature: public int getQuestPointsRequired()
```

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

### BankSettings Constructor Summary

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/BankSettings

Lists all available constructors for the `BankSettings` class.

```APIDOC
Constructors:
- BankSettings()
```

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

### API Documentation: Class Summary

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/walking/adapter/package-summary

Lists and describes the classes available within the `org.tribot.script.sdk.walking.adapter` package. These classes provide concrete implementations or utilities for walking functionalities.

```APIDOC
Class: DaxWalkerAdapter
  Description: A walking adapter for using dax walker.
```

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

### API: Get Hint Arrow Position

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/GameState

Gets the `LocalTile` object representing the location where the game's hint arrow is currently pointing. This arrow often guides players to objectives or specific locations. The method returns an `Optional<LocalTile>`, which will be empty if no hint arrow is active.

```Java
public static java.util.Optional<LocalTile> getHintArrowPosition()
```

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

### Get Model from Modellable Entity

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/interfaces/Modellable

Retrieves the 3D model associated with the `Modellable` entity. The method returns an `Optional<Model>`, which will be empty if the model cannot be obtained, for example, if the entity is not currently visible on screen.

```APIDOC
Method: getModel
  Signature: java.util.Optional<Model> getModel()
  Description: Gets the entity model
  Returns: the entity model, or an empty optional if the model could not be obtained (ex. not visible on screen)
```

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

### PreBreakStartListener Interface API Reference

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/interfaces/PreBreakStartListener

Detailed API documentation for the `PreBreakStartListener` interface, including its definition and the `onBreakStart` method signature, parameters, and description.

```APIDOC
PreBreakStartListener Interface:
  Description: Represents a listener for tribot break starts
  Definition:
    public interface PreBreakStartListener
  Methods:
    onBreakStart(long msLength):
      Description: Called when a break is started
      Parameters:
        msLength: The length of the break in milliseconds
      Return Type: void
```

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

### DaxWalkerAdapter API Reference

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/walking/adapter/DaxWalkerAdapter

Detailed API documentation for the `DaxWalkerAdapter` class, including its nested classes, constructors, and methods with their parameters, return types, and descriptions.

```APIDOC
Class DaxWalkerAdapter:
  Extends: java.lang.Object
  Implements: GlobalWalkerAdapter

  Nested Classes:
    DaxWalkerAdapter.Teleport (enum)

  Constructors:
    DaxWalkerAdapter(publicKey: java.lang.String, secretKey: java.lang.String)
      Description: Creates a new DaxWalkerAdapter
      Parameters:
        publicKey: the dax walker public api key
        secretKey: the dax walker secret api key

  Methods:
    setGlobalWalkingCondition(globalWalkingCondition: java.util.function.Supplier<org.tribot.script.sdk.walking.WalkState>): void
      Description: Sets the global walking condition.

    setMoveCosts(moveCost: int): void

    walkTo(position: org.tribot.script.sdk.interfaces.Positionable): boolean
      Description: Walks to the specified position
      Parameters:
        position: the position to walk to
      Returns: true if walked successfully, false otherwise

    walkTo(position: org.tribot.script.sdk.interfaces.Positionable, walkCondition: java.util.function.Supplier<org.tribot.script.sdk.walking.WalkState>): boolean
      Description: Walks to the specified position
      Parameters:
        position: the position to walk to
        walkCondition: the walking condition to break out of walking early - this is checked often while walking
      Returns: true if walked successfully, false otherwise

    walkToBank(): boolean
      Description: Attempts to walk to the nearest bank
      Returns: true if walked successfully, false otherwise

    walkToBank(walkCondition: java.util.function.Supplier<org.tribot.script.sdk.walking.WalkState>): boolean
      Description: Attempts to walk to the nearest bank
```

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

### Get All Login.LoginMessage Enum Constants (values)

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/Login.LoginMessage

Returns an array containing all constants of the `Login.LoginMessage` enum type in their declared order. This method is useful for iterating over all possible login messages, for example, to display them or process them programmatically.

```APIDOC
public static Login.LoginMessage[] values()

Returns:
  an array containing the constants of this enum type, in the order they are declared
```

```Java
for (Login.LoginMessage c : Login.LoginMessage.values())
    System.out.println(c);
```

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

### RuneAutomation Options: Get Run Energy

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/Options

Gets the current run energy of the player character. This method is deprecated.

```APIDOC
Options:
  getRunEnergy():
    deprecated: "Gets the current run energy of the player character."
    returns: "The current run energy (0-100)"
    see_also: "MyPlayer.html#getRunEnergy()"
```

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

### BankSettings Method Summary

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/BankSettings

Provides a comprehensive summary of all static methods available in the `BankSettings` class, detailing their return types, names, and brief descriptions related to bank interactions.

```APIDOC
Methods:
- static int getDefaultWithdrawQuantity(): Gets the default withdraw quantity
- static BankSettings.WithdrawQuantity getWithdrawQuantity(): Gets the withdraw quantity
- static int getWithdrawXQuantity(): Gets the withdraw-x quantity
- static boolean isBankInventoryItemOptionEnabled(): Checks if bank inventory item option is enabled
- static boolean isDepositEquipmentEnabled(): Checks if deposit equipment is enabled
- static boolean isNoteEnabled(): Checks if noting is enabled (ex.
- static boolean isPlaceholdersEnabled(): Checks if placeholders are enabled
- static boolean isPlaceholdersOn(): Deprecated.
- static boolean setNoteEnabled(boolean enabled): Attempts to enable/disable noting
- static boolean setWithdrawQuantity(BankSettings.WithdrawQuantity withdrawQuantity): Attempts to set the withdraw quantity
- static boolean setWithdrawXQuantity(int quantity): Attempts to set the specified withdraw-x quantity
```

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

### GlobalWalkerAdapter Interface API Reference

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/walking/adapter/GlobalWalkerAdapter

Detailed API documentation for the `GlobalWalkerAdapter` interface, outlining its purpose and the methods it provides for pathfinding and movement within the game environment.

```APIDOC
Interface GlobalWalkerAdapter
  Description: Provides a definition for a webwalker that can be set as the engine of the GlobalWalker API

  Methods:
    walkTo(Positionable position)
      Description: Walks to the specified position
      Parameters:
        position: Positionable - the position to walk to
      Returns: boolean - true if walked successfully, false otherwise

    walkTo(Positionable position, java.util.function.Supplier<WalkState> walkCondition)
      Description: Walks to the specified position
      Parameters:
        position: Positionable - the position to walk to
        walkCondition: java.util.function.Supplier<WalkState> - the walking condition to break out of walking early - this is checked often while walking
      Returns: boolean - true if walked successfully, false otherwise

    walkToBank()
      Description: Attempts to walk to the nearest bank
      Parameters: None
      Returns: boolean - true if walked successfully, false otherwise

    walkToBank(java.util.function.Supplier<WalkState> walkCondition)
      Description: Attempts to walk to the nearest bank
      Parameters:
        walkCondition: java.util.function.Supplier<WalkState> - the walking condition to break out of walking early - this is checked often while walking
      Returns: boolean - true if walked successfully, false otherwise
```

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

### Remove Pre-Break Start Listener

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/ScriptListening

Removes a previously registered listener that was set to execute just before a script break officially starts.

```APIDOC
ScriptListening.removePreBreakStartListener:
  public static void removePreBreakStartListener(PreBreakStartListener listener)
  Description: Removes a pre break start listener
  Parameters:
    listener: PreBreakStartListener - the listener to remove
```

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

### API Documentation: Interface Summary

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/walking/adapter/package-summary

Lists and describes the interfaces available within the `org.tribot.script.sdk.walking.adapter` package. These interfaces define contracts for webwalkers that can be integrated into the GlobalWalker API.

```APIDOC
Interface: GlobalWalkerAdapter
  Description: Provides a definition for a webwalker that can be set as the engine of the GlobalWalker API
```

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

### Quest.getState() Method API Documentation

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/Quest

Retrieves the current completion state of this quest. This indicates whether the quest is started, completed, or not started.

```APIDOC
Method: getState
Signature: public Quest.State getState()
Returns:
  the current state of this quest
```

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

### Add Break Start Listener

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/ScriptListening

Adds a listener that will be executed when a script break period begins. This allows for actions to be taken at the start of a break.

```APIDOC
ScriptListening.addBreakStartListener:
  public static void addBreakStartListener(BreakStartListener listener)
  Description: Adds a listener that will run when a break starts
  Parameters:
    listener: BreakStartListener - the break start listener
```

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

### BankPinScreen Constructor

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/BankPinScreen

Initializes a new instance of the `BankPinScreen` class. As all methods are static, direct instantiation is typically not required for its utility functions.

```APIDOC
public BankPinScreen()
```

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

### API Documentation for org.tribot.script.sdk.input Package

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/input/package-summary

This section details the classes and enums within the `org.tribot.script.sdk.input` package, providing their names and a brief description of their purpose. It covers utilities for keyboard and mouse interactions, including key holding configurations and mouse clicking methods.

```APIDOC
Package org.tribot.script.sdk.input:
  Classes:
    Keyboard:
      Description: Utilities related to using the keyboard/typing in-game
      Nested Classes:
        Keyboard.HoldAction:
          Description: Represents a key hold configuration
          Nested Classes:
            Keyboard.HoldAction.KeyHoldContext:
              Description: Represents the context of a current key hold action.
    Mouse:
      Description: Utilities related to the virtual mouse.
  Enums:
    Keyboard.HoldAction.Key:
      Description: Represents a key that can be held.
    Mouse.ClickMethod:
      Description: Represents an entity clicking method
```

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

### RuneAutomation Options: Get Resizable Mode Type

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/Options

Gets the resizable game mode type (fixed, resizable classic, resizable modern).

```APIDOC
Options:
  getResizableModeType():
    description: "Gets the resizable game mode type (fixed, resizable classic, resizable modern)"
    returns: "the resizable game mode type"
```

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

### Java Options Class API Documentation

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/Options

Comprehensive API documentation for the `org.tribot.script.sdk.Options` class, detailing its purpose, nested classes, constructors, and methods for interacting with game settings and UI elements.

```APIDOC
Options Class:
  Description: Utilities for getting information related to what's in the Options Tab and Minimap HUD. Also provides ways to change and toggle settings.
  Extends: java.lang.Object

  Nested Classes:
    - AttackOption (static class, enum in org.tribot.script.sdk)
    - ChatboxScrollPosition (static class, enum in org.tribot.script.sdk)
    - HouseDoor (static class, enum in org.tribot.script.sdk)
    - ResizableType (static class, enum in org.tribot.script.sdk)
    - Tab (static class, enum in org.tribot.script.sdk)

  Constructors:
    - Options(): No description provided.

  Methods:
    - closeAllSettings(): static boolean
    - closeHouseOptionsTab(): static boolean, Closes House Options Tab
    - getHouseDoorState(): static Options.HouseDoor
    - getResizableModeType(): static Options.ResizableType, Gets the resizable game mode type (fixed, resizable classic, resizable modern)
    - getRunEnergy(): static int, Deprecated.
    - getScrollbarRightPosition(): static Options.ChatboxScrollPosition, Determines whether the option to set scroll-bars as right-aligned is enabled.
    - isAcceptAidEnabled(): static boolean
    - isAcceptTradeDelayEnabled(): static boolean, Determine if accept trade delay is enabled
    - isAllSettingsOpen(): static boolean
    - isAnySoundOn(): static boolean, Determines if any sounds is on or off
    - isAreaSoundOn(): static boolean, Determines if Area sound is on or off.
    - isClickThroughChatboxEnabled(): static boolean, Determines whether the option to set the chat-box as click-through is enabled.
    - isDataOrbsEnabled(): static boolean, Determines whether the option to display data-orbs (the UIs on the side of the mini-map) is enabled.
    - isDisableLevelUpInterfaceEnabled(): static boolean, Determine if disable level up interface is enabled
    - isEscapeClosingEnabled(): static boolean
    - isFollowerOptionsLowerDownEnabled(): static boolean, Determines whether the option to show follower (summoning) options lower down is enabled.
    - isGrandExchangeBuyWarningEnabled(): static boolean, Determine if grand exchange buy warning is enabled
    - isGrandExchangeSellWarningEnabled(): static boolean, Determine if grand exchange sell warning is enabled
    - isHouseOptionsTabOpen(): static boolean, Determine if house options tab is open
    - isHouseTeleportInsideEnabled(): static boolean, Determine if house teleport inside is on or off
    - isMouseCameraEnabled(): static boolean, Determines whether the option to use the middle mouse button to adjust the camera is enabled.
    - isMouseScrollZoomEnabled(): static boolean, Determines whether the option to allow viewport zooming via mouse wheel scrolling is enabled.
    - isMusicSoundOn(): static boolean, Determines if Music is on or off.
    - isMusicUnlockMessageEnabled(): static boolean, Determine if music unlock message is on or off
    - isPrayerTooltipEnabled(): static boolean, Determines whether the option to use prayer tool-tips is enabled.
    - isResizableModeEnabled(): static boolean, Determines if the resizable mode setting is enabled.
    - isRoofsEnabled(): static boolean, Checks if roofs are currently enabled (roofs are being drawn)
```

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

### Iterating Player.OverheadIcon Enum Constants Example

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/types/Player.OverheadIcon

A Java code example demonstrating how to iterate over the constants of the `Player.OverheadIcon` enum using its `values()` method, typically for printing or processing each constant.

```Java
for (Player.OverheadIcon c : Player.OverheadIcon.values())
    System.out.println(c);
```

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

### API Reference for GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder

Comprehensive API documentation for the `GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder` class, detailing its methods, their parameters, return types, and descriptions for configuring Grand Exchange offers.

```APIDOC
Class: GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder
  Extends: java.lang.Object
  Enclosing class: GrandExchange.CreateOfferConfig

Methods:
  type(type: org.tribot.script.sdk.types.GrandExchangeOffer.Type): GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder
    Description: The type of the grand exchange offer to place. Defaults to a buy offer.
    Returns: this.
  slot(slot: org.tribot.script.sdk.types.GrandExchangeOffer.Slot): GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder
    Description: The slot to place the offer in. Optional.
    Returns: this.
  priceAdjustment(priceAdjustment: int): GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder
    Description: Either this or price is required. However, this defaults to guide price. A price adjustment is adding/subtracting 5%. Specify a positive number for adding, and a negative number for subtractive. The magnitude of the number is the amount of times to add/subtract 5%. For example, a price adjustment of 10% would be 2. A price adjustment of -15% would be -3.
    Returns: this.
  price(price: int): GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder
    Description: Either this or priceAdjustment is required. The price to place the offer at.
    Returns: this.
  quantity(quantity: int): GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder
    Description: The quantity to place the offer for.
  interruptCondition(interruptCondition: java.util.function.BooleanSupplier): GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder
    Description: Function to break out of placing an offer.
  itemId(itemId: int): GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder
    Description: Either this or itemName is required.
  itemName(itemName: java.lang.String): GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder
    Description: Either this or itemId is required.
  searchText(searchText: java.lang.String): GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder
    Description: The search text to use when selecting the item to buy.
  build(): GrandExchange.CreateOfferConfig
  toString(): java.lang.String
```

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

### Add Pre-Break Start Listener

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/ScriptListening

Adds a listener that will be executed just before a script break officially starts, prior to the break handler's activation. This can be used for conditional logic, such as preventing breaks in combat.

```APIDOC
ScriptListening.addPreBreakStartListener:
  public static void addPreBreakStartListener(PreBreakStartListener listener)
  Description: Adds a listener that will run before a break starts, before the break handler actually triggers. This can be used to prevent breaking while not in combat, for example.
  Parameters:
    listener: PreBreakStartListener - the pre break start listener
```

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

### Iterating GameTab Enum Constants Example

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/GameTab

A Java code example demonstrating how to retrieve and iterate over all constants of the `GameTab` enum using its static `values()` method, typically for printing or processing each constant.

```Java
for (GameTab c : GameTab.values())
    System.out.println(c);
```

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

### RuneAutomation Static Options API

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/Options

Detailed API documentation for static methods used to interact with and modify game options and settings within the RuneAutomation SDK. Each entry specifies the method signature, return type, parameters, and a brief description of its functionality.

```APIDOC
isRunEnabled(): boolean - Determines if the run setting is enabled.
isShiftClickDropEnabled(): boolean - Determines if the shift-click drop setting is enabled.
isShowActivityAdviserEnabled(): boolean - Determine if activity adviser is enabled
isSidePanelsEnabled(): boolean - Determines whether the option to set side panels on is enabled.
isSidePanelsHotkeyOpeningEnabled(): boolean - Determines whether the option to use hot-keys to open side panels is enabled.
isSoundEffectsOn(): boolean - Determines if Sound effect is on or off.
isSpecialAttackTooltipEnabled(): boolean - Determines whether the option to use special attack tool-tips is enabled.
isStatsPanelXpEnabled(): boolean - Determines whether the option to set the stats panel XP til next level is enabled.
isTransparentChatboxEnabled(): boolean - Determines whether the option to set the chat-box transparent is enabled.
isTransparentSidePanelsEnabled(): boolean - Determines whether the option to set side panels as transparent is enabled.
isWorldSwitcherConfirmationEnabled(): boolean - Determine if world switch confirmations are enabled
isXpDropsEnabled(): boolean - Determines whether the option to show XP drops is enabled.
isZoomWithScrollEnabled(): boolean - Determine if zoom with mouse scroll is on or off
openHouseOptionsTab(): boolean - Opens House Options Tab
setAcceptAid(acceptAid: boolean): boolean - (No description provided in source)
setClickThroughChatboxEnabled(enable: boolean): boolean - Sets the option for clicking through the chat-box.
setDataOrbsEnabled(enable: boolean): boolean - Sets the option for showing data-orbs.
setFollowerOptionsLowerDownEnabled(enable: boolean): boolean - Sets the option controlling whether follower (summoning) options are first/last.
setHouseDoorState(houseDoor: Options.HouseDoor): boolean - (No description provided in source)
setHouseTeleportInsideEnabled(enable: boolean): boolean - Set house teleport inside on or off
setMouseCameraEnabled(enable: boolean): boolean - Sets the option for using the middle mouse button to adjust the camera.
setMouseScrollZoomEnabled(enable: boolean): boolean - Sets the option for allowing viewport zooming using the mouse wheel.
setMusicUnlockMessageEnabled(enable: boolean): boolean - Turns music unlock message on or off.
setPrayerTooltipEnabled(enable: boolean): boolean - Sets the option for prayer tool-tips.
setRemoveRoofsEnabled(enable: boolean): boolean - Configures the setting to remove roofs
setResizableModeType(resizableType: Options.ResizableType): boolean - Sets the resizable display type
setRunEnabled(runEnabled: boolean): boolean - Turns run on or off.
setScrollbarPosition(position: Options.ChatboxScrollPosition): boolean - Sets the option for scroll-bar alignment.
setShiftClickDrop(enabled: boolean): boolean - Turns the shift-click drop setting on or off.
setSidePanelsEnabled(enable: boolean): boolean - Sets the option for use of side panels.
setSidePanelsHotkeyOpeningEnabled(enable: boolean): boolean - Sets the option for using hot-keys to open side panels.
```

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

### Get Interacting Character (Character Interface)

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/types/Player

Gets the Character that this character is interacting with (attacking, following, etc). It does NOT return characters that are not in the loaded region, even if this character is interacting with them. This method is specified by the `Character` interface.

```Java
public java.util.Optional<Character> getInteractingCharacter()
```

```APIDOC
Character.getInteractingCharacter()
  Description: Gets the Character that this character is interacting with (attacking, following, etc). Does NOT return characters that are not in the loaded region, even if this character is interacting with them.
  Returns: The character that is being interacted with. Empty optional if this character is not interacting with another.
```

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

### Java ChooseOption Constructor Summary

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/ChooseOption

Summarizes the available constructors for the `ChooseOption` class.

```APIDOC
Constructors:
- ChooseOption()
```

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

### Get Shop Item Count by ID

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/Shop

Gets the total stack sum of all items with the specified ids.

Parameters:
  `id` - the item ids

Returns:
  the total stack sum of all items with the specified ids

```Java
public static int getCount(int... id)
```

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

### BasicPaintTemplate Class API Reference

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/painting/template/basic/BasicPaintTemplate

Detailed API documentation for the `BasicPaintTemplate` class, outlining its structure, nested classes, and methods. It includes method signatures, return types, parameters, and descriptions.

```APIDOC
Class: BasicPaintTemplate
  Package: org.tribot.script.sdk.painting.template.basic
  Extends: java.lang.Object
  Implements: PaintComponent

  Nested Class Summary:
    static class BasicPaintTemplate.BasicPaintTemplateBuilder
      Description: (No description provided in source)

  Method Summary:
    render(java.awt.Graphics g): void
      Description: Paints this paint frame
      Parameters:
        g: java.awt.Graphics - the graphics object
      Specified By: PaintComponent.render(java.awt.Graphics)

    builder(): BasicPaintTemplate.BasicPaintTemplateBuilder
      Description: Returns a builder instance for BasicPaintTemplate. (No explicit description provided in source)

```

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

### API: Get Current Game FPS

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/GameState

Gets the current frames per second (FPS) at which the game is rendering. This value is identical to what would be displayed if the `::displayfps` command were used in-game. The method returns the current FPS as an integer.

```Java
public static int getFps()
```

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

### RuneAutomation SDK Core API Reference

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/allclasses-index

Detailed API documentation for key classes, interfaces, and enums within the RuneAutomation SDK. Each entry provides the full signature and a brief description of its purpose, covering areas such as item querying, keyboard input, local tile data, logging, login management, magic interactions, and make-screen handling.

```APIDOC
interface org.tribot.script.sdk.query.ItemDefinableQuery<EntityType extends ItemDefinable, QueryType extends Query<EntityType, QueryType>>
class org.tribot.script.sdk.types.definitions.ItemDefinition
class org.tribot.script.sdk.query.ItemDefinitionQuery - A query to search over item definitions
interface org.tribot.script.sdk.query.ItemQuery<EntityType extends Item, QueryType extends Query<EntityType, QueryType>>
class org.tribot.script.sdk.input.Keyboard - Utilities related to using the keyboard/typing in-game
class org.tribot.script.sdk.input.Keyboard.HoldAction - Represents a key hold configuration
enum org.tribot.script.sdk.input.Keyboard.HoldAction.Key - Represents a key that can be held.
class org.tribot.script.sdk.input.Keyboard.HoldAction.KeyHoldContext - Represents the context of a current key hold action.
interface org.tribot.script.sdk.interfaces.KeyEventOverrideListener - An interface to override key events from the user
class org.tribot.script.sdk.types.LocalTile - Represents a tile in the current scene
enum org.tribot.script.sdk.types.LocalTile.Collision
enum org.tribot.script.sdk.types.LocalTile.Direction
enum org.tribot.script.sdk.types.LocalTile.SceneSetting
class org.tribot.script.sdk.walking.LocalWalking - Utilities for traversing and inspecting the 'local' area.
class org.tribot.script.sdk.walking.LocalWalking.Map - Represents a mapped area from some source position.
class org.tribot.script.sdk.walking.LocalWalking.Map.MapBuilder
class org.tribot.script.sdk.Log - Contains methods for logging
class org.tribot.script.sdk.Login - Utilities for logging in and inspecting current login state
enum org.tribot.script.sdk.Login.LoginMessage - Represents a mesage that can be displayed when trying to log in, such as already logged in
class org.tribot.script.sdk.Magic - Utilities for interacting with the Magic Tab.
enum org.tribot.script.sdk.Magic.SpellBook - A magic spellbook
class org.tribot.script.sdk.MakeScreen - Contains methods regarding the commonly used 'make' interface.
enum org.tribot.script.sdk.MakeScreen.Quantity
enum org.tribot.script.sdk.MakeScreen.SelectPreference
class org.tribot.script.sdk.MessageListening - Contains methods to register listeners to listen to specific message types.
```

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

### Get Available Entity Actions

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/types/EquipmentItem

Retrieves a list of available actions for the entity, typically dependent on its definition. For equipment items, it provides equipment actions. To get general actions, refer to `this#getDefinition()`. This method is specified by both `Actionable` and `Item` interfaces.

```Java
public java.util.List<java.lang.String> getActions()
```

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

### LocalWalking Class API Reference

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/walking/LocalWalking

Comprehensive API documentation for the `LocalWalking` class, detailing its nested classes, constructors, and static methods for navigating and mapping within a 104x104 local area.

```APIDOC
Class LocalWalking:
  Description: Utilities for traversing and inspecting the 'local' area. This is a 104x104 area.
  Extends: java.lang.Object

  Nested Classes:
    LocalWalking.Map:
      Description: Represents a mapped area from some source position.

  Constructors:
    LocalWalking():
      Description: Default constructor for LocalWalking.
      Signature: public LocalWalking()

  Methods:
    createMap():
      Description: Creates a local map with the player position as the source.
      Signature: public static LocalWalking.Map createMap()
      Returns: LocalWalking.Map - a local map

    createMap(source: Positionable):
      Description: Creates a local map with the specified positionable as the source.
      Signature: public static LocalWalking.Map createMap​(Positionable source)
      Parameters:
        source: Positionable - the source of the map - all paths/reachable checks will be performed against this source
      Returns: LocalWalking.Map - a local map around the specified source

    walkTo(target: Positionable):
      Description: Walks to the target location, if it is in the local area.
      Signature: public static boolean walkTo​(Positionable target)
      Parameters:
        target: Positionable - the target tile
      Returns: boolean - true if walked successfully, false otherwise

    walkTo(target: Positionable, walkingCondition: java.util.function.Supplier<WalkState>):
      Description: Walks to the target location, if it is in the local area.
      Signature: public static boolean walkTo​(Positionable target,
                                   java.util.function.Supplier<WalkState> walkingCondition)
      Parameters:
        target: Positionable - the target tile
        walkingCondition: java.util.function.Supplier<WalkState> - the walking condition to break out of walking early - this is checked often while walking
      Returns: boolean - true if walked successfully, false otherwise

    walkPath(path: java.util.List<Positionable>):
      Description: Walks the specified path.
      Signature: public static boolean walkPath​(java.util.List<Positionable> path)
      Parameters:
        path: java.util.List<Positionable> - the path to walk
      Returns: boolean - true if walked successfully, false otherwise

    walkPath(path: java.util.List<Positionable>, walkingCondition: java.util.function.Supplier<WalkState>):
      Description: Walks the specified path.
      Signature: public static boolean walkPath​(java.util.List<Positionable> path,
                                     java.util.function.Supplier<WalkState> walkingCondition)
      Parameters:
        path: java.util.List<Positionable> - the path to walk
        walkingCondition: java.util.function.Supplier<WalkState> - the walking condition to break out of walking early - this is checked often while walking
      Returns: boolean - true if walked successfully, false otherwise
```

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

### org.tribot.script.sdk.script Package Overview

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/script/package-summary

Overview of the `org.tribot.script.sdk.script` Java package, detailing its interfaces, classes, and annotation types with their brief descriptions as found in the Javadoc summary.

```APIDOC
Package: org.tribot.script.sdk.script

Interface Summary:
  - TribotScript: This interface denotes a runnable tribot script.

Class Summary:
  - ScriptConfig: Defines a set of configuration options for a script.
  - ScriptRuntimeInfo: Contains various methods to get script runtime information

Annotation Types Summary:
  - TribotScriptManifest: (No description provided in source)
```

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

### Get Shop Item Count by Predicate Filter

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/Shop

Gets the total stack sum of all items matching the specified filter.

Parameters:
  `filter` - the item filter to use

Returns:
  the total stack sum of all items matching the specified filter

```Java
public static int getCount(java.util.function.Predicate<Item> filter)
```

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

### EnterInputScreen Class API Reference

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/EnterInputScreen

Detailed API reference for the `org.tribot.script.sdk.EnterInputScreen` class, including its constructor and all static methods for interacting with the 'enter input' screen. This class is part of the TRiBot SDK.

```APIDOC
org.tribot.script.sdk.EnterInputScreen:
  description: Contains methods for inspecting and interacting with the commonly used 'enter input' screen that appears over the chatbox
  extends: java.lang.Object

  Constructors:
    EnterInputScreen():
      description: Default constructor for EnterInputScreen.

  Methods:
    getType():
      signature: static java.util.Optional<java.lang.Integer> getType()
      description: The input type (ex. 14 is grand exchange)
      returns: enter input type
    getPromptMessage():
      signature: static java.lang.String getPromptMessage()
      description: Gets the enter amount screen prompt message. Ex. "Enter amount:"
      returns: the enter amount screen prompt message, or an empty string if not open
    getCurrentInput():
      signature: static java.lang.String getCurrentInput()
      description: Gets the currently entered input
      returns: the currently entered input
    isOpen():
      signature: static boolean isOpen()
      description: Checks if the enter input screen is open
      returns: true if the enter input screen is open, false otherwise
    enter(quantity: int):
      signature: static boolean enter(int quantity)
      description: Enters the specified number into the enter input screen, and presses enter
      parameters:
        quantity: the quantity to enter
      returns: true if entered successfully, false otherwise
    enter(input: java.lang.String):
      signature: static boolean enter(java.lang.String input)
      description: Enters the specified input into the enter input screen, and presses enter
      parameters:
        input: the input to enter
      returns: true if entered successfully, false otherwise
```

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

### Get Shop Item Count by Name

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/Shop

Gets the total stack sum of all items whose name contains any of the specified names.

Parameters:
  `name` - the item names

Returns:
  the total stack sum of all items whose name contains any of the specified names

```Java
public static int getCount(java.lang.String... name)
```

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

### org.tribot.script.sdk Package API Reference

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/package-summary

Detailed API documentation for the `org.tribot.script.sdk` package, listing available interfaces and classes with their respective purposes and functionalities.

```APIDOC
Package: org.tribot.script.sdk

Interfaces:
  Hiscores.CategoryRanking

Classes:
  Bank
    Description: Utilities for interacting with the Runescape bank.
  BankEquipment
    Description: Contains methods related to the equipment screen available when at a bank
  BankPinScreen
    Description: Utilities for interacting with the Bank Pin screen.
  BankSettings
    Description: Utilities for interacting with the bank settings
  Camera
    Description: Utilities for controlling the camera in game.
  Chatbox
    Description: Contains methods for inspecting and interacting with the chatbox screen (the box that contains chat messages from players for example)
  ChatScreen
    Description: Contains methods for inspecting and interacting with the dialog screen that appears over the chatbox, such as when talking to an NPC
  ChatScreen.Config
    Description: The config for the chat handler.
  ChatScreen.Config.ConfigBuilder
  ChooseOption
    Description: Utilities for using the "ChooseOption" interface, which is the box of options that appears when right-clicking things in the game.
  Combat
    Description: Contains utility methods for interacting with the combat tab and obtaining other combat related information
  EnterInputScreen
    Description: Contains methods for inspecting and interacting with the commonly used 'enter input' screen that appears over the chatbox
  Equipment
    Description: Utilities for interacting with the equipment tab
  GameListening
    Description: Contains listeners for game events.
  GameState
    Description: Utilities for inspecting the client game state
  GrandExchange
    Description: Contains utility methods for inspecting and interacting with the grand exchange
  GrandExchange.CreateOfferConfig
    Description: Describes a configuration for a new grand exchange offer. Each of the following config requirements must be met: A type must be specified. A price adjustment or a price must be specified. A quantity must be specified. An item name or an item id must be specified. Custom search text (only used for buying) is completely optional.
  GrandExchange.CreateOfferConfig.CreateOfferConfigBuilder
  Hiscores
    Description: Utility for grabbing data from the game highscores
  Hiscores.ActivityRanking
  Hiscores.Player
  Hiscores.SkillRanking
  Interaction
    Description: Utilities for easily interacting with game entities
  Inventory
    Description: Utilities for interacting with and inspecting the inventory
  Log
    Description: Contains methods for logging
  Login
    Description: Utilities for logging in and inspecting current login state
  Magic
    Description: Utilities for interacting with the Magic Tab.
  MakeScreen
    Description: Contains methods regarding the commonly used 'make' interface.
  MessageListening
    Description: Contains methods to register listeners to listen to specific message types.
  MyPlayer
    Description: Static convenience methods for the local player.
  Options
    Description: Utilities for getting information related to what's in the Options Tab and Minimap HUD.
  Region
  Screenshot
    Description: Utility methods for taking screenshots of the game
```

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

### API: Get Game Uptext String

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/GameState

Gets the game's 'uptext' string, which typically appears in the top left corner of the screen. This text often conveys important game messages or status updates. The method returns the uptext string, or an empty string if no uptext is currently displayed.

```Java
public static java.lang.String getUpText()
```

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

### Example Usage of PlayerPreferences.preference Method in Java

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/antiban/PlayerPreferences

This Java code snippet demonstrates how to use the `PlayerPreferences.preference` method to generate and retrieve a unique, account-specific preference. It shows an example of setting an 'eatPercent' value uniformly distributed between 30 and 60, highlighting how the value remains consistent for the same account across different script runs.

```Java
PlayerPreferences.preference("org.tribot.Antiban.eatPercent", g -> g.uniform(30, 60))
```

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

### org.tribot.script.sdk.walking Package API Summary

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/walking/package-summary

Comprehensive overview of classes and enums within the `org.tribot.script.sdk.walking` package, detailing their purpose for in-game navigation and map manipulation.

```APIDOC
Package: org.tribot.script.sdk.walking

Classes:
  GlobalWalking:
    Description: Utilities for walking across the entire game
  LocalWalking:
    Description: Utilities for traversing and inspecting the 'local' area.
  LocalWalking.Map:
    Description: Represents a mapped area from some source position.
  LocalWalking.Map.MapBuilder:
    Description: Builder class for LocalWalking.Map.

Enums:
  WalkState:
    Description: Represents a walk state to be used as a walking condition.
```

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

### Get Entity Definition

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/types/GameObject

Retrieves the `ObjectDefinition` associated with the entity.

```Java
public ObjectDefinition getDefinition()
```

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

### APIDOC: Method Summary for LocalWalking.Map

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/walking/LocalWalking.Map

Provides an overview of all methods available in the `LocalWalking.Map` class, including their return types, names, and brief descriptions of their functionality.

```APIDOC
Methods:
  - builder(): LocalWalking.Map.MapBuilder (static)
  - canReach(Positionable position): boolean
    Description: Checks if the specified position is reachable from the source position
  - getDistance(Positionable position): int
    Description: Gets the path distance to the specified position
  - getPath(Positionable position): java.util.List<Positionable>
    Description: Generates a path to the position.
```

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

### APIDOC: TRiBot SDK AutomationClient Class Reference

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/util/AutomationClient

Comprehensive API documentation for the `org.tribot.script.sdk.util.AutomationClient` class, outlining its structure, constructors, and static methods for interacting with and extending the TRiBot automation client's functionality, including message sending, request handling, and custom listener/handler setup.

```APIDOC
Class: AutomationClient
  Extends: java.lang.Object
  Description: Utilities for interacting with and extending the functionality of the TRiBot automation client.

  Nested Classes:
    AutomationClient.AutomationException

  Constructors:
    AutomationClient():
      Description: Default constructor for AutomationClient.

  Methods:
    static void sendMessage(java.lang.String message):
      Description: Sends a message to the server. This triggers an onEvent method to be called, with the type `custom`, and the body is the message.
      Parameters:
        message: java.lang.String - the message to send to the server

    static <T> T sendRequest(java.lang.String request, java.lang.Class<T> returnType):
      Description: Sends a request to the server and waits for a response.
      Type Parameters:
        T: the return type
      Parameters:
        request: java.lang.String - the request body (can include the type, params, whatever you want. the server will parse it)
        returnType: java.lang.Class<T> - the return type of the json sent back by the server
      Returns: T - the json response from the server, converted to a java class
      Throws:
        AutomationClient.AutomationException: if there was an issue getting a response from the server

    static void setMessageListener(java.util.function.Consumer<java.lang.String> listener):
      Description: Sets a custom message listener. This will be triggered when the server calls `sendScriptMessage` with the message.
      Parameters:
        listener: java.util.function.Consumer<java.lang.String> - the listener to accept all server messages via `sendScriptMessage`

    static void setRequestHandler(java.util.function.Function<java.lang.String, java.lang.Object> requestHandler):
      Description: Sets a custom request handler. This will be triggered when the server calls `sendScriptRequest` with the request. The request handler should return an object that will be serialized to json. The json will then be sent to the server as a response.
      Parameters:
        requestHandler: java.util.function.Function<java.lang.String, java.lang.Object> - the requestHandler to handle server requests send via `sendScriptRequest`
```

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

### Skill.getXpPercentToNextLevel Method

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/Skill

Gets the percentage until the next level.

```APIDOC
Skill:
  getXpPercentToNextLevel(): int
    Returns: the percent until the next level
```

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

### Skill.getXp Method

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/Skill

Gets the current experience gained in this skill.

```APIDOC
Skill:
  getXp(): int
    Returns: the current exp
```

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

### org.tribot.script.sdk.painting.template.basic Package API Reference

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/painting/template/basic/package-summary

This section provides a structured reference to the interfaces, classes, and enums defined within the org.tribot.script.sdk.painting.template.basic Java package, including their brief descriptions and types.

```APIDOC
Package: org.tribot.script.sdk.painting.template.basic

Interface Summary:
  - PaintRow (interface):
      Description: Describes a paint row that can exist in a paint frame.

Class Summary:
  - BasicPaintTemplate (class)
  - BasicPaintTemplate.BasicPaintTemplateBuilder (class)
  - PaintRows (class)
  - PaintTextRow (class)
  - PaintTextRow.PaintTextRowBuilder (class)

Enum Summary:
  - PaintLocation (enum):
      Description: Contains preset paint locations for BasicPaintTemplate
```

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

### Get All Entity Tiles

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/types/GameObject

Retrieves a list of all `WorldTile` objects associated with the entity.

```Java
public java.util.List<WorldTile> getAllTiles()
```

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

### APIDOC: Tile Interface Method Summary and Details

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/interfaces/Tile

Comprehensive API documentation for the `Tile` interface, detailing all its methods, their return types, parameters, and a brief description of their functionality. This includes methods for position retrieval, minimap interaction, and coordinate translation, along with inherited methods.

```APIDOC
Tile Interface:
  Description: Represents a position in the game. Could be relative (LocalTile) or global (WorldTile).
  Superinterfaces:
    - Clickable
    - Interactable
    - Positionable
  Known Implementing Classes:
    - LocalTile
    - WorldTile
  Methods:
    - clickOnMinimap():
        Description: Clicks the tile on the minimap interface.
        Returns: boolean (True if the click happens. False otherwise.)
    - getBounds():
        Description: Gets the bounds of this tile on the screen
        Returns: java.util.Optional<java.awt.Polygon>
    - getPlane():
        Description: Gets the plane of this tile
        Returns: int (the plane of this tile)
    - getX():
        Description: Gets the x coordinate of this tile
        Returns: int (the x coordinate)
    - getY():
        Description: Gets the y coordinate of this tile
        Returns: int (the y coordinate)
    - hasLineOfSightTo(other: Positionable):
        Description: Unmaintained.
        Parameters:
          - other: Positionable
        Returns: boolean
    - hoverOnMinimap():
        Description: Attempts to hover the tile on the minimap
        Returns: boolean (true if the tile was hovered, false otherwise)
    - isHovering():
        Description: Checks if the mouse is currently over this entity
        Returns: boolean
    - isInLineOfSight():
        Description: Unmaintained.
        Returns: boolean
    - isOnMinimap():
        Description: Determines if this tile is visible on the minimap interface.
        Returns: boolean (True if the tile is on the minimap. False otherwise.)
    - isRendered():
        Description: Checks if this tile is currently being rendered (a tile is not rendered if it's covered by the 'black fog')
        Returns: boolean
    - leftClickOnScreen():
        Description: Attempts to left-click this tile on the screen.
        Returns: boolean
    - translate(x: int, y: int):
        Description: Translates (shifts) this tile by the specified x and y
        Parameters:
          - x: int (the x translation)
          - y: int (the y translation)
        Returns: Tile
    - translate(x: int, y: int, z: int):
        Description: Translates (shifts) this tile by the specified x, y, and z
        Parameters:
          - x: int
          - y: int
          - z: int
        Returns: Tile
  Inherited Methods:
    From Clickable:
      - click()
      - click(java.lang.String)
      - hover()
      - hover(java.lang.String)
      - hoverMenu(java.lang.String)
      - isVisible()
    From Interactable:
      - interact(java.lang.String)
      - interact(java.lang.String,java.util.function.BooleanSupplier)
    From Positionable:
      - adjustCameraTo()
      - distance()
      - distanceTo(org.tribot.script.sdk.interfaces.Positionable)
      - getTile()
```

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

### Get Username Property

Source: https://runeautomation.com/docs/sdk/javadocs/overview-summary.html/sdk/javadocs/org/tribot/script/sdk/antiban/AntibanProperties.Props

Retrieves the username string configured for the anti-ban properties.

```Java
public java.lang.String getUsername()
```