Module net.botwithus.rs3
Package net.botwithus.rs3.game.inventories

Class Bank

java.lang.Object
net.botwithus.rs3.game.inventories.Bank
public class Bank extends Object

  • Method Details

    • isOpen

      public static boolean isOpen()
      Determines if the bank interface is open.
      Returns:
      True if the bank interface is open, false otherwise.

    • isInputOpen

      public static boolean isInputOpen()
      Determines if the bank's withdraw X input interface is open.
      Returns:
      True if the withdrawal X input interface is open, false otherwise.

    • depositAll

      public static boolean depositAll()
      Deposits all items in the player's inventory.
      Returns:
      True if the deposit was successful, false otherwise.

    • depositEquipment

      public static boolean depositEquipment()
      Deposits all items in the player's equipment.
      Returns:
      True if the deposit was successful, false otherwise.

    • depositFamiliar

      public static boolean depositFamiliar()
      Deposits all items in the player's familiar.
      Returns:
      True if the deposit was successful, false otherwise.

    • depositCoins

      public static boolean depositCoins()
      Deposits all coins in the player's inventory.
      Returns:
      True if the deposit was successful, false otherwise.

    • depositEverything

      public static boolean depositEverything()
      Deposits all items in the player's inventory, equipment, familiar, and coins.
      Returns:
      True if the deposit was successful, false otherwise.

    • deposit

      public static boolean deposit(int itemId, Bank.TransferAmount amount)
      Deposits a specific amount of an item into the bank.
      Parameters:
      itemId - The item id to deposit.
      amount - The amount to deposit.
      Returns:
      True if the deposit was successful, false otherwise.

    • deposit

      public static boolean deposit(String name, Bank.TransferAmount amount)
      Deposits a specific amount of an item into the bank.
      Parameters:
      name - The item name to deposit.
      amount - The amount to deposit.
      Returns:
      True if the deposit was successful, false otherwise.

    • deposit

      public static boolean deposit(Pattern pattern, Bank.TransferAmount amount)
      Deposits a specific amount of an item into the bank.
      Parameters:
      pattern - The item pattern to deposit.
      amount - The amount to deposit.
      Returns:
      True if the deposit was successful, false otherwise.

    • startDepositX

      public static boolean startDepositX(int id)
      Starts the process of depositing a specific amount of an item into the bank.
      Parameters:
      id - The item id to deposit.
      Returns:
      True if the deposit was started, false otherwise.

    • startDepositX

      public static boolean startDepositX(String name)
      Starts the process of depositing a specific amount of an item into the bank.
      Parameters:
      name - The item name to deposit.
      Returns:
      True if the deposit was started, false otherwise.

    • startDepositX

      public static boolean startDepositX(Pattern pattern)
      Starts the process of depositing a specific amount of an item into the bank.
      Parameters:
      pattern - The item pattern to deposit.
      Returns:
      True if the deposit was started, false otherwise.

    • finishDepositX

      public static boolean finishDepositX(int amount)
      Finishes the process of depositing a specific amount of an item into the bank.
      Parameters:
      amount - The amount to deposit.
      Returns:
      True if the deposit was successful, false otherwise.

    • withdrawAll

      public static boolean withdrawAll(int id)
      Withdraws all items from the bank.
      Parameters:
      id - The item id to withdraw.
      Returns:
      True if the withdrawal was successful, false otherwise.

    • withdraw

      public static boolean withdraw(String name, Bank.TransferAmount amount)
      Withdraws Bank.TransferAmount items from the bank.
      Parameters:
      name - The item name to withdraw.
      amount - The amount to withdraw.
      Returns:
      True if the withdrawal was successful, false otherwise.

    • withdraw

      public static boolean withdraw(Pattern pattern, Bank.TransferAmount amount)
      Withdraws Bank.TransferAmount items from the bank.
      Parameters:
      pattern - The item pattern to withdraw.
      amount - The amount to withdraw.
      Returns:
      True if the withdrawal was successful, false otherwise.

    • withdraw

      public static boolean withdraw(int id, Bank.TransferAmount mode)
      Withdraws a specific amount of an item from the bank.
      Parameters:
      id - The item id to withdraw.
      mode - The amount to withdraw.
      Returns:
      True if the withdrawal was successful, false otherwise.

    • startWithdrawX

      public static boolean startWithdrawX(int id)
      Starts the process of withdrawing a specific amount of an item from the bank.
      Parameters:
      id - The item id to withdraw.
      Returns:
      True if the withdrawal was started, false otherwise.

    • startWithdrawX

      public static boolean startWithdrawX(String name)
      Starts the process of withdrawing a specific amount of an item from the bank.
      Parameters:
      name - The item name to withdraw.
      Returns:
      True if the withdrawal was started, false otherwise.

    • startWithdrawX

      public static boolean startWithdrawX(Pattern pattern)
      Starts the process of withdrawing a specific amount of an item from the bank.
      Parameters:
      pattern - The item pattern to withdraw.
      Returns:
      True if the withdrawal was started, false otherwise.

    • finishWithdrawX

      public static boolean finishWithdrawX(int amount)
      Finishes the process of withdrawing a specific amount of an item from the bank.
      Parameters:
      amount - The amount to withdraw.
      Returns:
      True if the withdrawal was successful, false otherwise.

    • withdrawPreset

      public static boolean withdrawPreset(int presetNumber)
      Withdraws a preset from the bank. Warning: This method is blocking and will wait until the preset is withdrawn.
      Parameters:
      presetNumber - The preset number to withdraw.
      Returns:
      True if the preset was withdrawn, false otherwise.

    • transferMode

      public static Bank.TransferAmount transferMode()

    • startCustomAmount

      public static boolean startCustomAmount()
      Starts the process of setting the custom amount to withdraw.
      Returns:
      True if the custom amount interface was opened, false otherwise.

    • finishCustomAmount

      public static boolean finishCustomAmount(int amount)
      Finishes the process of setting the custom amount to withdraw.
      Parameters:
      amount - The amount to withdraw.
      Returns:
      True if the custom amount was set, false otherwise.

    • enterCustomAmount

      public static boolean enterCustomAmount(int amount)
      Enters a custom amount into the bank interface. Warning: This method is blocking and will wait until the custom amount interface is open.
      Parameters:
      amount - The amount to enter.
      Returns:
      True if the amount was entered, false otherwise.

    • isEditingCustomAmount

      public static boolean isEditingCustomAmount()
      Determines if the player is currently editing a custom amount.
      Returns:
      True if the player is editing a custom amount, false otherwise.

    • setTransferMode

      public static boolean setTransferMode(Bank.TransferAmount mode)
      Sets the transfer mode for the bank interface.
      Parameters:
      mode - The transfer mode to set.
      Returns:
      True if the transfer mode was set, false otherwise.

    • getWithdrawAmount

      public static int getWithdrawAmount()
      Sets the custom amount value for the bank interface.
      Returns:
      True if the custom amount value was set, false otherwise.

    • getPresetPage

      public static int getPresetPage()

    • view

      public static Bank.SideView view()

    • withdrawMode

      public static Bank.WithdrawMode withdrawMode()

    • setting

      public static Bank.BankSetting setting()