Inubot

https://docs.inubot.com/docs
Admin
Inubot is a platform that provides a launcher, client, and SDK for developing automation scripts,...
Tokens:7,992
Snippets:100
Trust Score:5.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### Perform action on query results in one line

Source: https://docs.inubot.com/docs/Development/queries-and-results

Performs an action on a specific item found by a query. This example uses `nameContains` to find an item and `forEach` to interact with it.

```Inventories
Inventories.backpack().query().nameContains("seed pod").results().limit(1).forEach(x -> x.interact("Commune"));
```

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

### Subscribe to Chat Message Event

Source: https://docs.inubot.com/docs/Development/events-overview

Listen for specific chat messages to trigger actions. This example stops the script if the player has insufficient coins for an offer.

```java
@Subscribe  

public void onChatMessage(ChatMessageEvent event) {  

  String message = event.getContents().toLowerCase();  

  if (event.getType() == ChatMessageEvent.Type.GAME  
    && message.contains("that offer costs")  
    && message.contains("you haven't got enough")) {  

    Log.warn("Low on coins, stopping script");  

    stopScript = true;  

  }  

}
```

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

### Configure RestockTask Retry Strategy

Source: https://docs.inubot.com/docs/Development/loadouts

This example shows how to customize the retry strategy for the RestockTask. It includes logic to avoid retrying sell orders for items priced at 1 and to implement a time-based retry with a price limit for buy/sell orders.

```java
@Override  

public void initialize() {  

  RestockTask restocker = injector.getInstance(RestockTask.class);  

  restocker.setRetryStrategy(new RestockTask.RetryStrategy() {  

    @Override  

    public boolean isWarranted(StockMarketEntry entry, int ticksPassed) {  

      int price = entry.getItemPrice();  

      if (entry.getType() == StockMarketable.Type.SELL && price == 1) {  

        //can't go any lower  

        return false;  

      }
        

      //check if 30 ticks have passed and the only retry if the price isn't much much higher than live price  

      return ticksPassed >= 30 && price <= PriceCheck.lookup(entry.getItemId()).getHigh() * 1.5;  

    }

    @Override  

    public int getPrice(StockMarketEntry entry) {  

      if (entry.getType() == StockMarketable.Type.SELL) {  

        //for sell items go 10% lower than previous price every attempt  

        return (int) (entry.getItemPrice() * 0.9);  

      }

      //buy items go 10% higher than last price every attempt  

      return (int) (entry.getItemPrice() * 1.1);  

    }

  });

}
```

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

### Verify Fire Location

Source: https://docs.inubot.com/docs/Development/cooker-1

Logs a warning and returns false if the specified cooking fire is not found, guiding the user to start in the correct location (Rogues' Den).

```Java
if (fire == null) { 
  Log.warn("Make sure you start the script in Rogues den!"); 
  return false; 
}
```

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

### Get Varp Value

Source: https://docs.inubot.com/docs/Development/vars

Retrieves the value of a server-sided Varp. Use this to check player or game states like prayer toggles or quest progress.

```Java
Vars.get(varId)
```

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

### Conditional Sleep Until Animation

Source: https://docs.inubot.com/docs/Development/sleeps

Sleep until the player starts animating or a timeout occurs. This is useful for waiting for an action to begin after an interaction.

```Java
tree.interact("Chop-down");

sleepUntil(() -> Players.self().isAnimating(), 5);

return true;
```

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

### Get Varbit Value

Source: https://docs.inubot.com/docs/Development/vars

Retrieves the value of a Varbit, which represents a specific portion of a Varp. Useful for tracking binary states or small-range values within a Varp.

```Java
Vars.get(Vars.Type.VARBIT, varbitId)
```

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

### Use Constants for Magic Numbers

Source: https://docs.inubot.com/docs/Development/guidelines-and-caveats

Define constants for magic numbers like IDs or coordinates to improve code readability and maintainability. This example shows defining constants for an item ID and a position.

```Java
private static final int COINS_ITEM_ID = 995;

private static final Position GRAND_EXCHANGE = Position.from(3164, 3487);
```

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

### Client Launch Arguments (YAML)

Source: https://docs.inubot.com/docs/using-quickstart

This snippet shows a comprehensive list of arguments you can use to configure the client launch. Not all arguments are necessary; define only those you intend to use. Separate arguments for multi-launch with '---'.

```yaml
username: "username" # The username of your account (legacy logins)

password: "password" # The password of your account (legacy logins)

totp_secret: "" # The authenticator secret key if you have one (legacy logins)

pin: "" # The bank pin of your account

world: 316 # The world to launch the client on. -2 indicates random P2P world, -1 indicates F2P

script: "GOTR" # The name of the script to launch

script_args: "" # Any arguments for the script. Most scripts will log their args when you click start, so you can simply copy those

script_schedule: "" # The name of the script schedule to use, if any

disable_interfaces: false # true to disable rendering of interfaces

low_cpu: true # true to disable rendering of the scene

proxy_ip: "1.2.3.4" # The proxy IP to use, if using one

proxy_port: 69 # The proxy port to use, if using one

proxy_username: "" # The username of the proxy you're using

proxy_password: "" # The password of the proxy you're using

proxy_http: false # true if using a HTTP proxy

inubot_username: "" # Your inubot username

inubot_password: "" # Your inubot password

fps: 50 # The FPS to limit the game to

experimental: 0 # An experimental mode, if using one

mouse_mode: 0 # The mouse mode to use, if using an alternative one

break: "" # Name of break profile you want to use, if any

house: "" # Name of house profile you want to use, if any

save_account: false # true to automatically save the account to the account manager (legacy logins)

exit_on_error: false # true to close the client automatically if it fails to load the game

exit_on_ban: false # true to close the client automatically upon receiving a ban

start_script_early: false # true to start the script before the game fully finishes loading

minimized: false # true to minimize the client on load

window_width: 0 # A custom width for the bot window

window_height: 0 # A custom height for the bot window

delay: 5 # The delay in seconds before launching this client

jx_character: "" # Explained on Using Jagex Accounts page

jx_session: "" # Explained on Using Jagex Accounts page
```

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

### Handle Make-X Interface and Cooking

Source: https://docs.inubot.com/docs/Development/cooker-1

Manages the Make-X interface for cooking. If open, it initiates cooking; otherwise, it uses a raw fish on the fire to open it.

```Java
Production production = Production.getActive(); 
if (production != null && production.isOpen()) { 
  production.initiate(0); 
} else { 
  inv.use(iq -> iq.names("Raw shrimps").results().first(), fire); 
} 
  
return true;
```

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

### Programmatically Build and Withdraw a Loadout

Source: https://docs.inubot.com/docs/Development/loadouts

This snippet demonstrates how to programmatically define a loadout with specific items, quantities, and restocking metadata. It also shows how to set an out-of-item listener to handle restocking logic and then withdraw the items.

```java
BackpackLoadout loadout = new BackpackLoadout("firemaking");  

loadout.add(new ItemEntryBuilder()  

        .key("Tinderbox")  

        .stackable(false)  

        .quantity(1)  

        .restockMeta(new RestockMeta(1, 5000))  

        .build()  

);

loadout.add(new ItemEntryBuilder()  

        .key(log.getName())  

        .stackable(false)  

        .quantity(27)  

        .restockMeta(new RestockMeta(restockAmount, restockPrice))  

        .build()  

);
  

loadout.setOutOfItemListener(entry -> {  

  if (entry.contained(Inventories.backpack())) {  

    //the out of item listener is called when an item runs out in the bank  

    //in this example lets continue as long as it's in our inventory  

    return;  

  }
    

  if (entry.getRestockMeta() == null) {  

    return;  

  }
    

  stockMarketService.submit(StockMarketable.Type.BUY, entry);

});
  

loadout.withdraw();
```

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

### Walk to a specific position

Source: https://docs.inubot.com/docs/Development/web

Use the walkTo method to navigate to a target position. The system automatically calculates the optimal path.

```javascript
Movement.walkTo(new Position(6945, 6987));
```

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

### Simple Task Implementation

Source: https://docs.inubot.com/docs/Development/how-a-script-works

A basic Task implementation for TaskScript. It requires a TaskDescriptor and an execute method. The execute method should return true if the task was successfully performed.

```java
@TaskDescriptor(name = "Task 1")  

public class MyTask1 extends Task {  

    

  @Override  

  public boolean execute() {  

    return true;  

  }  

}  
```

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

### Creating a Custom Extension Panel

Source: https://docs.inubot.com/docs/Development/script-uis

Extends ExtensionPanel to create a custom UI panel for the script. The constructor is where the panel's Swing UI code should be implemented.

```java
@Singleton
public class MyPanel extends ExtensionPanel {

  public MyPanel() {
    //your ui code here
  }

}
```

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

### Configure Wilderness Pathing

Source: https://docs.inubot.com/docs/Development/web

Control whether the Web Walking system can navigate through the Wilderness. By default, pathing through the Wilderness is disabled.

```javascript
// Enable or disable pathing through the Wilderness  

Web.enableWilderness();  // Allows paths through the Wilderness  

Web.disableWilderness(); // Prevents paths through the Wilderness (default)  
```

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

### Iterate over query results

Source: https://docs.inubot.com/docs/Development/queries-and-results

Demonstrates iterating over the results of a query, which are treated as a collection. This is a standard way to process multiple items returned by a query.

```Item
for (Item item : inv.query().names(...).results()) {
  // ...
}
```

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

### Check for Raw Fish in Inventory

Source: https://docs.inubot.com/docs/Development/cooker-1

Ensures raw fish are present in the backpack before proceeding with cooking. If not found, the task is skipped.

```Java
Backpack inv = Inventories.backpack(); 

if (!inv.contains(iq -> iq.names("Raw shrimps").results())) { 

  return false; 

}
```

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

### Guard Clauses for Early Exits (Nested Ifs)

Source: https://docs.inubot.com/docs/Development/guidelines-and-caveats

Demonstrates a nested if-statement structure for a power-chopping task. This approach can lead to complex and hard-to-follow code with deep nesting levels.

```Java
@Override
public boolean execute() {
  Player self = Players.self();
  if (self != null) {
    Inventory inv = Inventories.backpack();
    if (inv.isFull()) {
      inv.interact(iq -> iq.nameContains("logs").results(), "Drop");
      return true;
    }

    if (!self.isAnimating() && !self.isMoving()) {
      SceneObject tree = SceneObjects.query().names("Tree").actions("Chop-down").results().nearest();
      if (tree != null) {
        tree.interact("Chop-down");
      } else {
        Movement.walkTo(NEAR_TREE_POSITION);
      }
      return true;
    }
  }
  return false;
}
```

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

### Configure RestockTask Collection Strategy

Source: https://docs.inubot.com/docs/Development/loadouts

This snippet illustrates how to define a custom collection strategy for the RestockTask. It includes specific logic for collecting 'Old school bond' items to inventory if space is available and handling sell offers based on item stackability and inventory status.

```java
restocker.setCollectionStrategy(transaction -> {  

  Item item = transaction.getItem();  

  Inventory inv = Inventories.backpack();  

  if (item != null && item.getName().contains("Old school bond") && !inv.isFull()) {  

    //if membership runs out, bank space is reduced to attempt to collect to inventory  

    return StockMarketTransaction.CollectionAction.ITEM;  

  }

  //because the restocktask just disregards the retry attempt when retrying a sell offer  

  //if the item is no longer in the inventory  

  if (transaction.getType() == StockMarketable.Type.SELL && !inv.isFull()) {  

    if (item != null && item.isStackable()) {  

      return StockMarketTransaction.CollectionAction.ITEM;  

    }

    return StockMarketTransaction.CollectionAction.NOTE;  

  }

  //by default collect to the bank  

  return StockMarketTransaction.CollectionAction.BANK;

});
```

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

### Querying an Interface Component by Action

Source: https://docs.inubot.com/docs/Development/interfaces

Query for a component within a specific interface by its associated action text. This method is less prone to breaking due to index changes. Null check the result.

```csharp
InterfaceComponent component=  
    Interfaces.query(475)  
    .actions("Enter Wilderness")  
    .results()  
    .first();  
```

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

### Bank Interaction with Sleep

Source: https://docs.inubot.com/docs/Development/sleeps

Demonstrates proper sleep usage when interacting with game elements like banks in a tick-based system. Avoids spamming actions by waiting for conditions to be met.

```Java
if (self.isMoving()) {
  return false;
}

if (!Bank.isOpen()) {
  Bank.open();
  sleepUntil(Bank::isOpen, ...);
  return true;
}
```

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

### Deposit and Withdraw Food/Raw Fish

Source: https://docs.inubot.com/docs/Development/cooker-1

Deposits all cooked food except raw fish, then withdraws raw fish for the next cooking cycle. Assumes the bank is open.

```Java
Bank bank = Inventories.bank(); 
bank.depositAllExcept(iq -> iq.names("Raw shrimps").results()); 
bank.withdrawAll(iq -> iq.names("Raw shrimps").results().first()); 
return true;
```

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

### Configuring Tithe Farm Script UI

Source: https://docs.inubot.com/docs/Development/script-uis

Extends ConfigModel to define UI components and sections for a Tithe Farm script. Uses annotations to specify component types, names, keys, and input requirements.

```java
@Singleton

public class TitheFarmConfig extends ConfigModel {

  @SelectorComponent(name = "Strategy", key = "strategy", type = Strategy.class)
  public Strategy strategy = Strategy.STRATEGY_BASIC;

  @TextFieldComponent(name = "Seeds to withdraw", key = "withdraw_seed", placeholder = "1000",
      inputType = TextInputType.NUMERIC, required = false)
  public int withdrawSeedAmount = 1000;

  @Section(value = "Banking")
  public TitheFarmBankingConfig banking;

  @Section(value = "Shopping")
  public TitheFarmShoppingConfig shopping;

  @Singleton
  public static class TitheFarmBankingConfig extends ConfigModel {

    @CheckBoxComponent(name = "Restocking", key = "restocking")
    public boolean restocking = true;

    @CheckBoxComponent(name = "Stamina Potions", key = "stamina_potions")
    public boolean staminaPotions = false;
  }

  @Singleton
  public static class TitheFarmShoppingConfig extends ConfigModel {

    @CheckBoxComponent(name = "Gricoller's can", key = "gricollers_can")
    public boolean buyGricollersCan = false;

    @CheckBoxComponent(name = "Farmer's outfit", key = "farming_outfit")
    public boolean buyFarmingOutfit = false;

    @CheckBoxComponent(name = "Herb box", key = "herb_box")
    public boolean buyHerbBoxes = false;

  }

}
```

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

### Cook Task Definition

Source: https://docs.inubot.com/docs/Development/cooker-1

Defines the 'CookTask' which represents the action of cooking raw fish. The execute method currently returns false, indicating no action is performed yet.

```Java
package cooking.tasks;

import org.rspeer.game.script.Task;
import org.rspeer.game.script.TaskDescriptor;

@TaskDescriptor(name = "Cooking the raw fish")
public class CookTask extends Task {

  @Override
  public boolean execute() {
    return false;
  }

}
```

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

### Basic TaskScript Structure

Source: https://docs.inubot.com/docs/Development/how-a-script-works

Defines the main class for a TaskScript, including metadata, initialization, shutdown hooks, and task declarations. Ensure you have the necessary imports for ScriptMeta, TaskScript, Log, and ArrayUtils.

```java
@ScriptMeta(name = "My Script", developer = "Doga", version = 1.0, desc = "My first script!")  

public class MyScript extends TaskScript {  

  

  @Override  

  public void initialize() {  

    Log.info("Starting script!");  

  }  

  

  @Override  

  public void shutdown() {  

    Log.info("Stopping script!");  

  }  

  

  @Override  

  public Class<? extends Task>[] tasks() {  

    return ArrayUtils.getTypeSafeArray(  

        MyTask1.class  

    );  

  }  

}  
```

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

### Adding and Removing Custom Panels from UI

Source: https://docs.inubot.com/docs/Development/script-uis

Manages the lifecycle of a custom ExtensionPanel by adding it to the ExtensionUI on initialization and removing it on shutdown. Uses an ExtensionButton to represent the panel in the UI.

```java
private ExtensionButton button;

  @Override
  public void initialize() {
    ExtensionPanel panel = injector.getInstance(MyPanel.class);
    button = ExtensionButton.builder()
        .icon(SwingCommons.getScriptImage())
        .tooltip("Script")
        .priority(-1)
        .panel(panel)
        .build();

    ExtensionUI ui = injector.getInstance(ExtensionUI.class);
    ui.addButton(button);
  }

  @Override
  public void shutdown() {
    ExtensionUI ui = injector.getInstance(ExtensionUI.class);
    ui.removeButton(button);
  }

```

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

### Main Cooker Script Structure

Source: https://docs.inubot.com/docs/Development/cooker-1

This is the main script class that extends TaskScript. It defines the script's metadata, initialization, shutdown logic, and the order of tasks to be executed.

```Java
package cooking;

import cooking.tasks.BankTask;
import cooking.tasks.CookTask;
import org.rspeer.commons.ArrayUtils;
import org.rspeer.commons.logging.Log;
import org.rspeer.game.script.Task;
import org.rspeer.game.script.TaskScript;
import org.rspeer.game.script.meta.ScriptMeta;

@ScriptMeta(
    name = "Cooker",
    developer = "Doga",
    version = 0.1,
    desc = "My first ever script. Totally!"
)
public class Cooker extends TaskScript {

  @Override
  public void initialize() {
    Log.info("Hello!");
  }

  @Override
  public void shutdown() {
    Log.info("Goodbye!");
  }

  @Override
  public Class<? extends Task>[] tasks() {
    return ArrayUtils.getTypeSafeArray(
        CookTask.class,
        BankTask.class
    );
  }

}
```

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

### Querying an Interface Component Including Subcomponents

Source: https://docs.inubot.com/docs/Development/interfaces

Query for a component, including its subcomponents, by its associated action text. This is useful when the target component is nested within others. Null check the result.

```csharp
InterfaceComponent component=  
    Interfaces.query(475)  
    .includeSubComponents()  
    .actions("Enter Wilderness")  
    .results()  
    .first();  
```

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

### Query for specific NPCs

Source: https://docs.inubot.com/docs/Development/queries-and-results

Searches for a Zombie NPC with the 'Attack' action, reachable within 3 tiles. This demonstrates chaining multiple query conditions for efficient searching.

```Npcs
Npcs.query()
  .names("Zombie")
  .actions("Attack")
  .within(3)
  .reachable()
  .results()
  .nearest()
```

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

### Defining Loadout Text Fields

Source: https://docs.inubot.com/docs/Development/script-uis

Uses TextFieldComponent to define input fields for equipment loadout names. These fields automatically bind saved loadouts of the specified type.

```java
@TextFieldComponent(name = "Magic loadout", key = "loadout_magic", placeholder = "Magic loadout name")
    private EquipmentLoadout mageLoadout;

    @TextFieldComponent(name = "Melee loadout", key = "loadout_melee", placeholder = "Melee loadout name")
    private EquipmentLoadout meleeLoadout;

    @TextFieldComponent(name = "Ranged loadout", key = "loadout_ranged", placeholder = "Ranged loadout name")
    private EquipmentLoadout rangedLoadout;

```

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

### Bank Task Definition

Source: https://docs.inubot.com/docs/Development/cooker-1

Defines the 'BankTask' for banking cooked fish. Similar to CookTask, the execute method currently returns false, indicating no banking action is performed yet.

```Java
package cooking.tasks;

import org.rspeer.game.script.Task;
import org.rspeer.game.script.TaskDescriptor;

@TaskDescriptor(name = "Banking the cooked fish")
public class BankTask extends Task {

  @Override
  public boolean execute() {
    return false;
  }

}
```

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

### Open Bank

Source: https://docs.inubot.com/docs/Development/cooker-1

Opens the bank if it is not already open. This is a prerequisite for banking operations.

```Java
if (!Bank.isOpen()) { 
  Bank.open(); 
  return true; 
}
```

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

### Accessing a Direct Interface Component

Source: https://docs.inubot.com/docs/Development/interfaces

Use this method to directly access an interface component when its interface and component indexes are known. Always null check the component before use.

```csharp
InterfaceComponent component = Interfaces.getDirect(interfaceIndex, componentIndex);
```

```csharp
InterfaceComponent component = Interfaces.getDirect(interfaceIndex, componentIndex, subComponentIndex);
```

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

### Check Player Animation

Source: https://docs.inubot.com/docs/Development/cooker-1

Prevents attempting to cook if the player is already performing an action (animating). This avoids redundant actions.

```Java
if (Players.self().isAnimating()) { 
  return false; 
}
```

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

### Guard Clauses for Early Exits (Refactored)

Source: https://docs.inubot.com/docs/Development/guidelines-and-caveats

Refactored power-chopping task using guard clauses. This approach simplifies the code by handling edge cases upfront with early returns, improving readability and maintainability.

```Java
@Override
public boolean execute() {
  Player self = Players.self();
  if (self == null) {
    return false;
  }

  Inventory inv = Inventories.backpack();
  if (inv.isFull()) {
    inv.interact(iq -> iq.nameContains("logs").results(), "Drop");
    return true;
  }

  if (self.isAnimating() || self.isMoving()) {
    return false;
  }

  SceneObject tree = SceneObjects.query().names("Tree").actions("Chop-down").results().nearest();
  if (tree != null) {
    tree.interact("Chop-down");
  } else {
    Movement.walkTo(NEAR_TREE_POSITION);
  }

  return true;
}
```

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

### Randomly select from nearest NPCs

Source: https://docs.inubot.com/docs/Development/queries-and-results

Selects a random NPC from the two nearest matching the query criteria. This showcases result manipulation using `sortByDistance`, `limit`, and `random`.

```Npcs
Npcs.query()
  .names("Zombie")
  .actions("Attack")
  .within(3)
  .reachable()
  .results()
  .sortByDistance
  .limit(2)
  .random();
```

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

### Locate Cooking Fire

Source: https://docs.inubot.com/docs/Development/cooker-1

Queries for a specific cooking fire object using its ID. This is crucial for ensuring the correct cooking station is used.

```Java
SceneObject fire = SceneObjects.query() 
    .ids(43475) 
    .results() 
    .nearest();
```

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

### Conditional Sleep for Animation Reset

Source: https://docs.inubot.com/docs/Development/cooker-1

Implements a conditional sleep to handle animation resets between cooking actions. It waits until the player is no longer animating, with a timeout failsafe.

```Java
Player self = Players.self(); 
if (self.isAnimating()) { 
  sleepUntil(() -> !self.isAnimating(), () -> self.isAnimating(), 2); 
  return false; 
}
```
Tokens:
Raw