org.osbot.rs07.api

Class GrandExchange

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.GrandExchange

public class GrandExchange
extends API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrandExchange.Box
static class	GrandExchange.Status

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

Method Summary

Modifier and Type	Method and Description
boolean	buyItem(int itemId, java.lang.String searchTerm, int price, int quantity)
boolean	buyItems(GrandExchange.Box box)
boolean	close()
boolean	collect()
boolean	collect(boolean collectToBank)
boolean	confirm()
boolean	confirmWarning()
int	getAmountRemaining(GrandExchange.Box box)
int	getAmountSpent(GrandExchange.Box box)
int	getAmountToTransfer(GrandExchange.Box box)
int	getAmountTraded(GrandExchange.Box box)
int	getInterfaceId()
int	getItemId(GrandExchange.Box box)
int	getItemPrice(GrandExchange.Box box)
int	getOfferPrice()
int	getOfferQuantity()
int	getOverallPrice(int itemID)
GrandExchange.Status	getStatus(GrandExchange.Box box)
boolean	goBack()
void	initializeModule()
boolean	isBuyOfferOpen()
boolean	isOfferScreenOpen()
boolean	isOpen()
boolean	isSellOfferOpen()
boolean	sellItem(int itemId, int price, int quantity)
boolean	sellItems(GrandExchange.Box box)
boolean	setOfferPrice(int price) Sets the offer price for the currently open item If 0 is passed as parameter, this method will return true by default.
boolean	setOfferQuantity(int quantity)

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

GrandExchange

public GrandExchange()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

getInterfaceId

public int getInterfaceId()

getItemId

public int getItemId(GrandExchange.Box box)

Parameters:

box - The Grand Exchange Box you wish to query.

Returns:

The item id of the currently traded item in the specified box.

getItemPrice

public int getItemPrice(GrandExchange.Box box)

Parameters:

box - The Grand Exchange Box you wish to query.

Returns:

The item's unit price of the currently traded item in the specified box.

getAmountToTransfer

public int getAmountToTransfer(GrandExchange.Box box)

Parameters:

box - The Grand Exchange Box you wish to query.

Returns:

The total amount of items in the trade.

getAmountRemaining

public int getAmountRemaining(GrandExchange.Box box)

Parameters:

box - The Grand Exchange Box you wish to query.

Returns:

The amount of items remaining to be transferred in the specified box.

getAmountTraded

public int getAmountTraded(GrandExchange.Box box)

Parameters:

box - The Grand Exchange Box you wish to query.

Returns:

The amount of items transferred in the specified box.

getAmountSpent

public int getAmountSpent(GrandExchange.Box box)

Parameters:

box - The Grand Exchange Box you wish to query.

Returns:

The amount of gold spent on the item in the specified box.

getStatus

public GrandExchange.Status getStatus(GrandExchange.Box box)

Parameters:

box - The Grand Exchange Box you wish to query.

Returns:

The current status of your Grand Exchange Buy/Sell offer.

isOpen

public boolean isOpen()

Returns:

True if the Grand Exchange interface is open.

close

public boolean close()

Returns:

True if the Grand Exchange interface is already closed or if the close button was found and clicked.

isBuyOfferOpen

public boolean isBuyOfferOpen()

Returns:

True if the Grand Exchange interface is open and the Buy offer screen is open.

isSellOfferOpen

public boolean isSellOfferOpen()

Returns:

True if the Grand Exchange interface is open and the Sell offer screen is open.

isOfferScreenOpen

public boolean isOfferScreenOpen()

Returns:

True if the Grand Exchange interface is open and a Buy/Sell offer screen is open.

sellItem

public boolean sellItem(int itemId,
                        int price,
                        int quantity)

buyItem

public boolean buyItem(int itemId,
                       java.lang.String searchTerm,
                       int price,
                       int quantity)

buyItems

public boolean buyItems(GrandExchange.Box box)

Parameters:

box - The Grand Exchange Box you wish to query.

Returns:

True if the buy button was successfully clicked for the specified box.

sellItems

public boolean sellItems(GrandExchange.Box box)

Parameters:

box - The Grand Exchange Box you wish to query.

Returns:

True if the sell button was successfully clicked for the specified box.

goBack

public boolean goBack()

Returns:

True if an offer screen is open and the back button was clicked.

collect

public boolean collect()

Returns:

True if the main Grand Exchange interface is open and the collect button was clicked.

collect

public boolean collect(boolean collectToBank)

Parameters:

collectToBank - Set to true to collect items into your bank and false for inventory collection.

Returns:

True if the main Grand Exchange interface is open and the collect button was clicked.

confirmWarning

public boolean confirmWarning()

confirm

public boolean confirm()

Returns:

True if an offer screen is open and the "Confirm" button was pressed.

getOfferPrice

public int getOfferPrice()

Returns:

The price per item in the Buy/Sell offer screen.

getOfferQuantity

public int getOfferQuantity()

Returns:

The item quantity in the Buy/Sell offer screen.

setOfferPrice

public boolean setOfferPrice(int price)

Sets the offer price for the currently open item If 0 is passed as parameter, this method will return true by default.

Parameters:

price - The price per item for your item offer.

Returns:

True if the Buy/Sell offer screen is open, an item has been selected, and the interaction events complete successfully.

setOfferQuantity

public boolean setOfferQuantity(int quantity)

Parameters:

quantity - The quantity of items you wish to offer.

Returns:

True if the Buy/Sell offer screen is open, an item has been selected, and the interaction events complete successfully.

getOverallPrice

public int getOverallPrice(int itemID)