org.osbot.rs07.api

Class Bank

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.util.ItemContainer

org.osbot.rs07.api.Bank

public class Bank
extends ItemContainer

Represents the API regarding bank functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Bank.BankMode

Field Summary

Fields

Modifier and Type	Field and Description
static int	STORE_1
static int	STORE_10
static int	STORE_5
static int	STORE_ALL
static int	WITHDRAW_1
static int	WITHDRAW_10
static int	WITHDRAW_5
static int	WITHDRAW_ALL
static int	WITHDRAW_ALL_BUT_ONE

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, bot, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
Bank()

Method Summary

Modifier and Type	Method and Description
boolean	close() Closes the Bank interface.
Entity	closest()
boolean	deposit(Filter<Item> filter, int amount_) Deposits the specified item with the specified amount in the bank.
boolean	deposit(int id, int amount) Deposits the specified item with the specified amount in the bank.
boolean	deposit(java.lang.String name, int amount) Deposits the specified item with the specified amount in the bank.
boolean	depositAll() Deposits all items in the inventory in the bank.
boolean	depositAll(boolean checkResults) Deposits all items in the inventory in the bank.
boolean	depositAll(boolean checkResults, Filter<Item>... filters)
boolean	depositAll(boolean checkResults, java.util.List<Item> items)
boolean	depositAll(Filter<Item>... filters) Deposits all the items in the filter in the bank.
boolean	depositAll(int... ids) Deposits all the items in the filter in the bank.
boolean	depositAll(java.util.List<Item> items) Deposits all the items in the filter in the bank.
boolean	depositAll(java.lang.String... names) Deposits all the items in the filter in the bank.
boolean	depositAllExcept(boolean checkResults, Filter<Item>... filters)
boolean	depositAllExcept(Filter<Item>... filters) Deposits all the items in the inventory excluding the items in the filters passed.
boolean	depositAllExcept(int... ids) Deposits all the items in the inventory excluding items with the ids passed.
boolean	depositAllExcept(java.util.List<Item> items) Deposits all the items in the inventory excluding the list of items passed.
boolean	depositAllExcept(java.lang.String... names) Deposits all the items in the inventory excluding items with the names passed.
boolean	depositWornItems() Deposits any worn items.
boolean	enableMode(Bank.BankMode bankMode) Enables the specified BankMode.
java.util.List<Item>	filter(Filter<Item>... filters) Filters the item array with the specified filters.
java.awt.Rectangle	getAbsoluteSlotPosition(int tabSlot, int absoluteSlot) Gets the absolute screen position rectangle for specified slot.
int	getCapacity()
int	getCurrentTab() Gets the current tab open.
Bank.BankMode	getInsertMode()
int	getInterfaceChildId() Gets the interface child id that this item container represents.
int	getInterfaceId() Gets the interface id that this item container represents.
RS2Widget	getItemContainerWidget()
int	getItemCountForTab(int tab)
Item[]	getItems() Gets the array of items stored in this container in order.
Item[]	getItemsInTab(int tab) Gets the item array of the specified tab.
RS2Widget	getSlotWidget(int widgetId)
int	getTabForAbsoluteSlot(int slot)
int	getTabForItem(int id) Gets the tab of a particular item.
int	getTabsAvailable() Sums up how many tabs you have available.
Bank.BankMode	getWithdrawMode()
void	initializeModule()
boolean	isBankModeEnabled(Bank.BankMode bankMode)
boolean	isOpen() Checks if your bank interface is open.
boolean	isSlotVisible(Bot bot, int tabSlot, int absoluteSlot) Deprecated. Use isSlotVisible(int tabSlot, int absoluteSlot) instead
boolean	isSlotVisible(int tabSlot, int absoluteSlot) Returns whether the specified slot is visible or not.
boolean	open() Searches for the best bank, based on type and distance from player.
boolean	openTab(int tab) Opens the selected bank tab.
boolean	scrollToSlot(int tabSlot, int absoluteSlot) Scrolls to the specified slot, using the mouse scroll wheel.
boolean	withdraw(Filter<Item> filter, int amount_) Withdraws the first item returned by the filter with the specified amount.
boolean	withdraw(Filter<Item> filter, int amount_, boolean checkResults) Withdraws the first item returned by the filter with the specified amount.
boolean	withdraw(java.util.HashMap<java.lang.String,java.lang.Integer> items) Withdraws all items in the HashMap.
boolean	withdraw(int id, int amount) Withdraw an item with the specified amount which its name matches the specified id.
boolean	withdraw(java.lang.String name, int amount) Withdraws an item with the specified amount which its name matches the specified name.
boolean	withdrawAll(Filter<Item> filter) Withdraws all of the specified item.
boolean	withdrawAll(int id) Withdraws all of the specified item.
boolean	withdrawAll(java.lang.String name) Withdraws all of the specified item.
boolean	withdrawAllButOne(Filter<Item> filter) Withdraws all but one of the specified item.
boolean	withdrawAllButOne(int id) Withdraws all but one of the specified item.
boolean	withdrawAllButOne(java.lang.String name) Withdraws all but one of the specified item.

Methods inherited from class org.osbot.rs07.api.util.ItemContainer

contains, contains, contains, contains, containsAll, containsAll, getAmount, getAmount, getAmount, getEmptySlots, getItem, getItem, getItem, getItemInSlot, getSlot, getSlot, getSlot, getSlot, getSlot, getSlotForNameThatContains, hover, interact, interact, interact, interact, interactWithNameThatContains, inverseFilter, isEmpty, isFull, onlyContains, onlyContains, onlyContains

Methods inherited from class org.osbot.rs07.script.MethodProvider

exchangeContext, execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STORE_ALL

public static final int STORE_ALL

See Also:

Constant Field Values

STORE_1

public static final int STORE_1

See Also:

Constant Field Values

STORE_5

public static final int STORE_5

See Also:

Constant Field Values

STORE_10

public static final int STORE_10

See Also:

Constant Field Values

WITHDRAW_ALL

public static final int WITHDRAW_ALL

See Also:

Constant Field Values

WITHDRAW_ALL_BUT_ONE

public static final int WITHDRAW_ALL_BUT_ONE

See Also:

Constant Field Values

WITHDRAW_1

public static final int WITHDRAW_1

See Also:

Constant Field Values

WITHDRAW_5

public static final int WITHDRAW_5

See Also:

Constant Field Values

WITHDRAW_10

public static final int WITHDRAW_10

See Also:

Constant Field Values

Constructor Detail

Bank

public Bank()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

isBankModeEnabled

public boolean isBankModeEnabled(Bank.BankMode bankMode)

Returns:

True if the BankMode is enabled

getItemContainerWidget

public RS2Widget getItemContainerWidget()

openTab

public boolean openTab(int tab)

Opens the selected bank tab.

Parameters:

tab - The bank tab id. 0 is for all items, 1-9 are the tabs.

Returns:

True if the tab was opened successfully

getCurrentTab

public int getCurrentTab()

Gets the current tab open.

Returns:

The current tab open.

getTabsAvailable

public int getTabsAvailable()

Sums up how many tabs you have available.

Returns:

The amount of tabs available. The view all tab counts as one.

getItemCountForTab

public int getItemCountForTab(int tab)

getItemsInTab

public Item[] getItemsInTab(int tab)

Gets the item array of the specified tab.

Parameters:

tab - The bank tab id. 0 is for all items, 1-9 are the tabs.

Returns:

The items.

getTabForItem

public int getTabForItem(int id)

Gets the tab of a particular item.

Parameters:

id - The item id to look for.

Returns:

A tab id from 0-9 or -1 if the item was not found.

getTabForAbsoluteSlot

public int getTabForAbsoluteSlot(int slot)

getInsertMode

public Bank.BankMode getInsertMode()

getWithdrawMode

public Bank.BankMode getWithdrawMode()

getCapacity

public int getCapacity()

Overrides:

getCapacity in class ItemContainer

Returns:

The capacity of the item container.

getInterfaceId

public int getInterfaceId()

Description copied from class: ItemContainer

Gets the interface id that this item container represents.

Specified by:

getInterfaceId in class ItemContainer

Returns:

The interface id that this item container represents.

getInterfaceChildId

public int getInterfaceChildId()

Description copied from class: ItemContainer

Gets the interface child id that this item container represents.

Specified by:

getInterfaceChildId in class ItemContainer

Returns:

The interface child id that this item container represents.

getItems

public Item[] getItems()

Gets the array of items stored in this container in order.

Some entries may be null as place-markers.

Specified by:

getItems in class ItemContainer

Returns:

the items.

filter

@SafeVarargs
public final java.util.List<Item> filter(Filter<Item>... filters)

Description copied from class: ItemContainer

Filters the item array with the specified filters.

Overrides:

filter in class ItemContainer

Parameters:

filters - The filters.

Returns:

A list of filtered items.

isOpen

public boolean isOpen()

Checks if your bank interface is open.

Returns:

Whether your bank interface is open.

open

public boolean open()
             throws java.lang.InterruptedException

Searches for the best bank, based on type and distance from player. This method will only interact with RS2Objects.

Returns:

If bank was already open, or opened successfully.

Throws:

java.lang.InterruptedException

closest

public Entity closest()

close

public boolean close()

Closes the Bank interface.

Returns:

True if the close button was found and clicked

enableMode

public boolean enableMode(Bank.BankMode bankMode)

Enables the specified BankMode.

Returns:

True if the bank mode has been set or was already set.

depositAll

public boolean depositAll()

Deposits all items in the inventory in the bank.

Returns:

True if successfully interacted with the deposit inventory button AND the inventory is empty.

depositAll

public boolean depositAll(boolean checkResults)

Deposits all items in the inventory in the bank.

Parameters:

checkResults - Wait to check if items were actually withdrawn.

Returns:

True if successfully interacted with the deposit inventory button. If checkResults is true, it will wait until inventory is empty.

depositAll

public boolean depositAll(int... ids)

Deposits all the items in the filter in the bank.

Parameters:

ids - The ids of the items to be deposited in the bank.

Returns:

True if all items specified do no longer remain in the inventory.

depositAll

public boolean depositAll(java.lang.String... names)

Deposits all the items in the filter in the bank.

Parameters:

names - The ids of the items to be deposited in the bank.

Returns:

True if all items specified do no longer remain in the inventory.

depositAll

public boolean depositAll(java.util.List<Item> items)

Deposits all the items in the filter in the bank.

Parameters:

items - The ids of the items to be deposited in the bank.

Returns:

True if all items specified do no longer remain in the inventory.

depositAll

public boolean depositAll(boolean checkResults,
                          java.util.List<Item> items)

depositAll

@SafeVarargs
public final boolean depositAll(Filter<Item>... filters)

Deposits all the items in the filter in the bank.

Parameters:

filters - The filter.

Returns:

True if all items specified do no longer remain in the inventory.

depositAll

@SafeVarargs
public final boolean depositAll(boolean checkResults,
                                              Filter<Item>... filters)

depositAllExcept

public boolean depositAllExcept(int... ids)

Deposits all the items in the inventory excluding items with the ids passed.

Parameters:

ids - Item ids to ignore when depositing.

Returns:

True if the items were deposited successfully.

depositAllExcept

public boolean depositAllExcept(java.lang.String... names)

Deposits all the items in the inventory excluding items with the names passed.

Parameters:

names - Item names to ignore when depositing.

Returns:

True if the items were deposited successfully.

depositAllExcept

public boolean depositAllExcept(java.util.List<Item> items)

Deposits all the items in the inventory excluding the list of items passed.

Parameters:

items - The list.

Returns:

True if the items were deposited successfully.

depositAllExcept

@SafeVarargs
public final boolean depositAllExcept(Filter<Item>... filters)

Deposits all the items in the inventory excluding the items in the filters passed.

Parameters:

filters - The filters.

Returns:

True if the items were deposited successfully.

depositAllExcept

@SafeVarargs
public final boolean depositAllExcept(boolean checkResults,
                                                    Filter<Item>... filters)

deposit

public boolean deposit(Filter<Item> filter,
                       int amount_)

Deposits the specified item with the specified amount in the bank. Please note that this method used a Filter but this should only be used for one item id/name in the filter. Failing to follow this guideline can result in unexpected behaviour of this method. It is not recommended to use this method when you have the item id or name present. If you have the item id or name present, use the equivalent methods. Instead only use this when you have created your own specific filter and are sure it will boil down onto one specific item id. In any case, this method will only apply to the first item returned from the filter.

Parameters:

filter - The filter.

amount_ - The amount to deposit. STORE_ALL or 0 defines the option Store-All.

Returns:

True if the deposit was successful.

deposit

public boolean deposit(int id,
                       int amount)

Deposits the specified item with the specified amount in the bank.

Parameters:

id - The item id.

amount - The amount to deposit. STORE_ALL or 0 defines the option Store-All.

Returns:

True if the deposit was successful.

deposit

public boolean deposit(java.lang.String name,
                       int amount)

Deposits the specified item with the specified amount in the bank.

Parameters:

name - The item name.

amount - The amount to deposit. STORE_ALL or 0 defines the option Store-All.

Returns:

True if the deposit was successful.

getAbsoluteSlotPosition

public java.awt.Rectangle getAbsoluteSlotPosition(int tabSlot,
                                                  int absoluteSlot)

Gets the absolute screen position rectangle for specified slot.

Parameters:

tabSlot - The slot.

Returns:

The rectangle specifying the boundaries of the slot.

getSlotWidget

public RS2Widget getSlotWidget(int widgetId)

isSlotVisible

@Deprecated
public boolean isSlotVisible(Bot bot,
                                          int tabSlot,
                                          int absoluteSlot)

Deprecated. Use isSlotVisible(int tabSlot, int absoluteSlot) instead

isSlotVisible

public boolean isSlotVisible(int tabSlot,
                             int absoluteSlot)

Returns whether the specified slot is visible or not.

Parameters:

tabSlot - The specified slot to check for if its visible or not.

Returns:

Whether the slot if visible or not.

scrollToSlot

public boolean scrollToSlot(int tabSlot,
                            int absoluteSlot)

Scrolls to the specified slot, using the mouse scroll wheel.

Parameters:

tabSlot - The slot to scroll to.

withdrawAll

public boolean withdrawAll(int id)

Withdraws all of the specified item.

Parameters:

id - The item id.

Returns:

True if the withdrawal was successful.

withdrawAll

public boolean withdrawAll(java.lang.String name)

Withdraws all of the specified item.

Parameters:

name - The item name.

Returns:

True if the withdrawal was successful.

withdrawAll

public boolean withdrawAll(Filter<Item> filter)

Withdraws all of the specified item.

Parameters:

filter - The item filter.

Returns:

True if the withdrawal was successful.

withdrawAllButOne

public boolean withdrawAllButOne(int id)

Withdraws all but one of the specified item.

Parameters:

id - The item id.

Returns:

True if the withdrawal was successful.

withdrawAllButOne

public boolean withdrawAllButOne(java.lang.String name)

Withdraws all but one of the specified item.

Parameters:

name - The item name.

Returns:

True if the withdrawal was successful.

withdrawAllButOne

public boolean withdrawAllButOne(Filter<Item> filter)

Withdraws all but one of the specified item.

Parameters:

filter - The item filter.

Returns:

True if the withdrawal was successful.

withdraw

public boolean withdraw(int id,
                        int amount)

Withdraw an item with the specified amount which its name matches the specified id.

Parameters:

id - The item id.

amount - The amount to withdraw.

Returns:

True if the withdrawal was successful.

withdraw

public boolean withdraw(java.lang.String name,
                        int amount)

Withdraws an item with the specified amount which its name matches the specified name.

Parameters:

name - The item name.

amount - The amount to withdraw.

Returns:

True if the withdrawal was successful.

withdraw

public boolean withdraw(java.util.HashMap<java.lang.String,java.lang.Integer> items)

Withdraws all items in the HashMap. \nString is the name of the item. \nInteger is the amount of the item.

Returns:

True if the withdrawal of all items and their quantities was successful.

withdraw

public boolean withdraw(Filter<Item> filter,
                        int amount_)

Withdraws the first item returned by the filter with the specified amount.

Parameters:

filter - The filter.

amount_ - The amount to withdraw.

Returns:

True if the withdrawal was successful.

withdraw

public boolean withdraw(Filter<Item> filter,
                        int amount_,
                        boolean checkResults)

Withdraws the first item returned by the filter with the specified amount.

Parameters:

filter - The filter.

amount_ - The amount to withdraw.

checkResults - Wait to check if items were actually withdrawn.

Returns:

True if the withdrawal was successful.

depositWornItems

public boolean depositWornItems()

Deposits any worn items.

Returns:

True if successfully interacted with deposit equipment button.