org.osbot.rs07.api

Class Store

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

public class Store
extends ItemContainer

API for store functionality (buying and selling)

Field Summary

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

Method Summary

Modifier and Type	Method and Description
boolean	buy(int id, int amount) Buys the specified amount of the item (or the largest option lesser than amount)
boolean	buy(java.lang.String name, int amount) Buys the specified amount of the item (or the largest option lesser than amount)
boolean	close() Closes the store interface
int	getAmount(int id) Returns the amount of an item in the store
int	getAmount(java.lang.String name) Returns the amount of an item in the store
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 an array of store items
int	getSlot(Item item) Gets the slot associated with an item in the store
java.awt.Rectangle	getSlotBoundingBox(int slot) Gets the bounding box for the given item slot
void	initializeModule()
boolean	interact(int slot, java.lang.String... actions) Interacts with the slot specified.
boolean	isOpen()
boolean	sell(int id, int amount) Sells the specified amount of the item (or the largest option lesser than amount)
boolean	sell(java.lang.String name, int amount) Sells the specified amount of the item (or the largest option lesser than amount)

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, getSlotForNameThatContains, hover, 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

Constructor Detail

Store

public Store()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

isOpen

public boolean isOpen()

getItems

public Item[] getItems()

Gets an array of store items

Specified by:

getItems in class ItemContainer

Returns:

items in store

sell

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

Sells the specified amount of the item (or the largest option lesser than amount)

Parameters:

name - Name of item to sell

amount - Amount to sell (if not 1, 5, or 10, api will select largest option less than amount)

sell

public boolean sell(int id,
                    int amount)

Sells the specified amount of the item (or the largest option lesser than amount)

Parameters:

id - Id of item to sell

amount - Amount to sell (if not 1, 5, or 10, api will select largest option less than amount)

buy

public boolean buy(int id,
                   int amount)

Buys the specified amount of the item (or the largest option lesser than amount)

Parameters:

id - ID of item to buy

amount - Amount to buy (if not 1, 5, or 10, api will select largest option less than amount)

buy

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

Buys the specified amount of the item (or the largest option lesser than amount)

Parameters:

name - Name of item to buy

amount - Amount to buy (if not 1, 5, or 10, api will select largest option less than amount)

getAmount

public int getAmount(int id)

Returns the amount of an item in the store

Parameters:

id - ID of item

Returns:

Amount of item in the store

getAmount

public int getAmount(java.lang.String name)

Returns the amount of an item in the store

Parameters:

name - Name of item

Returns:

Amount of item in the store

close

public boolean close()

Closes the store interface

Returns:

true if successful

interact

public boolean interact(int slot,
                        java.lang.String... actions)

Interacts with the slot specified.

Overrides:

interact in class ItemContainer

Parameters:

slot - The slot to interact with.

actions - The action to interact with.

Returns:

True if the bot interacted with the specified slot successfully.

getSlot

public int getSlot(Item item)

Gets the slot associated with an item in the store

Overrides:

getSlot in class ItemContainer

Parameters:

item - The item to match.

Returns:

slot in the store

getSlotBoundingBox

public java.awt.Rectangle getSlotBoundingBox(int slot)

Gets the bounding box for the given item slot

Parameters:

slot - The slot to get the bounding box of

Returns:

The bounding box for the given item slot

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.