org.osbot.rs07.api

Class DepositBox

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.DepositBox

public class DepositBox
extends ItemContainer

API for Bank Deposit Box functionality

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE
static int	STORE_1
static int	STORE_10
static int	STORE_5
static int	STORE_ALL

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
DepositBox()

Method Summary

Modifier and Type	Method and Description
boolean	close() Closes the DepositBox interface
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(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(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	depositLoot() Deposits all loot items.
boolean	depositWornItems() Deposits all worn items.
int	getInterfaceChildId() Gets the interface child id that this item container represents.
int	getInterfaceId() Gets the interface id that this item container represents.
Item[]	getItems() Gets the array of items stored in this container in order.
RS2Widget	getSlotWidget(int slotWidgetId)
void	initializeModule()
boolean	isOpen() Checks whether a bank deposit box is opened
boolean	open() Opens the bank deposit box

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

contains, contains, contains, contains, containsAll, containsAll, filter, getAmount, getAmount, getAmount, getCapacity, 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

SIZE

public static final int SIZE

See Also:

Constant Field Values

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

Constructor Detail

DepositBox

public DepositBox()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

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.

close

public boolean close()

Closes the DepositBox interface

Returns:

True if the close button was found and clicked.

depositWornItems

public boolean depositWornItems()

Deposits all worn items.

Returns:

True if the deposit worn items button was found and clicked.

depositLoot

public boolean depositLoot()

Deposits all loot items.

Returns:

True if the deposit loot button was found and clicked.

depositAll

public boolean depositAll()

Deposits all items in the inventory in the bank.

Returns:

True if the deposit inventory button was clicked.

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.

isOpen

public boolean isOpen()

Checks whether a bank deposit box is opened

Returns:

true if open

open

public boolean open()

Opens the bank deposit box

Returns:

true if successfully opened

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

@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.

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.

getSlotWidget

public RS2Widget getSlotWidget(int slotWidgetId)

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.