Controller (app API)

java.lang.Object
- controller.Controller

public class Controller
extends java.lang.Object

This is the native scripting API for IdleRSC.

Field Summary

Fields
Modifier and Type Field and Description

int[] bankerIds

static int CTRL_DOWN_MASK

orsc.mudclient mud

static int SHIFT_DOWN_MASK

static boolean temporaryToggleSideMenu

Fields
Modifier and Type	Field and Description
`int[]`	`bankerIds`
`static int`	`CTRL_DOWN_MASK`
`orsc.mudclient`	`mud`
`static int`	`SHIFT_DOWN_MASK`
`static boolean`	`temporaryToggleSideMenu`

Constructor Summary

Constructors
Constructor and Description

Controller(Reflector _reflector, orsc.OpenRSC _client, orsc.mudclient _mud)

Constructors
Constructor and Description
`Controller(Reflector _reflector, orsc.OpenRSC _client, orsc.mudclient _mud)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acceptTrade()` Accepts the trade on the first trade window.
`void`	`acceptTradeConfirmation()` Accepts the current trade on the final trade window.
`void`	`addFriend(java.lang.String username)` Adds a friend to the user's friend list.
`void`	`addIgnore(java.lang.String username)` Adds the specified username to the ignore list
`boolean`	`atObject(int id)` Performs the primary command option on the nearest reachable objectId
`boolean`	`atObject(int x, int y)` Performs the primary command option on the specified object id at the specified coordinates.
`boolean`	`atObject(SceneryId id)` Performs the primary command option on the nearest reachable scenery ID
`boolean`	`atObject2(int id)` Performs the second command option on the nearest reachable objectId
`boolean`	`atObject2(int x, int y)` Performs the 2nd command option on the specified object id at the specified coordinates.
`void`	`attackNpc(int npcServerIndex)` Attacks the specified NPC.
`void`	`attackPlayer(int playerServerIndex)` Attacks the specified player.
`void`	`atWallObject(int x, int y)` Walks to the wall object and then interacts with it.
`void`	`atWallObject2(int x, int y)` Walks to the wall object and then interacts with it (secondary interaction.)
`void`	`auctionBuy(AuctionItem auction, int itemAmount)` Buys an amount of items from a given auction id.
`void`	`auctionBuyAll(AuctionItem auction)` This method can potentially use all of your carried coins so be cautious when using it. Attempts to buy all items from the given AuctionItem.
`void`	`auctionCancel(AuctionItem auction)` Cancels an auction.
`void`	`auctionCreate(int itemId, int itemAmount, int pricePerItem)` Lists an amount of itemId for a specified price in the auction house.
`void`	`auctionRefresh()` Refreshes the Auction House listings.
`AuctionItem`	`auctionSearchCheapestOfItemId(int itemId)` Returns an AuctionItem with the cheapest price per item for an item id.
`java.util.ArrayList<AuctionItem>`	`auctionSearchForItemId(int itemId)` Returns an ArrayList of AuctionItems for a given item id.
`void`	`beginAuctionTimeout()` The auction house requires a minimum of 5 seconds between each interaction.
`int`	`calculateNpcLevel(int npcId)` Calculates an NPC's level based on it's stats
`boolean`	`canCastSpell(int spellId)` Determines if the player can cast a specific spell (high enough stat level and has runes)
`void`	`castSpellOnGroundItem(int spellId, int itemId, int x, int y)` Casts the specified spell on the specified ground item on the specified tile.
`void`	`castSpellOnInventoryItem(int spellId, int slotIndex)` Casts the specified spell on the specified inventory item.
`void`	`castSpellOnNpc(int serverIndex, int spellId)` Casts the specified spell on the specified npc.
`void`	`castSpellOnObject(int spellId, int x, int y)` Casts the specified spell on the object at the specified coordinates.
`void`	`castSpellOnPlayer(int spellId, int playerServerIndex)` Casts the specified spell on the specified player.
`void`	`castSpellOnSelf(int spellId)` Casts the specified spell on the player.
`void`	`chatMessage(java.lang.String rstext)`
`void`	`closeAuctionHouse()` Closes the Auction House window
`void`	`closeBank()` Closes the bank window.
`void`	`closeDoor(int x, int y)` Closes the door at the specified coordinates.
`void`	`closeServerMessage()` Closes the current server message popup window.
`void`	`closeShop()` Closes the currently open shop window.
`int`	`convertX(int x)` Converts player/NPC coordinates to local region coordinates to global coordinates.
`int`	`convertZ(int z)` Converts player/NPC coordinates to local region coordinates to global coordinates.
`void`	`createAccount(java.lang.String email)` Creates the specified account provided in the command line with the specified email.
`void`	`createAccount(java.lang.String email, java.lang.String username, java.lang.String password)` Creates the specified account on the server.
`int`	`currentX()` Retrieves the current X coordinates of the player.
`int`	`currentY()` Retrieves the current Y coordinates of the player.
`void`	`declineTrade()` Declines the trade.
`boolean`	`depositAll()` Deposits all yo stuff in the bank
`boolean`	`depositItem(int itemId)` Deposits one of specified item into the bank.
`boolean`	`depositItem(int itemId, int amount)` Deposits the specified item, of specified amount, into the bank.
`void`	`disablePrayer(int prayerId)` Disables the prayer.
`void`	`displayMessage(java.lang.String rstext)` Displays a message in the client chat window.
`void`	`displayMessage(java.lang.String rstext, int type)` Displays a message in the client chat window, of the specified MessageType.
`int`	`distance(int x1, int y1, int x2, int y2)` Retrieves the distance between two tiles.
`int`	`distanceTo(int x, int y)`
`void`	`drawBoxAlpha(int x, int y, int width, int height, int color, int transparency)` Draws a box at the specified coordinates with the specified color and transparency.
`void`	`drawBoxBorder(int x, int y, int width, int height, int color)` Draws a hollow rectangle at the specified coordinates.
`void`	`drawCenteredString(java.lang.String str, int x, int y, int color, int fontSize)` Draws text that is centered at the specified coordinates.
`void`	`drawCircle(int x, int y, int radius, int color, int transparency, int dummy)` Draws a circle at the specified coordinates with specified radius, color, and transparency.
`void`	`drawItemSprite(int itemId, int x, int y, int scalePercent, boolean mirrorX)` Draws the sprite of an item at specified coordinates.
`void`	`drawLineHoriz(int x, int y, int width, int color)` Draws a horizontal line at the specified coordinates with the specified width.
`void`	`drawLineVert(int x, int y, int height, int color)` Draws a vertical line at the specified coordinates with the specified height.
`void`	`drawProgressBar(int current, int maximum, int bgColor, int fgColor, int borderColor, int x, int y, int width, int height, boolean showPercentage, boolean showValues)` Draws a progress bar.
`void`	`drawShadowText(java.lang.String text, int x, int y, int textColor, int fontSize, boolean center)` Draws shadow text at the specified coordinates.
`void`	`drawString(java.lang.String str, int x, int y, int color, int fontSize)` Draws text at the specified coordinates.
`void`	`drawVerticalGradient(int x, int y, int width, int height, int topColor, int bottomColor)` Draws a gradient box at the specified coordinates.
`void`	`dropItem(int slotIndex)` Drops one the specified item at the specified item slot.
`void`	`dropItem(int slotIndex, int amount)` Drops the specified item at the specified item slot, of specified amount.
`void`	`duelPlayer(int playerServerIndex)` Duels the specified player.
`void`	`enablePrayer(int prayerId)` Enables the prayer.
`void`	`equipItem(int slotIndex)` Equips the item in the specified slot.
`void`	`equipItemById(int id)` Equipts an item by ID.
`void`	`followPlayer(int playerServerIndex)` Follows the specified player.
`long`	`getAccountValue()` Retrieves the estimated value of everything in your inventory and bank
`int[][]`	`getAllNpcsById(int[] npcIds, boolean inCombatAllowed)` Method to make a 2D array with all [x,y,npcId] positions of the supplied npcIds[] array Other methods only return the closest npc, this will return all of them in a nx3 matrix
`java.util.ArrayList<AuctionItem>`	`getAuctions()` Returns an ArrayList of AuctionItems after checking and waiting for the auction timeout to finish.
`int`	`getBankItemCount(int itemId)` Retrieves the amount of the item in the bank.
`java.util.List<com.openrsc.client.entityhandling.instances.Item>`	`getBankItems()` Retrieves a list of all the items inside the bank.
`int`	`getBankItemsCount()` Retrieves the total count of all items in the bank.
`int`	`getBaseStat(int statId)` Retrieves the base level (excluding boosted/degraded stats) of the specified skill.
`boolean`	`getBatchBarsOn()` Check if batch bars are enabled
`int`	`getBlockingNpcServerIndex(int npcId)` Returns the server index of the NPC which is currently blocking you.
`orsc.enumerations.ORSCharacterDirection`	`getCharacterDirection(orsc.ORSCharacter c)` Retrieves the direction of the ORSCharacter (NPC or player.)
`int`	`getCurrentStat(int statId)` Retrieves the current level (including boosted/degraded stats) of the specified skill.
`boolean`	`getCustomUiMode()` Checks for the Custom UI mode config in mudclient.
`java.util.Map<java.lang.Integer,java.lang.Integer>`	`getDebuggerBank()` Returns a Map of bank items and their amount from the debugger.
`int`	`getDirection(int x, int y)` Retrieves the direction of the specified coordinate, relative to the player.
`int`	`getDistanceFromLocalPlayer(int coordX, int coordY)` Retrieves the distance of the coordinates from the player.
`int`	`getEquippedItemId(int slotIndex)` return a int item id that is equipped in the provided slot index
`int[]`	`getEquippedItemIds()` return a list of all item ids that are equipped
`int`	`getFatigue()` Retrieves the current fatigue.
`int`	`getFatigueDuringSleep()` Retrieves the current fatigue status while sleeping.
`int`	`getFightMode()` Retrieves the current fight mode set.
`int[]`	`getFoodIds()` Retrieves the list of all food items in the game.
`java.util.List<java.lang.String>`	`getFriendList()` Retrieves a list of users on the friends list.
`int`	`getGameHeight()` Returns the height, in pixels, of the game window.
`int`	`getGameWidth()` Returns the width, in pixels, of the game window.
`int`	`getGroundItemAmount(int itemId, int x, int y)` Retrieves the amount of the item id on the ground at the specified coordinates.
`int[]`	`getGroundItems()` Retrieves all itemIds of items on the ground.
`int`	`getGroundItemsCount()` Retrieves the count of different item ids on the ground.
`boolean[]`	`getGroundItemsNoted()` Retrieves an array of whether or not the ground item is noted.
`java.util.List<GroundItemDef>`	`getGroundItemsStacked()` Retrieve a list of items on the ground near the player.
`int[]`	`getGroundItemsX()` Retrieves an array of X coordinates of ground items.
`int[]`	`getGroundItemsY()` Retrieves an array of Y coordinates of ground items.
`java.util.List<java.lang.String>`	`getIgnoreList()` Retrieves a list of users on the ignore list.
`int`	`getInventoryItemCount()` Retrieves the number of items currently in the inventory.
`int`	`getInventoryItemCount(int itemId)` Retrieves the count of the specified item in the inventory.
`int[]`	`getInventoryItemIds()` Retrieves an array of all the ids of all items in the inventory.
`java.util.List<com.openrsc.client.entityhandling.instances.Item>`	`getInventoryItems()` Retrieves a list of all items in the inventory.
`int`	`getInventoryItemSlotIndex(int itemId)` Retrieves the slot id of the specified item id.
`int`	`getInventorySlotItemId(int slotIndex)` Retrieves the itemId of the item at the specified `slotIndex`.
`int[]`	`getInventoryUniqueItemIds()`
`java.lang.String`	`getItemCommand(int itemId)` Retrieves the command of the specified item.
`java.lang.String`	`getItemExamineText(int itemId)` Retrieves the examine text of the specified item.
`int`	`getItemId(java.lang.String itemName)` Retrieves the item id of the specified item name.
`java.lang.String`	`getItemName(int itemId)` Retrieves the name of the specified item.
`int`	`getItemSpriteHeight(int itemId)` Returns the height of the sprite for an item id
`int`	`getItemSpriteScaledHeight(int itemId, int scalePercent)` Returns the height of the sprite for an item id
`int`	`getItemSpriteScaledWidth(int itemId, int scalePercent)` Returns the width of the sprite for an item id
`int`	`getItemSpriteWidth(int itemId)` Returns the width of the sprite for an item id
`int`	`getLastNpcKilledCount()` Returns the kill count of the last killed npc
`int`	`getLastNpcKilledId()` Returns the id of the last killed npc
`java.util.List<com.openrsc.client.entityhandling.instances.Item>`	`getLocalTradeItems()` Retrieves items which the player is offering in the trade.
`int`	`getLocalTradeItemsCount()` Retrieves how many items the player is offering in the trade.
`orsc.mudclient`	`getMud()` Retrieves the `mudclient`.
`java.lang.Object`	`getMudClientValue(java.lang.String propertyName)` Retrieves the specified field object value of the `mudclient`.
`int[]`	`getMudMouseCoords()`
`java.util.ArrayList<AuctionItem>`	`getMyAuctions()` Returns an ArrayList of auctions for sale by the current player
`int[][]`	`getNearbyClosedDoors(int radius)` Returns an int[][] of closed door coordinates
`int[]`	`getNearestBank()` Retrieves the coordinates of the nearest bank, based on your current position.
`int[]`	`getNearestItemById(int itemId)` Retrieves the coordinates of the nearest specified item within the given distance, if on the ground
`int[]`	`getNearestItemById(int itemId, int maxDistance)` Retrieves the coordinates of the specified item, if on the ground.
`int[]`	`getNearestItemByIds(int[] itemIds)` Retrieves the coordinates of the specified items, if on the ground.
`orsc.ORSCharacter`	`getNearestNpcById(int npcId, boolean inCombatAllowed)` Retrieves the character object of the nearest npc.
`orsc.ORSCharacter`	`getNearestNpcByIds(int[] npcIds, boolean inCombatAllowed)` Retrieves the character object of the nearest NPC specified in the list of ids.
`orsc.ORSCharacter`	`getNearestNPCByLambda(java.util.function.Predicate<orsc.ORSCharacter> condition)` Retrieves the character object of the nearest NPC that satisfies the condition
`int[]`	`getNearestObjectById(int objectId)` Retrieves the coordinates of the nearest specified object ID, if nearby.
`int[]`	`getNearestObjectByIds(int[] objectIds)` Finds the nearest object coordinates based on the given object IDs.
`int[]`	`getNearestReachableObjectById(int objectId, boolean includeTileEdges)` Retrieves the coordinates of the nearest specified object ID, if nearby and reachable.
`int[]`	`getNearestReachableObjectByIds(int[] objectIds, boolean includeTileEdges)` Retrieves the coordinates of the nearest specified objects by their IDs, if any are nearby and reachable.
`int[]`	`getNearestWallObjectById(int wallObjectId)` Retrieves the coordinates of the specified wall object id, if nearby.
`boolean`	`getNeedToMove()` Call this method to check the state of needToMove.
`int`	`getNotedInventoryItemCount(int itemId)` Retrieves the count of the specified item that is noted in the inventory.
`int`	`getNotedInventoryItemSlotIndex(int itemId)` Retrieves the slot id of the specified noted item id.
`orsc.ORSCharacter`	`getNpc(int serverIndex)` Creates an NPC character object based on the server index provided.
`orsc.ORSCharacter`	`getNpcAtCoords(int x, int y)` Returns the NPC object of the NPC at the specified coordinates.
`java.lang.String`	`getNpcCommand1(int npcId)` Retrieves the 1st command of the specified NPC.
`java.lang.String`	`getNpcCommand2(int npcId)` Retrieves the 2nd command of the specified NPC.
`int[]`	`getNpcCoordsByServerIndex(int serverIndex)` Retrieves the coordinates of the specified NPC.
`int`	`getNpcCount()` Retrieves the count of NPCs nearby.
`java.lang.String`	`getNpcExamineText(int npcId)` Retrieves the examine text of the specified NPC.
`java.lang.String`	`getNpcName(int npcId)` Retrieves the name of the specified NPC.
`java.util.List<orsc.ORSCharacter>`	`getNpcs()` Retrieves a list of NPCs nearby.
`orsc.ORSCharacter[]`	`getNpcsAsArray()` Retrieves ORSCharacter[] array of NPCs nearby.
`int[]`	`getNpcsAsIntArray()` Retrieves int[] array of NPCs nearby.
`int`	`getObjectAtCoord(int x, int y)` Retrieves the id of the object at the specified coordinates.
`java.lang.String`	`getObjectCommand1(int objId)` Retrieves the 1st command of the specified object id.
`java.lang.String`	`getObjectCommand2(int objId)` Retrieves the 2nd command of the specified object id.
`java.lang.String`	`getObjectExamineText(int objId)` Retrieves the examine text of the specified object id.
`java.lang.String`	`getObjectName(int objId)` Retrieves the name of the specified object id.
`java.util.List<com.openrsc.client.entityhandling.defs.GameObjectDef>`	`getObjects()` Retrieves a list of nearby objects.
`int[][]`	`getObjectsById(int objectId)` Retrieves all the coordinates of the nearby object ID
`int`	`getObjectsCount()` Retrieves the count of objects nearby.
`int[]`	`getObjectsIds()` Retrieves the IDs of objects nearby.
`int[]`	`getObjectsX()` Retrieves an array of all of the X coordinates of nearby objects.
`int[]`	`getObjectsZ()` Retrieves an array of all of the Z coordinates of nearby objects.
`int`	`getOptionMenuCount()` Retrieves the amount of options currently presented to the user.
`java.lang.String[]`	`getOptionsMenuText()` Retrieves the array of options inside of an option menu.
`java.lang.String`	`getOptionsMenuText(int i)` Retrieves the text of the specified option index when talking to an NPC or performing an action.
`orsc.ORSCharacter`	`getPlayer()` Retrieves the ORSCharacter of the local player.
`orsc.ORSCharacter`	`getPlayer(int serverIndex)` Retrieves the ORSCharacter of the specified player server index.
`int`	`getPlayerAtCoord(int x, int y)` Retrieves the server index of the player at the specified coordinates.
`java.util.ArrayList<AuctionItem>`	`getPlayerAuctions(java.lang.String playerName)` Returns an ArrayList of auctions for sale by a specified player
`int[]`	`getPlayerCoordsByServerIndex(int serverIndex)` Retrieves the coordinates of the specified NPC.
`int`	`getPlayerCount()` Retrieves the number of nearby players.
`int`	`getPlayerExperience(int statId)` Retrieves the amount of XP gained in the skill since last login.
`int`	`getPlayerMode()` Returns the players gamemode.
`java.lang.String`	`getPlayerName()` Retrieves the name of the currently logged in player.
`java.util.List<orsc.ORSCharacter>`	`getPlayers()` Retrieves a list of nearby players.
`int`	`getPlayerServerIndexByName(java.lang.String name)` Retrieves the server index of the specified player name.
`int`	`getPrayerDrain(int prayerId)` Retrieves the drain rate of the specified prayer.
`int`	`getPrayerId(java.lang.String prayerName)` Retrieves the id of the specified prayerName.
`int`	`getPrayerLevel(int prayerId)` Retrieves the level required to use the specified prayer.
`java.lang.String`	`getPrayerName(int prayerId)` Retrieves the name of the specified prayer id.
`int`	`getPrayersCount()` Retrieves the number of prayers in the game.
`java.lang.String[]`	`getQuestNames()` Returns an array of quest names.
`int`	`getQuestPoints()` Returns the amount of quest points the player has.
`int`	`getQuestsCount()` Returns the number of quests (total)
`int`	`getQuestStage(int questId)` Retrieves the quest stage for the specified quest ID.
`java.util.List<com.openrsc.client.entityhandling.instances.Item>`	`getRecipientTradeItems()` Retrieves a list of items which your trade recipient is offering.
`int`	`getRecipientTradeItemsCount()` Retrieves the number of items presented by the trade recipient
`java.lang.String`	`getServerMessage()` Retrieves the current server message popup window text.
`int`	`getShopItemCount(int itemId)` Retrieves how many of the specified item is in stock.
`int`	`getShopItemPrice(int itemId)` Retrieves the price of a single item in the shop.
`java.util.List<com.openrsc.client.entityhandling.instances.Item>`	`getShopItems()` Retrieves a list of all the shop items in the shop.
`int`	`getShopItemsCount()` Retrieves the number of different items which the shop sells.
`int`	`getShopItemStackPrice(int itemId)` Retrieves the price of the stack of items in the shop.
`boolean`	`getShouldSleep()`
`boolean`	`getShowBotPaint()` Whether or not bot painting is enabled.
`boolean`	`getShowCoords()` Whether or not the the left-hand coordinates indicator is enabled.
`boolean`	`getShowStatus()` Whether or not the left-hand status indicator is enabled.
`boolean`	`getShowXp()` Whether or not the left-hand XP counter is enabled.
`java.lang.String[]`	`getSkillNamesLong()` Retrieves an array of all the skill names.
`java.util.List<SkillDef>`	`getSkills()` Retrieves a list of all the skills.
`int`	`getSpellIdFromName(java.lang.String name)` Retrieves the spellId of the spell name.
`int`	`getSpellLevel(int spellId)` Retrieves the spell level for the given spell ID.
`java.lang.String[]`	`getSpellNames()` Retrieves the names of all spells.
`java.util.Set<java.util.Map.Entry<java.lang.Integer,java.lang.Integer>>`	`getSpellRunes(int spellId)` Retrieves the set of spell runes required for a given spell ID.
`int`	`getSpellsCount()` Retrieves the number of spells (total)
`int`	`getSpellType(int spellId)` Gets the spell type for the given spell ID.
`int`	`getStatCount()` Retrieves the number of skills in the game.
`int`	`getStatId(java.lang.String statName)` Retrieves the id of the specified skill name.
`int`	`getStatXp(int statId)` Retrieves the current XP in the specified skill.
`int`	`getStringHeight(int fontSize)` Returns the height of a specified font size.
`int`	`getStringWidth(java.lang.String string, int fontSize)` Returns the width of a string of a specified font size.
`orsc.ORSCharacter`	`getTargetedNpc()`
`int`	`getTotalKillCount()` Returns the total kill count of all npcs
`int`	`getTotalLevel()` Returns the total level by summing up the player level for each stat.
`long`	`getTotalXp()` Returns the total XP by summing up the player experience for each stat.
`int[]`	`getTradeItemsCounts()` Retrieves an array of item counts inside of the current trade window.
`java.lang.String`	`getTradeRecipientName()` Retrieves the name of the trade recipient, if we are in a trade.
`int`	`getUnnotedInventoryItemCount(int itemId)` Retrieves the count of the specified item that is not noted in the inventory.
`int`	`getUnnotedInventoryItemSlotIndex(int itemId)` Retrieves the slot id of the specified unnoted item id.
`int`	`getWallObjectDirectionAtCoord(int x, int y)` Returns the direction of the wall object.
`java.lang.String`	`getWallObjectExamineText(int objId)` Retrieves the examine text of the specified wall object id.
`int`	`getWallObjectIdAtCoord(int x, int y)` Retrieves the id of the wall object at the specified coordinates.
`int[]`	`getWallObjectIds()` Retrieves an array of all wall object IDs nearby.
`java.lang.String`	`getWallObjectName(int objId)` Retrieves the examine text of the specified wall object id.
`java.util.List<com.openrsc.client.entityhandling.defs.DoorDef>`	`getWallObjects()` Retrieves a list of wall objects nearby.
`int`	`getWallObjectsCount()` Retrieves the count of wall objects nearby.
`int[]`	`getWallObjectsDirections()`
`int[]`	`getWallObjectsX()` Retrieves an array of all of the X coordinates of nearby wall objects.
`int[]`	`getWallObjectsZ()` Retrieves an array of all of the Z coordinates of nearby wall objects.
`WebWalker`	`getWebWalker()` Returns controllers instance of WebWalker.
`void`	`hideContactDetailsMenu()` Hides Details Menu (Run this every message hook callback to prevent corrupt packets showing this menu)
`void`	`hideRecoveryDetailsMenu()` Hide Recovery Question Menu (Run this every message hook callback to prevent corrupt packets showing this menu)
`void`	`hideWelcomeScreen()`
`boolean`	`isAuthentic()` Whether or not the server is configured to be authentic.
`boolean`	`isAutoLogin()` Retrieves whether or not auto-login is set.
`boolean`	`isBatching()` Whether or not the batch progress bar is currently shown on screen.
`boolean`	`isCloseToCoord(int x, int y)` Whether or not you are within 1 tile of the specified coordinates.
`boolean`	`isCurrentlyWalking()` Whether or not the player is currently walking.
`boolean`	`isDoorOpen(int x, int y)` Whether or not the door at the specified coordinates is open.
`boolean`	`isDrawEnabled()` Whether or not draw/graphics is currently enabled.
`boolean`	`isEquipped(int slotIndex)` Whether or not the specified item slot is equipped.
`boolean`	`isInAuctionHouse()` Check if the player is in an auction house and not at the disallowed one on Karamja
`boolean`	`isInBank()` Whether or not the bank window is currently open.
`boolean`	`isInCombat()` Whether or not the player is currently in combat.
`boolean`	`isInOptionMenu()` Whether or not an NPC/action option menu is currently presented to the player.
`boolean`	`isInShop()` Whether or not a shop window is currently open.
`boolean`	`isInterlacing()` Retrieves whether or not the interlacer is set.
`boolean`	`isInTrade()` Whether or not we are currently engaged in a trade.
`boolean`	`isInTradeConfirmation()` Whether or not we are currently in the trade confirmation window.
`boolean`	`isItemAtCoord(int x, int y, int itemId)` Whether or not the specified item is present at the specified coordinates.
`boolean`	`isItemIdEquipped(int itemId)` Whether or not the specified item ID is equipped.
`boolean`	`isItemInBank(int itemId)` Whether or not the specified item ID is in the bank.
`boolean`	`isItemInInventory(int itemId)` Whether or not the specified item id is in the inventory.
`boolean`	`isItemNotable(int itemId)` Retrieves whether or not the item is notable.
`boolean`	`isItemStackable(int itemId)` Whether or not the specified item is a stackable item.
`boolean`	`isItemTradeable(int itemId)` Retrieves whether or not the item is tradeable.
`boolean`	`isItemWearable(int itemId)` Whether or not the specified item is a wearable item.
`boolean`	`isLoaded()` Whether or not the client is loaded.
`boolean`	`isLoggedIn()` Whether or not the player is currently logged in.
`boolean`	`isNearbyDoorClosed(int radius)` Checks in the radius for a closed door
`boolean`	`isNpcAttackable(int npcId)` Whether or not the specified npcId is attackable.
`boolean`	`isNpcCurrentlyWalking(int serverIndex)` Checks if an NPC is currently walking.
`boolean`	`isNpcInCombat(int serverIndex)` Whether or not the specified npc is in combat.
`boolean`	`isNpcTalking(int serverIndex)` Checks if the NPC is currently talking.
`boolean`	`isPlayerAnIronMode()` Returns whether the player is an ironman mode.
`boolean`	`isPlayerCurrentlyWalking(int serverIndex)` Determines if the player is currently walking.
`boolean`	`isPlayerInCombat(int playerIndex)` Whether or not the specified player index is in combat.
`boolean`	`isPrayerOn(int prayerId)` Whether or not the specified prayer is currently on.
`boolean`	`isQuestComplete(int questId)` Determines if a quest is complete.
`boolean`	`isReachable(int x, int y, boolean includeTileEdges)` Whether or not the tile is reachable in the current map segment.
`boolean`	`isRender3DEnabled()` Whether or not render 3D is currently enabled.
`boolean`	`isRunning()`
`boolean`	`isSleeping()` Whether or not the player is currently sleeping.
`boolean`	`isTileEmpty(int x, int y)` Whether or not the specified tile has an object at it.
`boolean`	`isTradeRecipientAccepting()` Whether or not the recipient is currently accepting the trade.
`boolean`	`itemCommand(int itemId)` Uses the command option on the specified item id.
`void`	`itemCommandBySlot(int slotIndex)` Uses the command option on the item at the specified slot id.
`void`	`log(java.lang.String text)` Logs text to the console, bot log window, and OpenRSC applet.
`void`	`log(java.lang.String text, java.lang.String rsTextColor)` Logs text to the console, bot log window, and OpenRSC applet with the specified @col@.
`void`	`login()` Attempts in using the credentials specified in the command line.
`void`	`logout()` Disables autologin and attempts to logout.
`void`	`moveCharacter()` Call this method from within a script to move the character one tile away to a random tile.
`java.lang.String`	`msToShortString(long milliseconds)` Display String "Hr:Min" version of milliseconds long int.
`java.lang.String`	`msToString(long milliseconds)` Display String "Hr:Min:Sec" version of milliseconds long int.
`void`	`npcCommand1(int serverIndex)` Walks to the NPC and select the 1st command option.
`void`	`npcCommand2(int serverIndex)` Walks to the NPC and select the 2nd command option.
`int`	`offsetX(int x)` Converts local region coordinates to global coordinates.
`int`	`offsetZ(int z)` Converts local region coordinates to global coordinates.
`void`	`openAuctionHouse()` Uses npcCommand1 to open the auction house on the nearest clerk
`void`	`openBank()` Will open bank near any bank NPC or bank chest.
`void`	`openDoor(int x, int y)` Opens the door at the specified coordinates.
`void`	`openNearbyDoor(int radius)` If standing next to a closed door or gate within the specified radius, open it.
`void`	`openNearbyDoors(int radius)` Opens all reachable doors with the same id that match the ids in the radius.
`void`	`openShop(int[] npcIds)` Uses npcCommand1 to open the shop on the nearest npc id given
`void`	`optionAnswer(int answerIndex)` Selects an option menu when talking to an NPC or performing an action.
`void`	`paste()` Pastes the contents of the clipboard to the dialog box.
`boolean`	`pickupItem(int itemId)` Picks up the nearest reachable item with id itemId
`void`	`pickupItem(int x, int y, int itemId, boolean unused, boolean async)` Picks up the item at the specified coordinates.
`void`	`printAuctionItem(AuctionItem item)` Prints an AuctionItem to console
`void`	`quitIfAuthentic()` If running on an authentic server, this stops the script and outputs a message about compatibility.
`void`	`removeAllTradeItems()` Removes all trade items from the current trade window.
`void`	`removeFriend(java.lang.String username)` Removes a friend from the user's friend list. Does not update on client side
`void`	`removeIgnore(java.lang.String username)` Removes the specified player from the ignore list.
`int`	`removeOffsetX(int x)` Converts global coordinates to local region coordinates.
`int`	`removeOffsetZ(int z)` Converts global coordinates to local region coordinates.
`void`	`resizeWindow(int width, int height)` Resizes the client applet window.
`void`	`sendPrivateMessage(java.lang.String username, java.lang.String message)` Sends a private message to a specified user.
`void`	`sendSleepWord(java.lang.String word)` Internal function used for sleeping.
`void`	`setAutoLogin(boolean value)` Toggles auto-login.
`void`	`setBatchBars(boolean value)` Method can be called to toggle Batch Bars in the openrsc client config for native scripts utilizing batch bars.
`void`	`setBatchBarsOff()` (use setBatchBars(boolean)) Method can be called to toggle OFF Batch Bars in the openrsc client config for native scripts utilizing batch bars.
`void`	`setBatchBarsOn()` (setBatchBars(boolean)) Method can be called to toggle ON Batch Bars in the openrsc client config.
`void`	`setBotPaint(boolean _showBotPaint)` Toggle bot painting (such as progress reports.) This does not disable client graphics.
`void`	`setCustomUiMode(boolean mode)` Toggles Custom UI mode, this gives a redesigned in-game UI.
`void`	`setDrawing(boolean drawing_, int pauseTicks)` Toggle draw/graphics.
`void`	`setFightMode(int mode)`
`void`	`setGroundItemsToggle(int level)` Toggle which types of ground items show up on the screen.
`void`	`setInterlacer(boolean interlace)` Toggles the client interlacer, which is for saving CPU cycles.
`void`	`setKeepInventoryOpenMode(boolean setting)` Set Inventory Toggle Mode.
`void`	`setNeedToMove(java.lang.Boolean needToMove_)` Call this method to trigger a move within scripts.
`void`	`setRender3D(boolean render3D)` Toggle render 3D.
`void`	`setScrollLevel(int level)` Set the in-game scroll level of the client.
`void`	`setServerMessage(java.lang.String msg, boolean largeBox, boolean show)` Sets the current server message window text.
`void`	`setShouldSleep(boolean shouldSleep)`
`void`	`setShowCoords(boolean b)` Toggles the left-hand coordinates indicator.
`void`	`setShowStatus(boolean b)` Toggles the left-hand status indicator.
`void`	`setShowXp(boolean b)` Toggles the left-hand XP counter.
`void`	`setStatus(java.lang.String rstext)` Sets the left-hand status indicator text value.
`boolean`	`setTradeItems(int[] itemIds, int[] amounts, boolean notableItems)` Will put up the specified items and amounts on the trade window.
`boolean`	`shopBuy(int itemId)` Buys the specified item from the currently open shop.
`boolean`	`shopBuy(int itemId, int amount)` Buys the specified itemId from the shop.
`boolean`	`shopSell(int itemId)` Sells the specified item to the currently open shop.
`boolean`	`shopSell(int itemId, int amount)` Sells the specified itemId to the shop.
`java.lang.String`	`shortTimeToCompletion(int processed, int remaining, long time)` Shows short Time to Completions in hours only.
`void`	`showContactDetailsMenu()` Show Details Menu
`void`	`showRecoveryDetailsMenu()` Show Recovery Question Menu
`void`	`skipTutorialIsland()` If on tutorial island, skips tutorial island.
`void`	`sleep(int ms)`
`void`	`sleepHandler(boolean quitOnNoSleepingBag)` If fatigue is greater or equal to `fatigueToSleepAt`, this will commence the sleep process and IdleRSC will fill in the answer from the OCR.
`boolean`	`sleepUntil(java.util.function.Supplier<java.lang.Boolean> condition)` Suspends the current thread's execution until the provided condition evaluates to true or a 20 second timeout is reached
`boolean`	`sleepUntil(java.util.function.Supplier<java.lang.Boolean> condition, int timeout)` Suspends the current thread's execution until the provided condition evaluates to true.
`boolean`	`sleepUntilGainedXp()` Suspends the current thread's execution until the player gains exp
`boolean`	`sleepUntilMoving(long timeout)` Sleeps until the player starts walking
`boolean`	`sleepUntilNotMoving(long timeout)` Sleeps until the player is no longer walking
`void`	`stop()` Stops the currently running script.
`void`	`stopBatching()` Sends a packet to the server to stop batching and sleeps until it has stopped.
`boolean`	`takeScreenshot(java.lang.String fileName)` Takes a screenshot of the client applet and saves a bitmap as the specified filename.
`boolean`	`talkToNpc(int serverIndex)` Talks to the specified npc server index.
`boolean`	`talkToNpcId(int npcId, boolean waitUntilInDialog)` Talks to the specified npc by ID.
`void`	`thieveNpc(int serverIndex)` Thieves the NPC.
`java.lang.String`	`timeToCompletion(int processed, int remaining, long time)` Shows Time to Completions in hours, minutes, and seconds.
`void`	`toggleViewId()` Internal function used to grant the ability for normal accounts to access the developer ID menus.
`void`	`tradePlayer(int playerServerIndex)` Trades the specified player.
`void`	`typeKey(char key)` Types a single key of the specified char.
`void`	`unequipItem(int slotIndex)` Unequips the item in the specified slot.
`void`	`useItemIdOnObject(int x, int y, int itemId)` Uses the specified item id on the object at the specified coordinates.
`void`	`useItemOnGroundItem(int x, int y, int itemId, int groundItemId)` Uses the specified item in the inventory on the specified ground item.
`void`	`useItemOnItemBySlot(int slotIndex1, int slotIndex2)` Uses the item at `slot1` on `slot2`.
`void`	`useItemOnNpc(int serverIndex, int itemId)` Uses the specified item on the specified npc.
`void`	`useItemOnPlayer(int slotIndex, int playerServerIndex)` Uses the specified item on the player.
`void`	`useItemOnWall(int x, int y, int slotIndex)` Uses the item at the specified slot on the wall object at the specified coordinates.
`void`	`useItemSlotOnObject(int x, int y, int slotIndex)` Uses the specified item slot on the object at the specified coordinates.
`void`	`useNotedItemOnGroundItem(int x, int y, int itemId, int groundItemId)` Uses the specified noted item in the inventory on the specified ground item.
`void`	`useNotedItemOnNpc(int serverIndex, int itemId)` Uses the specified noted item on the specified npc.
`void`	`useSlotIndexOnGroundItem(int x, int y, int slotIndex, int groundItemId)` Uses the specified item in the inventory on the specified ground item.
`void`	`useUnnotedItemIdOnObject(int x, int y, int itemId)` Uses the specified item id on the object at the specified coordinates.
`void`	`useUnnotedItemOnGroundItem(int x, int y, int itemId, int groundItemId)` Uses the specified unnoted item in the inventory on the specified ground item.
`void`	`useUnnotedItemOnNpc(int serverIndex, int itemId)` Uses the specified unnoted item on the specified npc.
`void`	`waitForAuctionTimer()` Checks if the auction timeout from beginAuctionTimeout is over, and sleeps if it is not over.
`void`	`waitForBatching(boolean checkInventory)` while batching, sleep 1 Game tick.
`void`	`walkDamnit(int x, int y)`
`void`	`walkPath(int[] path)` Walks the specified coordinates path.
`void`	`walkPathReverse(int[] path)` Walks the specified coordinates path, but in reverse.
`void`	`walkTo(int x, int y)` Walks to the specified tile, does not return until at tile, in combat, or a long timeout is reached
`void`	`walkTo(int x, int y, int radius, boolean forced, boolean leaveCombat)` Walks to the specified tile, does not return until at tile or within tile radius, in combat, or a long timeout is reached.
`void`	`walkToAsync(int x, int y, int radius)` Walks to the specified tile, non-blocking.
`void`	`walktoNPC(int npcServerIndex, int radius)` Walks to the specified NPC.
`void`	`walktoNPCAsync(int npcServerIndex)` Walks to the specified NPC.
`boolean`	`walkTowards(int x, int y)` Smartly takes the next step towards any location.
`boolean`	`walkTowardsBank()` Smartly takes the next step towards the nearest bank.
`boolean`	`withdrawItem_apos(int itemId, int amount)` Withdraws a specified amount of an item from the bank.
`boolean`	`withdrawItem(int itemId)` Withdraws one of the specified item from the bank.
`boolean`	`withdrawItem(int itemId, int amount)` Withdraws the specified item, of specified amount, from the bank.
`boolean`	`withdrawItemAsNote(int itemId, int amount)` Withdraws the specified item, as a note, of specified amount, from the bank.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mud
```
public final orsc.mudclient mud
```
  - bankerIds
```
public final int[] bankerIds
```
  - temporaryToggleSideMenu
```
public static boolean temporaryToggleSideMenu
```
  - CTRL_DOWN_MASK
```
public static final int CTRL_DOWN_MASK
```
    See Also:
    
    Constant Field Values
  - SHIFT_DOWN_MASK
```
public static final int SHIFT_DOWN_MASK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Controller
```
public Controller(Reflector _reflector,
                  orsc.OpenRSC _client,
                  orsc.mudclient _mud)
```
- Method Detail
  - isRunning
```
public boolean isRunning()
```
    Returns:
    
    Whether or not a script is currently running.
  - stop
```
public void stop()
```
    Stops the currently running script.
  - sleep
```
public void sleep(int ms)
```
    Parameters:
    
    ms - Sleeps for the specified amount of milliseconds.
  - sleepUntil
```
public boolean sleepUntil(java.util.function.Supplier<java.lang.Boolean> condition)
```
    Suspends the current thread's execution until the provided condition evaluates to true or a 20 second timeout is reached
    
    Parameters:
    
    condition - A Supplier condition that must be met to resume execution.
    
    Returns:
    
    true if the condition was met before the timeout, false if the timeout was reached.
  - sleepUntil
```
public boolean sleepUntil(java.util.function.Supplier<java.lang.Boolean> condition,
                          int timeout)
```
    Suspends the current thread's execution until the provided condition evaluates to true.
    
    Parameters:
    
    condition - A Supplier condition that must be met to resume execution.
    
    timeout - milliseconds before just returning, even if condition is not yet true
    
    Returns:
    
    true if the condition was met before the timeout, false if the timeout was reached.
  - sleepUntilGainedXp
```
public boolean sleepUntilGainedXp()
```
    Suspends the current thread's execution until the player gains exp
    
    Returns:
    
    true if the condition was met before the timeout, false if the timeout was reached.
  - getTotalXp
```
public long getTotalXp()
```
    Returns the total XP by summing up the player experience for each stat.
    
    Returns:
    
    the total XP as a long value
  - getTotalLevel
```
public int getTotalLevel()
```
    Returns the total level by summing up the player level for each stat.
    
    Returns:
    
    the total level as an int value
  - isLoaded
```
public boolean isLoaded()
```
    Whether or not the client is loaded.
    
    Returns:
    
    boolean
  - isLoggedIn
```
public boolean isLoggedIn()
```
    Whether or not the player is currently logged in.
    
    Returns:
    
    boolean
  - typeKey
```
public void typeKey(char key)
```
    Types a single key of the specified char.
    
    Parameters:
    
    key - character
  - chatMessage
```
public void chatMessage(java.lang.String rstext)
```
    Parameters:
    
    rstext - Sends the specified message via chat. You may use @col@ colors here.
  - paste
```
public void paste()
```
    Pastes the contents of the clipboard to the dialog box. You may use @col@ colors here.
  - setFightMode
```
public void setFightMode(int mode)
```
    Parameters:
    
    mode - Sets the fight mode.
  - getFightMode
```
public int getFightMode()
```
    Retrieves the current fight mode set.
    
    Returns:
    
    int -- [0, 3]
  - isItemInInventory
```
public boolean isItemInInventory(int itemId)
```
    Whether or not the specified item id is in the inventory.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    boolean
  - getInventorySlotItemId
```
public int getInventorySlotItemId(int slotIndex)
```
    Retrieves the itemId of the item at the specified `slotIndex`.
    
    Parameters:
    
    slotIndex - int
    
    Returns:
    
    itemId -- returns -1 if no item in slot.
  - getInventoryItemCount
```
public int getInventoryItemCount()
```
    Retrieves the number of items currently in the inventory.
    
    Returns:
    
    int
  - getInventoryItemCount
```
public int getInventoryItemCount(int itemId)
```
    Retrieves the count of the specified item in the inventory. This will include both noted and unnoted items.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    int
  - getUnnotedInventoryItemCount
```
public int getUnnotedInventoryItemCount(int itemId)
```
    Retrieves the count of the specified item that is not noted in the inventory.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    int
  - getNotedInventoryItemCount
```
public int getNotedInventoryItemCount(int itemId)
```
    Retrieves the count of the specified item that is noted in the inventory.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    int
  - getGroundItemsStacked
```
public java.util.List<GroundItemDef> getGroundItemsStacked()
```
    Retrieve a list of items on the ground near the player. Duplicate items on the same tile will be added to the list once, with the actual amount available from the getAmount() method.
    
    Returns:
    
    guaranteed to not be null.
  - getGroundItems
```
public int[] getGroundItems()
```
    Retrieves all itemIds of items on the ground.
    
    Returns:
    
    int[] -- no guarantee on nullability.
  - getGroundItemsCount
```
public int getGroundItemsCount()
```
    Retrieves the count of different item ids on the ground.
    
    Returns:
    
    int
  - getGroundItemsX
```
public int[] getGroundItemsX()
```
    Retrieves an array of X coordinates of ground items.
    
    Returns:
    
    int[] -- no guarantee on nullability.
  - getGroundItemsY
```
public int[] getGroundItemsY()
```
    Retrieves an array of Y coordinates of ground items.
    
    Returns:
    
    int[] -- no guarantee on nullability.
  - getGroundItemsNoted
```
public boolean[] getGroundItemsNoted()
```
    Retrieves an array of whether or not the ground item is noted.
    
    Returns:
    
    boolean[] -- no guarantee on nullability.
  - getGroundItemAmount
```
public int getGroundItemAmount(int itemId,
                               int x,
                               int y)
```
    Retrieves the amount of the item id on the ground at the specified coordinates.
    
    Parameters:
    
    itemId - int
    
    x - int
    
    y - int
    
    Returns:
    
    int -- always returns 0 or greater.
  - getPlayer
```
public orsc.ORSCharacter getPlayer()
```
    Retrieves the ORSCharacter of the local player.
    
    Returns:
    
    ORSCharacter -- no guarantee on nullability.
  - getPlayer
```
public orsc.ORSCharacter getPlayer(int serverIndex)
```
    Retrieves the ORSCharacter of the specified player server index.
    
    Parameters:
    
    serverIndex - int
    
    Returns:
    
    ORSCharacter -- no guarantee on nullability.
  - getPlayers
```
public java.util.List<orsc.ORSCharacter> getPlayers()
```
    Retrieves a list of nearby players.
    
    Returns:
    
    guaranteed to not be null.
  - getPlayerCount
```
public int getPlayerCount()
```
    Retrieves the number of nearby players.
    
    Returns:
    
    int
  - isCurrentlyWalking
```
public boolean isCurrentlyWalking()
```
    Whether or not the player is currently walking.
    
    Returns:
    
    boolean
  - sleepUntilMoving
```
public boolean sleepUntilMoving(long timeout)
```
    Sleeps until the player starts walking
    Good to combine with sleepUntilNotMoving, so you can wait for the player to start responding to your action, then wait for them to finish
    
    Parameters:
    
    timeout - Max ms to wait until moving
    
    Returns:
    
    false if the timeout was reached, true otherwise
  - sleepUntilNotMoving
```
public boolean sleepUntilNotMoving(long timeout)
```
    Sleeps until the player is no longer walking
    Good to combine with sleepUntilMoving, so you can wait for the player to start responding to your action, then wait for them to finish
    
    Parameters:
    
    timeout - Max ms to wait to stop moving
    
    Returns:
    
    false if the timeout was reached, true otherwise
  - isPlayerCurrentlyWalking
```
public boolean isPlayerCurrentlyWalking(int serverIndex)
```
    Determines if the player is currently walking.
    
    Parameters:
    
    serverIndex - the index of the player on the server
    
    Returns:
    
    true if the player is currently walking, false otherwise
  - isNpcCurrentlyWalking
```
public boolean isNpcCurrentlyWalking(int serverIndex)
```
    Checks if an NPC is currently walking.
    
    Parameters:
    
    serverIndex - the server index of the NPC
    
    Returns:
    
    true if the NPC is currently walking, false otherwise
  - getDistanceFromLocalPlayer
```
public int getDistanceFromLocalPlayer(int coordX,
                                      int coordY)
```
    Retrieves the distance of the coordinates from the player.
    
    Parameters:
    
    coordX - int
    
    coordY - int
    
    Returns:
    
    int
  - currentX
```
public int currentX()
```
    Retrieves the current X coordinates of the player.
    This occasionally returns incorrect values while Underground
    
    Returns:
    
    int
  - currentY
```
public int currentY()
```
    Retrieves the current Y coordinates of the player.
    This occasionally returns incorrect values while Underground
    
    Returns:
    
    int
  - walkTo
```
public void walkTo(int x,
                   int y)
```
    Walks to the specified tile, does not return until at tile, in combat, or a long timeout is reached
    
    Parameters:
    
    x - int
    
    y - int
  - walkTo
```
public void walkTo(int x,
                   int y,
                   int radius,
                   boolean forced,
                   boolean leaveCombat)
```
    Walks to the specified tile, does not return until at tile or within tile radius, in combat, or a long timeout is reached. Note: when walking to the same tile as current tile the walkTo will not be called. If walking to same tile to leaving combat, ensure leaveCombat boolean is true.
    
    Parameters:
    
    x - int
    
    y - int
    
    radius - int
    
    leaveCombat - boolean - true if bot should keep trying walkTo while in combat
    
    forced - boolean - true if attempt to walkTo should be made reguardless of conditions
  - walkDamnit
```
public void walkDamnit(int x,
                       int y)
```
  - walkToAsync
```
public void walkToAsync(int x,
                        int y,
                        int radius)
```
    Walks to the specified tile, non-blocking.
    
    Parameters:
    
    x - int
    
    y - int
    
    radius - int
  - walkTowards
```
public boolean walkTowards(int x,
                           int y)
```
    Smartly takes the next step towards any location. Handles obstacles, ladders, gates, doors, etc.
    It is a _bug_ if it cannot walk from any location to any location!
    If it's not getting to your desired location, please update the graph.txt using the GUI program here - https://github.com/dginovker/Runescape-Classic-Webwalker
    If this function cannot walk to a certain location, please use the above link to add support!
    Note - If you have enough coins in your inventory, this function may use them for boat/gate fees! Note - This might not take the most efficient path, but it will be reasonably efficient
    
    Parameters:
    
    x - Destination x
    
    y - Desination y
    
    Returns:
    
    Whether or not we successfully walked towards the destination
  - walkTowardsBank
```
public boolean walkTowardsBank()
```
    Smartly takes the next step towards the nearest bank. It considers obstacles, ladders, gates, doors, etc., and aims to find a path using the web walking algorithm.
    If unable to reach any bank, it suggests updating the graph with the GUI tool available at https://github.com/dginovker/Runescape-Classic-Webwalker.
    Note: If sufficient coins are available, it may use them for boat/gate fees. While not guaranteed to take the most efficient path, it seeks to be reasonably efficient.
    
    Returns:
    
    Whether or not the step towards the nearest bank was successfully taken.
  - getWebWalker
```
public WebWalker getWebWalker()
```
    Returns controllers instance of WebWalker.
    
    Returns:
    
    WebWalker
  - isTileEmpty
```
public boolean isTileEmpty(int x,
                           int y)
```
    Whether or not the specified tile has an object at it.
    
    Parameters:
    
    x - int
    
    y - int
    
    Returns:
    
    boolean
  - getNearestObjectById
```
public int[] getNearestObjectById(int objectId)
```
    Retrieves the coordinates of the nearest specified object ID, if nearby.
    
    Parameters:
    
    objectId - The ID of the object to find.
    
    Returns:
    
    int[] The coordinates [x, y] of the nearest object, or null if no such object is nearby.
  - getNearestReachableObjectById
```
public int[] getNearestReachableObjectById(int objectId,
                                           boolean includeTileEdges)
```
    Retrieves the coordinates of the nearest specified object ID, if nearby and reachable.
    
    Parameters:
    
    objectId - The ID of the object to find.
    
    includeTileEdges - -- whether or not the edges of the tile are permitted. Such as picking up an item on a table -- you can't walk on top of the table, but you can reach the edges.
    
    Returns:
    
    int[] The coordinates [x, y] of the nearest reachable object, or null if no such object is nearby and reachable.
  - getNearestReachableObjectByIds
```
public int[] getNearestReachableObjectByIds(int[] objectIds,
                                            boolean includeTileEdges)
```
    Retrieves the coordinates of the nearest specified objects by their IDs, if any are nearby and reachable.
    
    Parameters:
    
    objectIds - The array of IDs of the objects to find.
    
    includeTileEdges - -- whether or not the edges of the tile are permitted.
    
    Returns:
    
    int[] The coordinates [x, y] of the nearest reachable object among the given IDs, or null if no such objects are nearby and reachable.
  - getObjectsById
```
public int[][] getObjectsById(int objectId)
```
    Retrieves all the coordinates of the nearby object ID
    This method returns an array of coordinate pairs for each instance of the object with the given ID that is nearby.
    
    Parameters:
    
    objectId - The ID of the objects to retrieve.
    
    Returns:
    
    int[][] An array of [x, y] coordinates for each object found. Returns an empty array if no objects are found.
  - getNearestObjectByIds
```
public int[] getNearestObjectByIds(int[] objectIds)
```
    Finds the nearest object coordinates based on the given object IDs.
    
    Parameters:
    
    objectIds - an array of object IDs
    
    Returns:
    
    an array containing the coordinates of the nearest object
  - atObject
```
public boolean atObject(SceneryId id)
```
    Performs the primary command option on the nearest reachable scenery ID
    
    Parameters:
    
    id - scenery ID
    
    Returns:
    
    boolean -- returns true if we interacted successfully
  - atObject
```
public boolean atObject(int id)
```
    Performs the primary command option on the nearest reachable objectId
    
    Parameters:
    
    id - int
    
    Returns:
    
    boolean -- returns true if we interacted successfully
  - atObject2
```
public boolean atObject2(int id)
```
    Performs the second command option on the nearest reachable objectId
    
    Parameters:
    
    id - int
    
    Returns:
    
    boolean -- returns true if we interacted successfully
  - atObject
```
public boolean atObject(int x,
                        int y)
```
    Performs the primary command option on the specified object id at the specified coordinates.
    
    Parameters:
    
    x - int
    
    y - int
    
    Returns:
    
    boolean -- returns false if no object at those coordinates.
  - atObject2
```
public boolean atObject2(int x,
                         int y)
```
    Performs the 2nd command option on the specified object id at the specified coordinates.
    
    Parameters:
    
    x - int
    
    y - int
    
    Returns:
    
    boolean -- returns false if no object at those coordinates.
  - isCloseToCoord
```
public boolean isCloseToCoord(int x,
                              int y)
```
    Whether or not you are within 1 tile of the specified coordinates.
    
    Parameters:
    
    x - int
    
    y - int
    
    Returns:
    
    boolean
  - getObjects
```
public java.util.List<com.openrsc.client.entityhandling.defs.GameObjectDef> getObjects()
```
    Retrieves a list of nearby objects.
    
    Returns:
    
    guaranteed to not be null.
  - getObjectsCount
```
public int getObjectsCount()
```
    Retrieves the count of objects nearby.
    
    Returns:
    
    int
  - getObjectsIds
```
public int[] getObjectsIds()
```
    Retrieves the IDs of objects nearby.
    
    Returns:
    
    int[] -- no guarantee on nullability.
  - getObjectsX
```
public int[] getObjectsX()
```
    Retrieves an array of all of the X coordinates of nearby objects.
    
    Returns:
    
    int[] -- no guarantee on nullability.
  - getObjectsZ
```
public int[] getObjectsZ()
```
    Retrieves an array of all of the Z coordinates of nearby objects.
    
    Returns:
    
    int[] -- no guarantee on nullability.
  - getNpcs
```
public java.util.List<orsc.ORSCharacter> getNpcs()
```
    Retrieves a list of NPCs nearby.
    
    Returns:
    
    guaranteed to not be null.
  - getNpcsAsArray
```
public orsc.ORSCharacter[] getNpcsAsArray()
```
    Retrieves ORSCharacter[] array of NPCs nearby.
    
    Returns:
    
    guaranteed to not be null.
  - getNpcsAsIntArray
```
public int[] getNpcsAsIntArray()
```
    Retrieves int[] array of NPCs nearby.
    
    Returns:
    
    guaranteed to not be null.
  - getNpcCount
```
public int getNpcCount()
```
    Retrieves the count of NPCs nearby.
    
    Returns:
    
    int
  - getWallObjects
```
public java.util.List<com.openrsc.client.entityhandling.defs.DoorDef> getWallObjects()
```
    Retrieves a list of wall objects nearby.
    
    Returns:
    
    guaranteed to not be null.
  - getWallObjectIds
```
public int[] getWallObjectIds()
```
    Retrieves an array of all wall object IDs nearby.
    
    Returns:
    
    int[] -- no guarantee on nullability
  - getWallObjectsCount
```
public int getWallObjectsCount()
```
    Retrieves the count of wall objects nearby.
    
    Returns:
    
    int
  - getWallObjectsX
```
public int[] getWallObjectsX()
```
    Retrieves an array of all of the X coordinates of nearby wall objects.
    
    Returns:
    
    int[] -- no guarantee on nullability.
  - getWallObjectsZ
```
public int[] getWallObjectsZ()
```
    Retrieves an array of all of the Z coordinates of nearby wall objects.
    
    Returns:
    
    int[] -- no guarantee on nullability.
  - getWallObjectsDirections
```
public int[] getWallObjectsDirections()
```
  - getNearestWallObjectById
```
public int[] getNearestWallObjectById(int wallObjectId)
```
    Retrieves the coordinates of the specified wall object id, if nearby.
    
    Parameters:
    
    wallObjectId - int
    
    Returns:
    
    int[] -- [x, y]. returns null if no wall object nearby.
  - getNearestNpcByIds
```
public orsc.ORSCharacter getNearestNpcByIds(int[] npcIds,
                                            boolean inCombatAllowed)
```
    Retrieves the character object of the nearest NPC specified in the list of ids.
    
    Parameters:
    
    npcIds - int
    
    inCombatAllowed - -- whether or not to return NPCs which are currently engaged in combat.
    
    Returns:
    
    orsc.ORSCharacter -- returns null if npc not present.
  - getNearestNPCByLambda
```
public orsc.ORSCharacter getNearestNPCByLambda(java.util.function.Predicate<orsc.ORSCharacter> condition)
```
    Retrieves the character object of the nearest NPC that satisfies the condition
    
    Parameters:
    
    condition - - Condition the NPC must satisfy
    
    Returns:
    
    orsc.ORSCharacter -- returns null if npc not present.
  - getAllNpcsById
```
public int[][] getAllNpcsById(int[] npcIds,
                              boolean inCombatAllowed)
```
    Method to make a 2D array with all [x,y,npcId] positions of the supplied npcIds[] array
    Other methods only return the closest npc, this will return all of them in a nx3 matrix
    
    Parameters:
    
    npcIds - int[n] of npcIds you would like to search for
    
    inCombatAllowed - boolean if in-combat npcs should be recorded
    
    Returns:
    
    int[n][3] 2D array of x,y,npcId values for the supplied npc Ids
  - getNearestNpcById
```
public orsc.ORSCharacter getNearestNpcById(int npcId,
                                           boolean inCombatAllowed)
```
    Retrieves the character object of the nearest npc.
    
    Parameters:
    
    npcId - int
    
    inCombatAllowed - -- whether or not to return NPCs which are currently engaged in combat.
    
    Returns:
    
    orsc.ORSCharacter -- returns null if NPC not present.
  - getNpcCoordsByServerIndex
```
public int[] getNpcCoordsByServerIndex(int serverIndex)
```
    Retrieves the coordinates of the specified NPC.
    
    Parameters:
    
    serverIndex - int
    
    Returns:
    
    int[] -- [x, y]. Returns [-1, -1] on no NPC present.
  - getNpc
```
public orsc.ORSCharacter getNpc(int serverIndex)
```
    Creates an NPC character object based on the server index provided.
    
    Parameters:
    
    serverIndex - the server index of the NPC (see get
    
    Returns:
    
    the NPC character with the specified server index, or null if not found
  - walktoNPCAsync
```
public void walktoNPCAsync(int npcServerIndex)
```
    Walks to the specified NPC. This function is non-blocking.
    
    Parameters:
    
    npcServerIndex - int
  - walktoNPC
```
public void walktoNPC(int npcServerIndex,
                      int radius)
```
    Walks to the specified NPC.
    
    Parameters:
    
    npcServerIndex - int
    
    radius - -- must be 0 or greater.
  - attackNpc
```
public void attackNpc(int npcServerIndex)
```
    Attacks the specified NPC.
    
    Parameters:
    
    npcServerIndex - int
  - castSpellOnNpc
```
public void castSpellOnNpc(int serverIndex,
                           int spellId)
```
    Casts the specified spell on the specified npc.
    
    Parameters:
    
    serverIndex - int
    
    spellId - int
  - useItemOnNpc
```
public void useItemOnNpc(int serverIndex,
                         int itemId)
```
    Uses the specified item on the specified npc. This will use the first item, regardless of whether it is unnoted or not.
    
    Parameters:
    
    serverIndex - int
    
    itemId - int
  - useUnnotedItemOnNpc
```
public void useUnnotedItemOnNpc(int serverIndex,
                                int itemId)
```
    Uses the specified unnoted item on the specified npc.
    
    Parameters:
    
    serverIndex - int
    
    itemId - int
  - useNotedItemOnNpc
```
public void useNotedItemOnNpc(int serverIndex,
                              int itemId)
```
    Uses the specified noted item on the specified npc.
    
    Parameters:
    
    serverIndex - int
    
    itemId - int
  - useItemSlotOnObject
```
public void useItemSlotOnObject(int x,
                                int y,
                                int slotIndex)
```
    Uses the specified item slot on the object at the specified coordinates. Note that this uses a slot id, not an item id.
    This is primarily used to interact with an object, such as using an axe with a tree. For tasks like opening locked doors try using "c.useItemOnWall(int x, int y, int slotIndex)" instead
    
    Parameters:
    
    x - int
    
    y - int
    
    slotIndex - int
  - useItemIdOnObject
```
public void useItemIdOnObject(int x,
                              int y,
                              int itemId)
```
    Uses the specified item id on the object at the specified coordinates.
    This is primarily used to interact with an object, such as using an axe with a tree. For tasks like opening locked doors try using "c.useItemOnWall(int x, int y, int slotIndex)" instead
    
    Parameters:
    
    x - int
    
    y - int
    
    itemId - int
  - useUnnotedItemIdOnObject
```
public void useUnnotedItemIdOnObject(int x,
                                     int y,
                                     int itemId)
```
    Uses the specified item id on the object at the specified coordinates.
    This is primarily used to interact with an object, such as using an axe with a tree. For tasks like opening locked doors try using "c.useItemOnWall(int x, int y, int slotIndex)" instead
    
    Parameters:
    
    x - int
    
    y - int
    
    itemId - int
  - useItemOnWall
```
public void useItemOnWall(int x,
                          int y,
                          int slotIndex)
```
    Uses the item at the specified slot on the wall object at the specified coordinates. Note that this uses a slot id, not item id.
    
    Parameters:
    
    x - int
    
    y - int
    
    slotIndex - int
  - thieveNpc
```
public void thieveNpc(int serverIndex)
```
    Thieves the NPC.
    
    Parameters:
    
    serverIndex - int
  - npcCommand1
```
public void npcCommand1(int serverIndex)
```
    Walks to the NPC and select the 1st command option.
    
    Parameters:
    
    serverIndex - int
  - npcCommand2
```
public void npcCommand2(int serverIndex)
```
    Walks to the NPC and select the 2nd command option.
    
    Parameters:
    
    serverIndex - int
  - isNpcInCombat
```
public boolean isNpcInCombat(int serverIndex)
```
    Whether or not the specified npc is in combat.
    
    Parameters:
    
    serverIndex - int
    
    Returns:
    
    boolean -- returns true if in combat. Returns false if not in combat, or if server index not found.
  - isDoorOpen
```
public boolean isDoorOpen(int x,
                          int y)
```
    Whether or not the door at the specified coordinates is open.
    
    Parameters:
    
    x - int
    
    y - int
    
    Returns:
    
    boolean
  - getNearbyClosedDoors
```
public int[][] getNearbyClosedDoors(int radius)
```
    Returns an int[][] of closed door coordinates
    
    Parameters:
    
    radius - int -- Radius to check for doors
    
    Returns:
    
    int[][] -- Door coordinates
  - isNearbyDoorClosed
```
public boolean isNearbyDoorClosed(int radius)
```
    Checks in the radius for a closed door
    
    Parameters:
    
    radius - int -- Radius to check
    
    Returns:
    
    boolean -- If a closed door was found
  - getWallObjectIdAtCoord
```
public int getWallObjectIdAtCoord(int x,
                                  int y)
```
    Retrieves the id of the wall object at the specified coordinates.
    
    Parameters:
    
    x - int
    
    y - int
    
    Returns:
    
    int -- returns -1 if no wall object present.
  - getWallObjectDirectionAtCoord
```
public int getWallObjectDirectionAtCoord(int x,
                                         int y)
```
    Returns the direction of the wall object.
    
    Parameters:
    
    x - int
    
    y - int
    
    Returns:
    
    int
  - openDoor
```
public void openDoor(int x,
                     int y)
```
    Opens the door at the specified coordinates. Does nothing if the door is already open.
    
    Parameters:
    
    x - int
    
    y - int
  - closeDoor
```
public void closeDoor(int x,
                      int y)
```
    Closes the door at the specified coordinates. Does nothing if the door is already closed.
    
    Parameters:
    
    x - int
    
    y - int
  - isItemAtCoord
```
public boolean isItemAtCoord(int x,
                             int y,
                             int itemId)
```
    Whether or not the specified item is present at the specified coordinates.
    
    Parameters:
    
    x - int
    
    y - int
    
    itemId - int
    
    Returns:
    
    boolean
  - getNearestItemById
```
public int[] getNearestItemById(int itemId)
```
    Retrieves the coordinates of the nearest specified item within the given distance, if on the ground
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    int[] -- [x, y]. Returns null if item not found.
  - getNearestItemById
```
public int[] getNearestItemById(int itemId,
                                int maxDistance)
```
    Retrieves the coordinates of the specified item, if on the ground.
    
    Parameters:
    
    itemId - int
    
    maxDistance - Maximum distance to bother checking
    
    Returns:
    
    int[] -- [x, y]. Returns null if item not found.
  - getNearestItemByIds
```
public int[] getNearestItemByIds(int[] itemIds)
```
    Retrieves the coordinates of the specified items, if on the ground.
    
    Parameters:
    
    itemIds - int
    
    Returns:
    
    int[] -- [x, y, itemId]. Returns null if no items found.
  - pickupItem
```
public void pickupItem(int x,
                       int y,
                       int itemId,
                       boolean unused,
                       boolean async)
```
    Picks up the item at the specified coordinates.
    
    Parameters:
    
    x - int
    
    y - int
    
    itemId - int
    
    unused -
    
    async - -- whether or not to block when walking to the item. If set to true, it will keep attempting to walk to the item, until it is close enough to pick it up.
  - pickupItem
```
public boolean pickupItem(int itemId)
```
    Picks up the nearest reachable item with id itemId
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    true if the item was found
  - itemCommand
```
public boolean itemCommand(int itemId)
```
    Uses the command option on the specified item id.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    boolean -- returns true on success. returns false if the item is not in the inventory.
  - itemCommandBySlot
```
public void itemCommandBySlot(int slotIndex)
```
    Uses the command option on the item at the specified slot id. Note that this does not use item ids, but slot ids.
    
    Parameters:
    
    slotIndex - int
  - useItemOnItemBySlot
```
public void useItemOnItemBySlot(int slotIndex1,
                                int slotIndex2)
```
    Uses the item at `slot1` on `slot2`. Note that this does not use item ids, but slot ids.
    
    Parameters:
    
    slotIndex1 - int
    
    slotIndex2 - int
  - getUnnotedInventoryItemSlotIndex
```
public int getUnnotedInventoryItemSlotIndex(int itemId)
```
    Retrieves the slot id of the specified unnoted item id.
    
    Parameters:
    
    itemId - -- returns -1 if item not in inventory.
    
    Returns:
    
    int
  - getNotedInventoryItemSlotIndex
```
public int getNotedInventoryItemSlotIndex(int itemId)
```
    Retrieves the slot id of the specified noted item id.
    
    Parameters:
    
    itemId - -- returns -1 if item not in inventory.
    
    Returns:
    
    int
  - getInventoryItemSlotIndex
```
public int getInventoryItemSlotIndex(int itemId)
```
    Retrieves the slot id of the specified item id. This will return the first occurrence of the id, regardless of if the item is unnoted or noted.
    
    Parameters:
    
    itemId - -- returns -1 if item not in inventory.
    
    Returns:
    
    int
  - dropItem
```
public void dropItem(int slotIndex)
```
    Drops one the specified item at the specified item slot. Note that this does not use an item id, but a slot index.
    
    Parameters:
    
    slotIndex - int
  - dropItem
```
public void dropItem(int slotIndex,
                     int amount)
```
    Drops the specified item at the specified item slot, of specified amount. Note that this does not use an item id, but a slot index.
    
    Parameters:
    
    slotIndex - int
    
    amount - int
  - getEquippedItemId
```
public int getEquippedItemId(int slotIndex)
```
    return a int item id that is equipped in the provided slot index
    
    Returns:
    
    int of Item Id in provided slot Index
  - getEquippedItemIds
```
public int[] getEquippedItemIds()
```
    return a list of all item ids that are equipped
    
    Returns:
    
    int[] of Item Ids (trimmed)
  - isEquipped
```
public boolean isEquipped(int slotIndex)
```
    Whether or not the specified item slot is equipped. Note that this does not use an item id, but a slot index.
    
    Parameters:
    
    slotIndex - int
    
    Returns:
    
    boolean
  - isItemIdEquipped
```
public boolean isItemIdEquipped(int itemId)
```
    Whether or not the specified item ID is equipped. This is different from Controller.isEquipped due to Coleslaw allowing for you to wield items outside the inventory. It functions as expected on Uranium.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    boolean
  - equipItem
```
public void equipItem(int slotIndex)
```
    Equips the item in the specified slot. Note that this does not use an item id, but a slot index.
    
    Parameters:
    
    slotIndex - int
  - equipItemById
```
public void equipItemById(int id)
```
    Equipts an item by ID. The item must be in your inventory
    
    Parameters:
    
    id - the ID of the item to equip
  - unequipItem
```
public void unequipItem(int slotIndex)
```
    Unequips the item in the specified slot. Note that this does not use an item id, but a slot index.
    
    Parameters:
    
    slotIndex - int
  - createAccount
```
public void createAccount(java.lang.String email)
```
    Creates the specified account provided in the command line with the specified email.
    
    Parameters:
    
    email - String
  - createAccount
```
public void createAccount(java.lang.String email,
                          java.lang.String username,
                          java.lang.String password)
```
    Creates the specified account on the server.
    
    Parameters:
    
    email - String
    
    username - String
    
    password - String
  - login
```
public void login()
```
    Attempts in using the credentials specified in the command line.
  - getFatigue
```
public int getFatigue()
```
    Retrieves the current fatigue. Returns 0 on Coleslaw.
    
    Returns:
    
    int -- as a percentage [0, 100].
  - getFatigueDuringSleep
```
public int getFatigueDuringSleep()
```
    Retrieves the current fatigue status while sleeping.
    
    Returns:
    
    int -- as a percentage [0, 100]
  - isInCombat
```
public boolean isInCombat()
```
    Whether or not the player is currently in combat.
    
    Returns:
    
    boolean
  - isPlayerInCombat
```
public boolean isPlayerInCombat(int playerIndex)
```
    Whether or not the specified player index is in combat.
    
    Parameters:
    
    playerIndex - int
    
    Returns:
    
    boolean -- returns true if in combat. returns false if not in combat, or if player index is non-existent.
  - isInOptionMenu
```
public boolean isInOptionMenu()
```
    Whether or not an NPC/action option menu is currently presented to the player.
    
    Returns:
    
    boolean
  - getOptionMenuCount
```
public int getOptionMenuCount()
```
    Retrieves the amount of options currently presented to the user.
    
    Returns:
    
    int
  - getOptionsMenuText
```
public java.lang.String getOptionsMenuText(int i)
```
    Retrieves the text of the specified option index when talking to an NPC or performing an action.
    
    Parameters:
    
    i - zero-indexed option (i.e first option is 0, second option is 1, etc..)
    
    Returns:
    
    String -- null if option does not exist, or if quest menu is not up.
  - getOptionsMenuText
```
public java.lang.String[] getOptionsMenuText()
```
    Retrieves the array of options inside of an option menu.
    
    Returns:
    
    String[]
  - optionAnswer
```
public void optionAnswer(int answerIndex)
```
    Selects an option menu when talking to an NPC or performing an action.
    
    Parameters:
    
    answerIndex - -- the index of the answer, starting at 0.
  - talkToNpc
```
public boolean talkToNpc(int serverIndex)
```
    Talks to the specified npc server index.
    
    Parameters:
    
    serverIndex - int
    
    Returns:
    
    true -- true if request to talk sent, false if server index is invalid.
  - talkToNpcId
```
public boolean talkToNpcId(int npcId,
                           boolean waitUntilInDialog)
```
    Talks to the specified npc by ID.
    
    Parameters:
    
    npcId - int
    
    waitUntilInDialog - boolean -- whether to wait until the dialog is opened before returning
    
    Returns:
    
    true -- true if request to talk sent, false if we couldn't find the NPC or we timed out waiting for the dialog
  - isInBank
```
public boolean isInBank()
```
    Whether or not the bank window is currently open.
    
    Returns:
    
    boolean
  - closeBank
```
public void closeBank()
```
    Closes the bank window. No effect if window is not currently open.
  - getBankItems
```
public java.util.List<com.openrsc.client.entityhandling.instances.Item> getBankItems()
```
    Retrieves a list of all the items inside the bank.
    
    Returns:
    
    guaranteed to not be null.
  - getBankItemsCount
```
public int getBankItemsCount()
```
    Retrieves the total count of all items in the bank.
    
    Returns:
    
    int
  - getBankItemCount
```
public int getBankItemCount(int itemId)
```
    Retrieves the amount of the item in the bank.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    int -- returns -1 if bank was not opened this session.
  - getAccountValue
```
public long getAccountValue()
```
    Retrieves the estimated value of everything in your inventory and bank
    
    Returns:
    
    -1 if the bank has not been opened this session, otherwise the sum of all item values
  - isItemInBank
```
public boolean isItemInBank(int itemId)
```
    Whether or not the specified item ID is in the bank.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    boolean -- true if item is in the bank. Returns false if item not present or bank is not open.
  - depositAll
```
public boolean depositAll()
```
    Deposits all yo stuff in the bank
    
    Returns:
    
    true if we were in the bank
  - depositItem
```
public boolean depositItem(int itemId)
```
    Deposits one of specified item into the bank.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    boolean -- returns true on success. Returns false if you do not have that item in your inventory, or if the bank is not open.
  - depositItem
```
public boolean depositItem(int itemId,
                           int amount)
```
    Deposits the specified item, of specified amount, into the bank.
    
    Parameters:
    
    itemId - int
    
    amount - int
    
    Returns:
    
    boolean -- returns true on success. Returns false if you do not have that item in your inventory, or if the bank is not open.
  - withdrawItem
```
public boolean withdrawItem(int itemId)
```
    Withdraws one of the specified item from the bank.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    boolean -- returns true if you already have one or more of those items in your inventory. Returns false if you currently do not have that amount, or if you do not have the bank open.
  - withdrawItem
```
public boolean withdrawItem(int itemId,
                            int amount)
```
    Withdraws the specified item, of specified amount, from the bank.
    
    Parameters:
    
    itemId - int
    
    amount - int
    
    Returns:
    
    boolean -- returns true if you already have that amount in your inventory. Returns false if you do not currently have that amount, or if you do not have the bank open.
  - withdrawItem_apos
```
public boolean withdrawItem_apos(int itemId,
                                 int amount)
```
    Withdraws a specified amount of an item from the bank. (APOS compatibility method)
    
    Parameters:
    
    itemId - the ID of the item to be withdrawn
    
    amount - the amount of the item to be withdrawn
    
    Returns:
    
    true if the withdrawal was successful, false otherwise
  - withdrawItemAsNote
```
public boolean withdrawItemAsNote(int itemId,
                                  int amount)
```
    Withdraws the specified item, as a note, of specified amount, from the bank. Only works on Coleslaw.
    
    Parameters:
    
    itemId - int
    
    amount - int
    
    Returns:
    
    boolean -- returns true if you already have that amount in your inventory. Returns false if you do not currently have that amount, or if you do not have the bank open.
  - displayMessage
```
public void displayMessage(java.lang.String rstext,
                           int type)
```
    Displays a message in the client chat window, of the specified MessageType.
    EXAMPLE(int type, "default @color code@")
    GAME(0, "@whi@")
    PRIVATE_RECEIVE(1, "@cya@")
    PRIVATE_SEND(2, "@cya@")
    QUEST(3, "@whi@")
    CHAT(4, "@yel@")
    FRIEND_STATUS(5, "@cya@")
    TRADE(6, "@whi@")
    INVENTORY(7, "@whi@")
    GLOBAL_CHAT(8, "@yel@")
    CLAN_CHAT(9, "@yel@")
    
    Parameters:
    
    rstext - -- you may use @col@ colors here.
  - displayMessage
```
public void displayMessage(java.lang.String rstext)
```
    Displays a message in the client chat window.
    
    Parameters:
    
    rstext - -- you may use @col@ colors here.
  - distance
```
public int distance(int x1,
                    int y1,
                    int x2,
                    int y2)
```
    Retrieves the distance between two tiles.
    
    Parameters:
    
    x1 - int
    
    y1 - int
    
    x2 - int
    
    y2 - int
    
    Returns:
    
    int
  - distanceTo
```
public int distanceTo(int x,
                      int y)
```
  - offsetX
```
public int offsetX(int x)
```
    Converts local region coordinates to global coordinates.
    
    Parameters:
    
    x - int
    
    Returns:
    
    int
  - offsetZ
```
public int offsetZ(int z)
```
    Converts local region coordinates to global coordinates.
    
    Parameters:
    
    z - int
    
    Returns:
    
    int
  - removeOffsetX
```
public int removeOffsetX(int x)
```
    Converts global coordinates to local region coordinates.
    
    Parameters:
    
    x - int
    
    Returns:
    
    int
  - removeOffsetZ
```
public int removeOffsetZ(int z)
```
    Converts global coordinates to local region coordinates.
    
    Parameters:
    
    z - int
    
    Returns:
    
    int
  - convertX
```
public int convertX(int x)
```
    Converts player/NPC coordinates to local region coordinates to global coordinates.
    
    Parameters:
    
    x - int
    
    Returns:
    
    int
  - convertZ
```
public int convertZ(int z)
```
    Converts player/NPC coordinates to local region coordinates to global coordinates.
    
    Parameters:
    
    z - int
    
    Returns:
    
    int
  - resizeWindow
```
public void resizeWindow(int width,
                         int height)
```
    Resizes the client applet window.
    
    Parameters:
    
    width - int
    
    height - int
  - takeScreenshot
```
public boolean takeScreenshot(java.lang.String fileName)
```
    Takes a screenshot of the client applet and saves a bitmap as the specified filename.
    
    Parameters:
    
    fileName - String
    
    Returns:
    
    boolean -- returns true on success. Returns false if image could not be saved.
  - getItemCommand
```
public java.lang.String getItemCommand(int itemId)
```
    Retrieves the command of the specified item.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    String -- guaranteed to not be null.
  - getItemExamineText
```
public java.lang.String getItemExamineText(int itemId)
```
    Retrieves the examine text of the specified item.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    String -- guaranteed to not be null.
  - isItemTradeable
```
public boolean isItemTradeable(int itemId)
```
    Retrieves whether or not the item is tradeable.
    
    Parameters:
    
    itemId - int
  - isItemNotable
```
public boolean isItemNotable(int itemId)
```
    Retrieves whether or not the item is notable.
    
    Parameters:
    
    itemId - int
  - getItemName
```
public java.lang.String getItemName(int itemId)
```
    Retrieves the name of the specified item.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    String -- guaranteed to not be null.
  - getItemId
```
public int getItemId(java.lang.String itemName)
```
    Retrieves the item id of the specified item name.
    
    Parameters:
    
    itemName - String
    
    Returns:
    
    int -- returns -1 if item does not exist
  - isItemWearable
```
public boolean isItemWearable(int itemId)
```
    Whether or not the specified item is a wearable item.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    boolean
  - isItemStackable
```
public boolean isItemStackable(int itemId)
```
    Whether or not the specified item is a stackable item.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    boolean
  - setServerMessage
```
public void setServerMessage(java.lang.String msg,
                             boolean largeBox,
                             boolean show)
```
    Sets the current server message window text.
    
    Parameters:
    
    msg - String
    
    largeBox - boolean
    
    show - boolean
  - closeServerMessage
```
public void closeServerMessage()
```
    Closes the current server message popup window.
  - getServerMessage
```
public java.lang.String getServerMessage()
```
    Retrieves the current server message popup window text.
    
    Returns:
    
    String -- no guarantee on nullability.
  - getSpellIdFromName
```
public int getSpellIdFromName(java.lang.String name)
```
    Retrieves the spellId of the spell name. (0,1,2,3,4,etc)
    
    Parameters:
    
    name - -- must match spelling of the spell book. case insensitive.
    
    Returns:
    
    int -- -1 if spell not found.
  - castSpellOnObject
```
public void castSpellOnObject(int spellId,
                              int x,
                              int y)
```
    Casts the specified spell on the object at the specified coordinates.
    
    Parameters:
    
    spellId - int
    
    x - int
    
    y - int
  - stopBatching
```
public void stopBatching()
```
    Sends a packet to the server to stop batching and sleeps until it has stopped.
  - isInAuctionHouse
```
public boolean isInAuctionHouse()
```
    Check if the player is in an auction house and not at the disallowed one on Karamja
    
    Returns:
    
    boolean -- If the player is in an allowed auction house
  - closeAuctionHouse
```
public void closeAuctionHouse()
```
    Closes the Auction House window
  - openAuctionHouse
```
public void openAuctionHouse()
```
    Uses npcCommand1 to open the auction house on the nearest clerk
  - auctionBuy
```
public void auctionBuy(AuctionItem auction,
                       int itemAmount)
```
    Buys an amount of items from a given auction id.
    
    Parameters:
    
    auction - AuctionItem -- Auction to buy from
    
    itemAmount - int -- Amount of items to buy
  - auctionBuyAll
```
public void auctionBuyAll(AuctionItem auction)
```
    This method can potentially use all of your carried coins so be cautious when using it.
    
    Attempts to buy all items from the given AuctionItem.
    
    Parameters:
    
    auction - AuctionItem -- The auction to buy from.
  - auctionCreate
```
public void auctionCreate(int itemId,
                          int itemAmount,
                          int pricePerItem)
```
    Lists an amount of itemId for a specified price in the auction house. If the amount is greater than the amount in the inventory it will list all in inventory.
    
    Parameters:
    
    itemId - int -- Item id
    
    itemAmount - int -- Amount of item
    
    pricePerItem - int -- Price to sell each item at
  - auctionCancel
```
public void auctionCancel(AuctionItem auction)
```
    Cancels an auction. This only works if the auction is owned by the current player.
    
    Parameters:
    
    auction - AuctionItem -- Auction Id
  - auctionRefresh
```
public void auctionRefresh()
```
    Refreshes the Auction House listings.
  - auctionSearchForItemId
```
public java.util.ArrayList<AuctionItem> auctionSearchForItemId(int itemId)
```
    Returns an ArrayList of AuctionItems for a given item id.
    
    Parameters:
    
    itemId - int -- Item id to search for.
    
    Returns:
    
    ArrayList -- Items that match the item id
  - auctionSearchCheapestOfItemId
```
public AuctionItem auctionSearchCheapestOfItemId(int itemId)
```
    Returns an AuctionItem with the cheapest price per item for an item id.
    
    Parameters:
    
    itemId - int -- Item id to search for
    
    Returns:
    
    AuctionItem -- Cheapest AuctionItem of the requested itemId
  - getMyAuctions
```
public java.util.ArrayList<AuctionItem> getMyAuctions()
```
    Returns an ArrayList of auctions for sale by the current player
    
    Returns:
    
    ArrayList
  - getPlayerAuctions
```
public java.util.ArrayList<AuctionItem> getPlayerAuctions(java.lang.String playerName)
```
    Returns an ArrayList of auctions for sale by a specified player
    
    Parameters:
    
    playerName - String -- Player name to search for
    
    Returns:
  - getAuctions
```
public java.util.ArrayList<AuctionItem> getAuctions()
```
    Returns an ArrayList of AuctionItems after checking and waiting for the auction timeout to finish.
    
    Returns:
    
    ArrayList -- List of auctions
  - beginAuctionTimeout
```
public void beginAuctionTimeout()
```
    The auction house requires a minimum of 5 seconds between each interaction. This method sets a timeout to 5.5 seconds to make sure nothing strange happens.
  - waitForAuctionTimer
```
public void waitForAuctionTimer()
```
    Checks if the auction timeout from beginAuctionTimeout is over, and sleeps if it is not over.
  - printAuctionItem
```
public void printAuctionItem(AuctionItem item)
```
    Prints an AuctionItem to console
    
    Parameters:
    
    item - AuctionItem -- Auction item to print
  - castSpellOnInventoryItem
```
public void castSpellOnInventoryItem(int spellId,
                                     int slotIndex)
```
    Casts the specified spell on the specified inventory item. Based on item slot, not item id.
    
    Parameters:
    
    spellId - int
    
    slotIndex - int
  - castSpellOnGroundItem
```
public void castSpellOnGroundItem(int spellId,
                                  int itemId,
                                  int x,
                                  int y)
```
    Casts the specified spell on the specified ground item on the specified tile.
    
    Parameters:
    
    spellId - int
    
    itemId - int
    
    x - int
    
    y - int
  - getDirection
```
public int getDirection(int x,
                        int y)
```
    Retrieves the direction of the specified coordinate, relative to the player.
    
    Parameters:
    
    x - int
    
    y - int
    
    Returns:
    
    int -- returns NORTH if standing on specified tile.
  - getNpcCommand1
```
public java.lang.String getNpcCommand1(int npcId)
```
    Retrieves the 1st command of the specified NPC.
    
    Parameters:
    
    npcId - int
    
    Returns:
    
    String -- guaranteed to not be null
  - getNpcCommand2
```
public java.lang.String getNpcCommand2(int npcId)
```
    Retrieves the 2nd command of the specified NPC.
    
    Parameters:
    
    npcId - int
    
    Returns:
    
    String -- guaranteed to not be null
  - getNpcExamineText
```
public java.lang.String getNpcExamineText(int npcId)
```
    Retrieves the examine text of the specified NPC.
    
    Parameters:
    
    npcId - int
    
    Returns:
    
    String -- guaranteed to not be null
  - getNpcName
```
public java.lang.String getNpcName(int npcId)
```
    Retrieves the name of the specified NPC.
    
    Parameters:
    
    npcId - int
    
    Returns:
    
    String -- guaranteed to not be null
  - calculateNpcLevel
```
public int calculateNpcLevel(int npcId)
```
    Calculates an NPC's level based on it's stats
    
    Parameters:
    
    npcId - int -- npc id
    
    Returns:
    
    int -- level
  - isNpcAttackable
```
public boolean isNpcAttackable(int npcId)
```
    Whether or not the specified npcId is attackable. This does not reflect whether or not the specified NPC is in combat.
    
    Parameters:
    
    npcId - int -- the id of the npc. This is NOT a server index.
    
    Returns:
    
    boolean
  - getObjectCommand1
```
public java.lang.String getObjectCommand1(int objId)
```
    Retrieves the 1st command of the specified object id.
    
    Parameters:
    
    objId - int
    
    Returns:
    
    String -- guaranteed to not be null
  - getObjectCommand2
```
public java.lang.String getObjectCommand2(int objId)
```
    Retrieves the 2nd command of the specified object id.
    
    Parameters:
    
    objId - int
    
    Returns:
    
    String -- guaranteed to not be null
  - getObjectExamineText
```
public java.lang.String getObjectExamineText(int objId)
```
    Retrieves the examine text of the specified object id.
    
    Parameters:
    
    objId - int
    
    Returns:
    
    String -- guaranteed to not be null
  - getObjectName
```
public java.lang.String getObjectName(int objId)
```
    Retrieves the name of the specified object id.
    
    Parameters:
    
    objId - int
    
    Returns:
    
    String -- guaranteed to not be null
  - getPrayersCount
```
public int getPrayersCount()
```
    Retrieves the number of prayers in the game.
  - getPrayerId
```
public int getPrayerId(java.lang.String prayerName)
```
    Retrieves the id of the specified prayerName. (0,1,2,3,4,etc)
    
    Parameters:
    
    prayerName - -- must match spelling of what is inside prayer book. Case insensitive.
    
    Returns:
    
    int -- -1 if the prayer does not exist.
  - getPrayerName
```
public java.lang.String getPrayerName(int prayerId)
```
    Retrieves the name of the specified prayer id.
    
    Parameters:
    
    prayerId - -- the id of the prayer
    
    Returns:
    
    String -- null if no prayer found.
  - getPrayerLevel
```
public int getPrayerLevel(int prayerId)
```
    Retrieves the level required to use the specified prayer.
    
    Parameters:
    
    prayerId - int
    
    Returns:
    
    int -- -1 if the prayer does not exist
  - getPrayerDrain
```
public int getPrayerDrain(int prayerId)
```
    Retrieves the drain rate of the specified prayer.
    
    Parameters:
    
    prayerId - int
    
    Returns:
    
    int -- -1 if the prayer does not exist
  - isPrayerOn
```
public boolean isPrayerOn(int prayerId)
```
    Whether or not the specified prayer is currently on.
    
    Parameters:
    
    prayerId - int
    
    Returns:
    
    boolean
  - enablePrayer
```
public void enablePrayer(int prayerId)
```
    Enables the prayer.
    
    Parameters:
    
    prayerId - int
  - disablePrayer
```
public void disablePrayer(int prayerId)
```
    Disables the prayer.
    
    Parameters:
    
    prayerId - int
  - isInShop
```
public boolean isInShop()
```
    Whether or not a shop window is currently open.
    
    Returns:
    
    boolean
  - openShop
```
public void openShop(int[] npcIds)
```
    Uses npcCommand1 to open the shop on the nearest npc id given
  - closeShop
```
public void closeShop()
```
    Closes the currently open shop window. Does nothing if no shop window is open.
  - getShopItemsCount
```
public int getShopItemsCount()
```
    Retrieves the number of different items which the shop sells.
    
    Returns:
    
    int -- amount of different items. Returns -1 if shop is not open.
  - getShopItems
```
public java.util.List<com.openrsc.client.entityhandling.instances.Item> getShopItems()
```
    Retrieves a list of all the shop items in the shop.
    
    Returns:
    
    shopItems guaranteed to not be null.
  - getShopItemCount
```
public int getShopItemCount(int itemId)
```
    Retrieves how many of the specified item is in stock.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    int -- stock amount. If item is not sold at shop, it returns -1.
  - getShopItemStackPrice
```
public int getShopItemStackPrice(int itemId)
```
    Retrieves the price of the stack of items in the shop.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    int -- price. -1 if item is not in the shop at all.
  - getShopItemPrice
```
public int getShopItemPrice(int itemId)
```
    Retrieves the price of a single item in the shop.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    int -- price. -1 if item is not in the shop at all.
  - shopBuy
```
public boolean shopBuy(int itemId)
```
    Buys the specified item from the currently open shop.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    boolean -- true on success. false if the shop is not open or shop does not have enough stock.
  - shopSell
```
public boolean shopSell(int itemId)
```
    Sells the specified item to the currently open shop.
    
    Parameters:
    
    itemId - int
    
    Returns:
    
    boolean -- true on success. false if shop is not open, shop does not accept the item, or not enough in inventory.
  - getSkills
```
public java.util.List<SkillDef> getSkills()
```
    Retrieves a list of all the skills.
    
    Returns:
    
    _list guaranteed to not be null.
  - getStatId
```
public int getStatId(java.lang.String statName)
```
    Retrieves the id of the specified skill name. Skill name is case insensitive and must match what is spelled inside the stat tab.
    
    Parameters:
    
    statName - int
    
    Returns:
    
    int -- -1 if the skill does not exist.
  - getBaseStat
```
public int getBaseStat(int statId)
```
    Retrieves the base level (excluding boosted/degraded stats) of the specified skill. `id` must be within [0, getStatCount()].
    
    Parameters:
    
    statId - int
    
    Returns:
    
    int
  - getCurrentStat
```
public int getCurrentStat(int statId)
```
    Retrieves the current level (including boosted/degraded stats) of the specified skill. `id` must be within [0, getStatCount()].
    
    Parameters:
    
    statId - int
    
    Returns:
    
    int
  - getStatXp
```
public int getStatXp(int statId)
```
    Retrieves the current XP in the specified skill. `id` must be within [0, getStatCount()].
    
    Parameters:
    
    statId - int
    
    Returns:
    
    int
  - getStatCount
```
public int getStatCount()
```
    Retrieves the number of skills in the game.
    
    Returns:
    
    int
  - getPlayerExperience
```
public int getPlayerExperience(int statId)
```
    Retrieves the amount of XP gained in the skill since last login.
    
    Parameters:
    
    statId - int
    
    Returns:
    
    int
  - getSkillNamesLong
```
public java.lang.String[] getSkillNamesLong()
```
    Retrieves an array of all the skill names.
    
    Returns:
    
    String[] -- no guarantee on size or nullability.
  - logout
```
public void logout()
```
    Disables autologin and attempts to logout. No guarantee on success.
  - getObjectAtCoord
```
public int getObjectAtCoord(int x,
                            int y)
```
    Retrieves the id of the object at the specified coordinates.
    
    Parameters:
    
    x - int
    
    y - int
    
    Returns:
    
    int -- -1 if no object at the coordinates.
  - useSlotIndexOnGroundItem
```
public void useSlotIndexOnGroundItem(int x,
                                     int y,
                                     int slotIndex,
                                     int groundItemId)
```
    Uses the specified item in the inventory on the specified ground item.
    
    Parameters:
    
    x - int
    
    y - int
    
    slotIndex - int (use getInventoryItemSlotIndex)
    
    groundItemId - int
  - useItemOnGroundItem
```
public void useItemOnGroundItem(int x,
                                int y,
                                int itemId,
                                int groundItemId)
```
    Uses the specified item in the inventory on the specified ground item.
    
    Parameters:
    
    x - int
    
    y - int
    
    itemId - int
    
    groundItemId - int
  - useUnnotedItemOnGroundItem
```
public void useUnnotedItemOnGroundItem(int x,
                                       int y,
                                       int itemId,
                                       int groundItemId)
```
    Uses the specified unnoted item in the inventory on the specified ground item.
    
    Parameters:
    
    x - int
    
    y - int
    
    itemId - int
    
    groundItemId - int
  - useNotedItemOnGroundItem
```
public void useNotedItemOnGroundItem(int x,
                                     int y,
                                     int itemId,
                                     int groundItemId)
```
    Uses the specified noted item in the inventory on the specified ground item.
    
    Parameters:
    
    x - int
    
    y - int
    
    itemId - int
    
    groundItemId - int
  - getPlayerAtCoord
```
public int getPlayerAtCoord(int x,
                            int y)
```
    Retrieves the server index of the player at the specified coordinates.
    
    Parameters:
    
    x - int
    
    y - int
    
    Returns:
    
    int -- returns -1 if no player at specified tile.
  - getPlayerServerIndexByName
```
public int getPlayerServerIndexByName(java.lang.String name)
```
    Retrieves the server index of the specified player name.
    
    Parameters:
    
    name - -- must not be null.
    
    Returns:
    
    int -- returns -1 if no player with that name nearby.
  - duelPlayer
```
public void duelPlayer(int playerServerIndex)
```
    Duels the specified player.
    
    Parameters:
    
    playerServerIndex - int
  - followPlayer
```
public void followPlayer(int playerServerIndex)
```
    Follows the specified player.
    
    Parameters:
    
    playerServerIndex - int
  - attackPlayer
```
public void attackPlayer(int playerServerIndex)
```
    Attacks the specified player.
    
    Parameters:
    
    playerServerIndex - int
  - useItemOnPlayer
```
public void useItemOnPlayer(int slotIndex,
                            int playerServerIndex)
```
    Uses the specified item on the player.
    
    Parameters:
    
    slotIndex - int
    
    playerServerIndex - int
  - castSpellOnPlayer
```
public void castSpellOnPlayer(int spellId,
                              int playerServerIndex)
```
    Casts the specified spell on the specified player.
    
    Parameters:
    
    spellId - int
    
    playerServerIndex - int
  - castSpellOnSelf
```
public void castSpellOnSelf(int spellId)
```
    Casts the specified spell on the player.
    
    Parameters:
    
    spellId - int
  - tradePlayer
```
public void tradePlayer(int playerServerIndex)
```
    Trades the specified player.
    
    Parameters:
    
    playerServerIndex - -- player index, retrievable with getPlayerServerIndexByName("name").
  - getTradeRecipientName
```
public java.lang.String getTradeRecipientName()
```
    Retrieves the name of the trade recipient, if we are in a trade.
    
    Returns:
    
    String -- no guarantee on nullability.
  - isInTrade
```
public boolean isInTrade()
```
    Whether or not we are currently engaged in a trade.
    
    Returns:
    
    boolean
  - isInTradeConfirmation
```
public boolean isInTradeConfirmation()
```
    Whether or not we are currently in the trade confirmation window.
    
    Returns:
    
    boolean
  - isTradeRecipientAccepting
```
public boolean isTradeRecipientAccepting()
```
    Whether or not the recipient is currently accepting the trade.
    
    Returns:
    
    boolean
  - declineTrade
```
public void declineTrade()
```
    Declines the trade.
  - acceptTrade
```
public void acceptTrade()
```
    Accepts the trade on the first trade window.
  - acceptTradeConfirmation
```
public void acceptTradeConfirmation()
```
    Accepts the current trade on the final trade window.
  - getLocalTradeItems
```
public java.util.List<com.openrsc.client.entityhandling.instances.Item> getLocalTradeItems()
```
    Retrieves items which the player is offering in the trade.
    
    Returns:
    
    localTradeItems guaranteed to not be null.
  - getLocalTradeItemsCount
```
public int getLocalTradeItemsCount()
```
    Retrieves how many items the player is offering in the trade.
    
    Returns:
    
    int
  - getTradeItemsCounts
```
public int[] getTradeItemsCounts()
```
    Retrieves an array of item counts inside of the current trade window.
    
    Returns:
    
    int[] -- no guarantee on size or nullability.
  - getRecipientTradeItems
```
public java.util.List<com.openrsc.client.entityhandling.instances.Item> getRecipientTradeItems()
```
    Retrieves a list of items which your trade recipient is offering.
    
    Returns:
    
    recipientTradeItems guaranteed to not be null.
  - getRecipientTradeItemsCount
```
public int getRecipientTradeItemsCount()
```
    Retrieves the number of items presented by the trade recipient
    
    Returns:
    
    int
  - setTradeItems
```
public boolean setTradeItems(int[] itemIds,
                             int[] amounts,
                             boolean notableItems)
```
    Will put up the specified items and amounts on the trade window.
    
    Parameters:
    
    itemIds - -- int[]
    
    amounts - -- int[]
    
    notableItems - -- boolean if trade will contain noted items
    
    Returns:
    
    boolean -- returns true on success. false on mismatched array lengths or if you do not have enough of an item.
  - removeAllTradeItems
```
public void removeAllTradeItems()
```
    Removes all trade items from the current trade window.
  - setAutoLogin
```
public void setAutoLogin(boolean value)
```
    Toggles auto-login.
    
    Parameters:
    
    value - boolean
  - isAutoLogin
```
public boolean isAutoLogin()
```
    Retrieves whether or not auto-login is set.
  - setInterlacer
```
public void setInterlacer(boolean interlace)
```
    Toggles the client interlacer, which is for saving CPU cycles.
    
    Parameters:
    
    interlace - boolean
  - setCustomUiMode
```
public void setCustomUiMode(boolean mode)
```
    Toggles Custom UI mode, this gives a redesigned in-game UI. The inventory and other tabs stay open after interaction.
    
    Parameters:
    
    mode - boolean
  - getCustomUiMode
```
public boolean getCustomUiMode()
```
    Checks for the Custom UI mode config in mudclient.
  - setScrollLevel
```
public void setScrollLevel(int level)
```
    Set the in-game scroll level of the client.
    
    Parameters:
    
    level - int - level to set zoom to. in range ~ 50 - 300
  - setGroundItemsToggle
```
public void setGroundItemsToggle(int level)
```
```
 Toggle which types of ground items show up on the screen. In-game setting
 * Level 0 - Show ALL items
 * Level 1 - Hide ALL items
 * Level 3 - Hide Bones only
 * Level 3 - No Bones or Ashes
 
```
    Parameters:
    
    level - int - level to set (0-3)
  - setKeepInventoryOpenMode
```
public void setKeepInventoryOpenMode(boolean setting)
```
```
 Set Inventory Toggle Mode. If false, the inventory will not close between actions.
 This was the old android inventory option, but was removed from legitimate game modes.
 BOTTING ONLY
 
```
    Parameters:
    
    setting - boolean - true to keep invent open, false to let it close.
  - isInterlacing
```
public boolean isInterlacing()
```
    Retrieves whether or not the interlacer is set.
  - getInventoryItems
```
public java.util.List<com.openrsc.client.entityhandling.instances.Item> getInventoryItems()
```
    Retrieves a list of all items in the inventory.
    
    Returns:
    
    _list guaranteed to not be null.
  - getInventoryItemIds
```
public int[] getInventoryItemIds()
```
    Retrieves an array of all the ids of all items in the inventory.
    
    Returns:
    
    int[] -- no guarantee on size or nullability.
  - getInventoryUniqueItemIds
```
public int[] getInventoryUniqueItemIds()
```
  - getFoodIds
```
public int[] getFoodIds()
```
    Retrieves the list of all food items in the game.
    
    Returns:
    
    int[] -- will never be null.
  - getFriendList
```
public java.util.List<java.lang.String> getFriendList()
```
    Retrieves a list of users on the friends list.
    
    Returns:
    
    friendsList guaranteed to never be null.
  - getIgnoreList
```
public java.util.List<java.lang.String> getIgnoreList()
```
    Retrieves a list of users on the ignore list.
    
    Returns:
    
    ignoreList guaranteed to never be null.
  - isBatching
```
public boolean isBatching()
```
    Whether or not the batch progress bar is currently shown on screen.
    
    Returns:
    
    boolean
  - waitForBatching
```
public void waitForBatching(boolean checkInventory)
```
    while batching, sleep 1 Game tick. Cancel loop if controller stops or needToMove is true Warning - sleeps 2 ticks before checking if batching.
    
    Parameters:
    
    checkInventory - boolean - true to check for full inventory, false to ignore full invent.
  - isAuthentic
```
public boolean isAuthentic()
```
    Whether or not the server is configured to be authentic. This returns true for Uranium, false for Coleslaw.
    
    Returns:
    
    boolean
  - getMudClientValue
```
public java.lang.Object getMudClientValue(java.lang.String propertyName)
```
    Retrieves the specified field object value of the `mudclient`.
    
    Parameters:
    
    propertyName - -- field name
    
    Returns:
    
    Object -- null if field does not exist.
  - getMud
```
public orsc.mudclient getMud()
```
    Retrieves the `mudclient`.
    
    Returns:
    
    mudclient
  - openBank
```
public void openBank()
```
    Will open bank near any bank NPC or bank chest. Uses right click option if possible. Does not return until the bank screen is open. Hence, if no banker/chest is present, this function will block and not return until one is found.
  - walkPath
```
public void walkPath(int[] path)
```
    Walks the specified coordinates path. Will be blocked by objects such as doors or gates.
    
    Parameters:
    
    path - -- length must be divisible by 2.
  - walkPathReverse
```
public void walkPathReverse(int[] path)
```
    Walks the specified coordinates path, but in reverse. Will be blocked by objects such as doors or gates.
    
    Parameters:
    
    path - -- length must be divisible by 2.
  - log
```
public void log(java.lang.String text)
```
    Logs text to the console, bot log window, and OpenRSC applet.
    
    Parameters:
    
    text - String
  - log
```
public void log(java.lang.String text,
                java.lang.String rsTextColor)
```
    Logs text to the console, bot log window, and OpenRSC applet with the specified @col@.
    
    Parameters:
    
    text - String
    
    rsTextColor - -- the color of the text, such as "red" or "cya". Do not wrap in @'s.
  - isSleeping
```
public boolean isSleeping()
```
    Whether or not the player is currently sleeping.
    
    Returns:
    
    boolean
  - getShouldSleep
```
public boolean getShouldSleep()
```
  - setShouldSleep
```
public void setShouldSleep(boolean shouldSleep)
```
  - sleepHandler
```
public void sleepHandler(boolean quitOnNoSleepingBag)
```
    If fatigue is greater or equal to `fatigueToSleepAt`, this will commence the sleep process and IdleRSC will fill in the answer from the OCR. Has no effect on Coleslaw.
    
    Parameters:
    
    quitOnNoSleepingBag - -- whether or not to logout and stop the script if no sleeping bag is present. If no sleeping bag is present and this is false, this function has no effect.
  - getNearestBank
```
public int[] getNearestBank()
```
    Retrieves the coordinates of the nearest bank, based on your current position. WARNING: Do not use this with the webwalker (walkTowards). Use getNearestWebwalkBank() instead
    
    Returns:
    
    int[] -- [x, y] with the coordinates of the bank. Never returns null.
  - shopBuy
```
public boolean shopBuy(int itemId,
                       int amount)
```
    Buys the specified itemId from the shop.
    
    Parameters:
    
    itemId - int
    
    amount - int
    
    Returns:
    
    boolean -- returns true on success. False if not in shop, or if shop has no stock.
  - shopSell
```
public boolean shopSell(int itemId,
                        int amount)
```
    Sells the specified itemId to the shop.
    
    Parameters:
    
    itemId - int
    
    amount - int
    
    Returns:
    
    boolean -- returns true on success. False if not in shop, if shop does not accept item, or not enough items in inventory.
  - drawVerticalGradient
```
public void drawVerticalGradient(int x,
                                 int y,
                                 int width,
                                 int height,
                                 int topColor,
                                 int bottomColor)
```
    Draws a gradient box at the specified coordinates.
    
    Parameters:
    
    x - int
    
    y - int
    
    width - int
    
    height - int
    
    topColor - -- RGB "HTML" Color Example: 0x36E2D7
    
    bottomColor - -- RGB "HTML" Color Example: 0x36E2D7
  - drawBoxAlpha
```
public void drawBoxAlpha(int x,
                         int y,
                         int width,
                         int height,
                         int color,
                         int transparency)
```
    Draws a box at the specified coordinates with the specified color and transparency. Must be used inside paintInterrupt().
    
    Parameters:
    
    x - int
    
    y - int
    
    width - int
    
    height - int
    
    color - -- RGB "HTML" Color Example: 0x36E2D7
    
    transparency - -- must be between 0 and 255
  - drawBoxBorder
```
public void drawBoxBorder(int x,
                          int y,
                          int width,
                          int height,
                          int color)
```
    Draws a hollow rectangle at the specified coordinates. Must be used inside paintInterrupt().
    
    Parameters:
    
    x - int
    
    y - int
    
    width - int
    
    height - int
    
    color - -- RGB "HTML" Color Example: 0x36E2D7
  - drawCircle
```
public void drawCircle(int x,
                       int y,
                       int radius,
                       int color,
                       int transparency,
                       int dummy)
```
    Draws a circle at the specified coordinates with specified radius, color, and transparency. Must be used inside paintInterrupt().
    
    Parameters:
    
    x - int
    
    y - int
    
    radius - int
    
    color - -- RGB "HTML" Color Example: 0x36E2D7
    
    transparency - -- must be between 0 and 255
    
    dummy - int
  - drawLineHoriz
```
public void drawLineHoriz(int x,
                          int y,
                          int width,
                          int color)
```
    Draws a horizontal line at the specified coordinates with the specified width. Must be used inside paintInterrupt().
    
    Parameters:
    
    x - int
    
    y - int
    
    width - int
    
    color - -- RGB "HTML" Color Example: 0x36E2D7
  - drawLineVert
```
public void drawLineVert(int x,
                         int y,
                         int height,
                         int color)
```
    Draws a vertical line at the specified coordinates with the specified height.
    
    Parameters:
    
    x - int
    
    y - int
    
    height - int
    
    color - -- RGB "HTML" Color Example: 0x36E2D7
  - drawProgressBar
```
public void drawProgressBar(int current,
                            int maximum,
                            int bgColor,
                            int fgColor,
                            int borderColor,
                            int x,
                            int y,
                            int width,
                            int height,
                            boolean showPercentage,
                            boolean showValues)
```
    Draws a progress bar. Must be used inside paintInterrupt()
    
    Parameters:
    
    current - int -- Current value to calculate the progress bar from
    
    maximum - int -- Maximum value to calculate the progress bar from
    
    bgColor - int -- Color of the progress bar's background. RGB "HTML" Color Example: 0x36E2D7
    
    fgColor - int -- Color of the progress bar's foreground. RGB "HTML" Color Example: 0x36E2D7
    
    borderColor - int -- Color of the progress bar's border. RGB "HTML" Color Example: 0x36E2D7
    
    x - int -- X coordinate of the top left of the progress bar
    
    y - int -- Y coordinate of the top left of the progress bar
    
    width - int -- Width of the progress bar
    
    height - int -- Height of the progress bar
    
    showPercentage - boolean -- Show the percentage on the bar
    
    showValues - boolean -- Show the current and maximum values on the bar
  - drawString
```
public void drawString(java.lang.String str,
                       int x,
                       int y,
                       int color,
                       int fontSize)
```
    Draws text at the specified coordinates. Must be used inside paintInterrupt().
    
    Parameters:
    
    str - -- you may use @col@ colors here.
    
    x - int
    
    y - int
    
    color - -- RGB "HTML" Color Example: 0x36E2D7
    
    fontSize - -- 1 or greater
  - drawCenteredString
```
public void drawCenteredString(java.lang.String str,
                               int x,
                               int y,
                               int color,
                               int fontSize)
```
    Draws text that is centered at the specified coordinates. Must be used inside paintInterrupt().
    
    Parameters:
    
    str - String -- String to draw
    
    x - int -- X coordinate
    
    y - int -- Y coordinate
    
    color - int -- String color. RGB "HTML" Color Example: 0x36E2D7
    
    fontSize - int -- 1 or greater
  - drawShadowText
```
public void drawShadowText(java.lang.String text,
                           int x,
                           int y,
                           int textColor,
                           int fontSize,
                           boolean center)
```
    Draws shadow text at the specified coordinates. Must be used inside paintInterrupt().
    
    Parameters:
    
    text - -- you may use @col@ colors here.
    
    x - int
    
    y - int
    
    textColor - int -- RGB "HTML" color Example: 0x36E2D7
    
    fontSize - int -- 1 or greater
    
    center - boolean
  - drawItemSprite
```
public void drawItemSprite(int itemId,
                           int x,
                           int y,
                           int scalePercent,
                           boolean mirrorX)
```
    Draws the sprite of an item at specified coordinates. Must be used inside paintInterrupt().
    
    Parameters:
    
    itemId - int --
    
    x - int -- X coordinate
    
    y - int -- Y coordinate
    
    scalePercent - int -- Percent to scale the sprite. 100 for normal, less for smaller, and greater for larger.
    
    mirrorX - boolean -- Mirror the sprite across it's X axis.
  - getItemSpriteWidth
```
public int getItemSpriteWidth(int itemId)
```
    Returns the width of the sprite for an item id
    
    Parameters:
    
    itemId - int -- Item id
    
    Returns:
    
    int -- Width
  - getItemSpriteScaledWidth
```
public int getItemSpriteScaledWidth(int itemId,
                                    int scalePercent)
```
    Returns the width of the sprite for an item id
    
    Parameters:
    
    itemId - int -- Item id
    
    scalePercent - int -- Percent to scale the sprite up or down
    
    Returns:
    
    int -- Scaled width
  - getItemSpriteHeight
```
public int getItemSpriteHeight(int itemId)
```
    Returns the height of the sprite for an item id
    
    Parameters:
    
    itemId - int -- Item id
    
    Returns:
    
    int -- Height
  - getItemSpriteScaledHeight
```
public int getItemSpriteScaledHeight(int itemId,
                                     int scalePercent)
```
    Returns the height of the sprite for an item id
    
    Parameters:
    
    itemId - int -- Item id
    
    scalePercent - int -- Percent to scale the sprite up or down
    
    Returns:
    
    int -- Scaled height
  - getStringWidth
```
public int getStringWidth(java.lang.String string,
                          int fontSize)
```
    Returns the width of a string of a specified font size.
    
    Parameters:
    
    string - String -- Text to get the width from
    
    fontSize - int -- Font size
    
    Returns:
    
    int
  - getStringHeight
```
public int getStringHeight(int fontSize)
```
    Returns the height of a specified font size.
    
    Parameters:
    
    fontSize - int -- Font size to get height from
    
    Returns:
    
    int
  - setStatus
```
public void setStatus(java.lang.String rstext)
```
    Sets the left-hand status indicator text value.
    
    Parameters:
    
    rstext - -- You may use @col@ colors here.
  - getPlayerName
```
public java.lang.String getPlayerName()
```
    Retrieves the name of the currently logged in player.
    
    Returns:
    
    String
  - getCharacterDirection
```
public orsc.enumerations.ORSCharacterDirection getCharacterDirection(orsc.ORSCharacter c)
```
    Retrieves the direction of the ORSCharacter (NPC or player.)
    
    Parameters:
    
    c - -- character
    
    Returns:
    
    ORSCharacterDirection
  - getShowStatus
```
public boolean getShowStatus()
```
    Whether or not the left-hand status indicator is enabled.
    
    Returns:
    
    boolean
  - setShowStatus
```
public void setShowStatus(boolean b)
```
    Toggles the left-hand status indicator.
    
    Parameters:
    
    b - int
  - getShowCoords
```
public boolean getShowCoords()
```
    Whether or not the the left-hand coordinates indicator is enabled.
    
    Returns:
    
    boolean
  - setShowCoords
```
public void setShowCoords(boolean b)
```
    Toggles the left-hand coordinates indicator.
    
    Parameters:
    
    b - int
  - getShowXp
```
public boolean getShowXp()
```
    Whether or not the left-hand XP counter is enabled.
    
    Returns:
    
    boolean
  - setShowXp
```
public void setShowXp(boolean b)
```
    Toggles the left-hand XP counter.
    
    Parameters:
    
    b - int
  - getShowBotPaint
```
public boolean getShowBotPaint()
```
    Whether or not bot painting is enabled.
    
    Returns:
    
    boolean
  - setBotPaint
```
public void setBotPaint(boolean _showBotPaint)
```
    Toggle bot painting (such as progress reports.) This does not disable client graphics.
    
    Parameters:
    
    _showBotPaint - int
  - isReachable
```
public boolean isReachable(int x,
                           int y,
                           boolean includeTileEdges)
```
    Whether or not the tile is reachable in the current map segment.
    
    Parameters:
    
    x - int
    
    y - int
    
    includeTileEdges - -- whether or not the edges of the tile are permitted. Such as picking up an item on a table -- you can't walk on top of the table, but you can reach the edges.
    
    Returns:
    
    true if the tile is reachable, false if blocked.
  - quitIfAuthentic
```
public void quitIfAuthentic()
```
    If running on an authentic server, this stops the script and outputs a message about compatibility.
  - getPlayerCoordsByServerIndex
```
public int[] getPlayerCoordsByServerIndex(int serverIndex)
```
    Retrieves the coordinates of the specified NPC.
    
    Parameters:
    
    serverIndex - int
    
    Returns:
    
    int[] -- [x, y]. Returns [-1, -1] on no NPC present.
  - isDrawEnabled
```
public boolean isDrawEnabled()
```
    Whether or not draw/graphics is currently enabled.
    
    Returns:
    
    boolean
  - setDrawing
```
public void setDrawing(boolean drawing_,
                       int pauseTicks)
```
    Toggle draw/graphics.
    
    Parameters:
    
    drawing_ - boolean - what draw state to set it
    
    pauseTicks - int - how long to wait before reverting graphics selection. 0 to not derefresh.
  - isRender3DEnabled
```
public boolean isRender3DEnabled()
```
    Whether or not render 3D is currently enabled.
    
    Returns:
    
    boolean
  - setRender3D
```
public void setRender3D(boolean render3D)
```
    Toggle render 3D.
    
    Parameters:
    
    render3D - boolean - what render state to set.
  - setNeedToMove
```
public void setNeedToMove(java.lang.Boolean needToMove_)
```
    Call this method to trigger a move within scripts. Sets the need to move flag.
    
    Parameters:
    
    needToMove_ - boolean - true if need to move, false otherwise.
  - getNeedToMove
```
public boolean getNeedToMove()
```
    Call this method to check the state of needToMove. Script should call moveCharacter() to prevent logout, if this is true.
    
    Returns:
    
    boolean - true if needToMove, false otherwise.
  - moveCharacter
```
public void moveCharacter()
```
    Call this method from within a script to move the character one tile away to a random tile.
  - openNearbyDoor
```
public void openNearbyDoor(int radius)
```
    If standing next to a closed door or gate within the specified radius, open it.
    
    Parameters:
    
    radius - -- within how many tiles to find said door
  - openNearbyDoors
```
public void openNearbyDoors(int radius)
```
    Opens all reachable doors with the same id that match the ids in the radius.
    
    Parameters:
    
    radius - -- within how many tiles to find said door
  - getMudMouseCoords
```
public int[] getMudMouseCoords()
```
  - getGameHeight
```
public int getGameHeight()
```
    Returns the height, in pixels, of the game window.
    
    Returns:
    
    int
  - getGameWidth
```
public int getGameWidth()
```
    Returns the width, in pixels, of the game window.
    
    Returns:
    
    int
  - isNpcTalking
```
public boolean isNpcTalking(int serverIndex)
```
    Checks if the NPC is currently talking.
    
    Parameters:
    
    serverIndex - the index of the NPC on the server
    
    Returns:
    
    true if the NPC is talking, false otherwise
  - getWallObjectExamineText
```
public java.lang.String getWallObjectExamineText(int objId)
```
    Retrieves the examine text of the specified wall object id.
    
    Parameters:
    
    objId - int
    
    Returns:
    
    String -- guaranteed to not be null
  - getWallObjectName
```
public java.lang.String getWallObjectName(int objId)
```
    Retrieves the examine text of the specified wall object id.
    
    Parameters:
    
    objId - int
    
    Returns:
    
    String -- guaranteed to not be null
  - getSpellsCount
```
public int getSpellsCount()
```
    Retrieves the number of spells (total)
    
    Returns:
    
    the number of spells
  - getSpellNames
```
public java.lang.String[] getSpellNames()
```
    Retrieves the names of all spells.
    
    Returns:
    
    an array of strings containing the names of all spells
  - getSpellLevel
```
public int getSpellLevel(int spellId)
```
    Retrieves the spell level for the given spell ID.
    
    Parameters:
    
    spellId - the ID of the spell
    
    Returns:
    
    the required level for the spell, or -1 if the spell ID is invalid
  - getSpellType
```
public int getSpellType(int spellId)
```
    Gets the spell type for the given spell ID.
    
    Parameters:
    
    spellId - the ID of the spell
    
    Returns:
    
    the spell type, or -1 if an exception occurs
  - getSpellRunes
```
public java.util.Set<java.util.Map.Entry<java.lang.Integer,java.lang.Integer>> getSpellRunes(int spellId)
```
    Retrieves the set of spell runes required for a given spell ID.
    
    Parameters:
    
    spellId - the ID of the spell
    
    Returns:
    
    the set of spell runes required, or null if an exception occurs
  - canCastSpell
```
public boolean canCastSpell(int spellId)
```
    Determines if the player can cast a specific spell (high enough stat level and has runes)
    
    Parameters:
    
    spellId - the ID of the spell
    
    Returns:
    
    true if the player can cast the spell, false otherwise
  - getQuestNames
```
public java.lang.String[] getQuestNames()
```
    Returns an array of quest names.
    
    Returns:
    
    an array of quest names
  - getQuestsCount
```
public int getQuestsCount()
```
    Returns the number of quests (total)
    
    Returns:
    
    the number of quests
  - getQuestStage
```
public int getQuestStage(int questId)
```
    Retrieves the quest stage for the specified quest ID.
    
    Parameters:
    
    questId - the ID of the quest
    
    Returns:
    
    the quest stage for the specified quest ID
  - isQuestComplete
```
public boolean isQuestComplete(int questId)
```
    Determines if a quest is complete.
    
    Parameters:
    
    questId - the ID of the quest
    
    Returns:
    
    true if the quest is complete, false otherwise
  - getQuestPoints
```
public int getQuestPoints()
```
    Returns the amount of quest points the player has.
    
    Returns:
    
    int
  - addFriend
```
public void addFriend(java.lang.String username)
```
    Adds a friend to the user's friend list.
    
    Parameters:
    
    username - the username of the friend to be added
  - addIgnore
```
public void addIgnore(java.lang.String username)
```
    Adds the specified username to the ignore list
    
    Parameters:
    
    username - the username to add to the ignore list
  - removeFriend
```
public void removeFriend(java.lang.String username)
```
    Removes a friend from the user's friend list.
    Does not update on client side
    
    Parameters:
    
    username - the username of the friend to be removed
  - removeIgnore
```
public void removeIgnore(java.lang.String username)
```
    Removes the specified player from the ignore list.
    Does not update on client side
    
    Parameters:
    
    username - the username of the user to remove from the ignore list
  - sendPrivateMessage
```
public void sendPrivateMessage(java.lang.String username,
                               java.lang.String message)
```
    Sends a private message to a specified user.
    
    Parameters:
    
    username - the username of the recipient
    
    message - the message to be sent
  - getTargetedNpc
```
public orsc.ORSCharacter getTargetedNpc()
```
  - getLastNpcKilledId
```
public int getLastNpcKilledId()
```
    Returns the id of the last killed npc
    
    Returns:
    
    int
  - getLastNpcKilledCount
```
public int getLastNpcKilledCount()
```
    Returns the kill count of the last killed npc
    
    Returns:
    
    int
  - getTotalKillCount
```
public int getTotalKillCount()
```
    Returns the total kill count of all npcs
    
    Returns:
    
    int
  - getBlockingNpcServerIndex
```
public int getBlockingNpcServerIndex(int npcId)
```
    Returns the server index of the NPC which is currently blocking you. Useful for scripts where an NPC blocking you is bad. Only works if your character is facing the NPC directly.
    
    Parameters:
    
    npcId - -- necessary because you don't want to accidentally attack the wrong npc.
    
    Returns:
    
    the NPC's server index. returns -1 on no NPC blocking.
  - getNpcAtCoords
```
public orsc.ORSCharacter getNpcAtCoords(int x,
                                        int y)
```
    Returns the NPC object of the NPC at the specified coordinates. If there is no NPC at those coordinates, it returns nothing.
    
    Parameters:
    
    x - int
    
    y - int
    
    Returns:
    
    int
  - skipTutorialIsland
```
public void skipTutorialIsland()
```
    If on tutorial island, skips tutorial island.
  - sendSleepWord
```
public void sendSleepWord(java.lang.String word)
```
    Internal function used for sleeping.
    
    Parameters:
    
    word - String
  - atWallObject
```
public void atWallObject(int x,
                         int y)
```
    Walks to the wall object and then interacts with it.
    
    Parameters:
    
    x - int
    
    y - int
  - atWallObject2
```
public void atWallObject2(int x,
                          int y)
```
    Walks to the wall object and then interacts with it (secondary interaction.)
    
    Parameters:
    
    x - int
    
    y - int
  - toggleViewId
```
public void toggleViewId()
```
    Internal function used to grant the ability for normal accounts to access the developer ID menus.
  - setBatchBarsOn
```
public void setBatchBarsOn()
```
    (setBatchBars(boolean)) Method can be called to toggle ON Batch Bars in the openrsc client config.
    This is necessary for scripts utilizing batch bars.
  - setBatchBarsOff
```
public void setBatchBarsOff()
```
    (use setBatchBars(boolean)) Method can be called to toggle OFF Batch Bars in the openrsc client config for native scripts utilizing batch bars.
  - setBatchBars
```
public void setBatchBars(boolean value)
```
    Method can be called to toggle Batch Bars in the openrsc client config for native scripts utilizing batch bars.
  - getBatchBarsOn
```
public boolean getBatchBarsOn()
```
    Check if batch bars are enabled
    
    Returns:
    
    boolean - true if batch bars are enabled, false otherwise or if on uranium.
  - getDebuggerBank
```
public java.util.Map<java.lang.Integer,java.lang.Integer> getDebuggerBank()
```
    Returns a Map of bank items and their amount from the debugger. If you want to do checking while in a bank, use getBankItems() instead. The debugger stays populated the entire time you're logged in, and doesn't require being in a bank to use.
    
    Returns:
    
    Map - Bank items
  - msToString
```
public java.lang.String msToString(long milliseconds)
```
    Display String "Hr:Min:Sec" version of milliseconds long int.
    
    Parameters:
    
    milliseconds - long timeInMilliseconds
    
    Returns:
    
    String Hr:Min:Sec
  - msToShortString
```
public java.lang.String msToShortString(long milliseconds)
```
    Display String "Hr:Min" version of milliseconds long int.
    
    Parameters:
    
    milliseconds - long timeInMilliseconds
    
    Returns:
    
    String Hr:Min
  - timeToCompletion
```
public java.lang.String timeToCompletion(int processed,
                                         int remaining,
                                         long time)
```
    Shows Time to Completions in hours, minutes, and seconds. ("01:23:45")
    credit to chomp for toTimeToCompletion (from AA_Script) (totalBars, barsInBank, startTime)
    
    Parameters:
    
    processed - int totalItemsUsed
    
    remaining - int totalItemsUnused
    
    time - startTime System.currentTimeMillis when bot started
    
    Returns:
    
    String Hr:Min:Sec
  - shortTimeToCompletion
```
public java.lang.String shortTimeToCompletion(int processed,
                                              int remaining,
                                              long time)
```
    Shows short Time to Completions in hours only. ("1234")
    credit to chomp for toTimeToCompletion (from AA_Script) (totalBars, barsInBank, startTime)
    
    Parameters:
    
    processed - int totalItemsUsed
    
    remaining - int totalItemsUnused
    
    time - startTime System.currentTimeMillis when bot started
    
    Returns:
    
    String Hr
  - showRecoveryDetailsMenu
```
public void showRecoveryDetailsMenu()
```
    Show Recovery Question Menu
  - hideRecoveryDetailsMenu
```
public void hideRecoveryDetailsMenu()
```
    Hide Recovery Question Menu (Run this every message hook callback to prevent corrupt packets showing this menu)
  - showContactDetailsMenu
```
public void showContactDetailsMenu()
```
    Show Details Menu
  - hideContactDetailsMenu
```
public void hideContactDetailsMenu()
```
    Hides Details Menu (Run this every message hook callback to prevent corrupt packets showing this menu)
  - hideWelcomeScreen
```
public void hideWelcomeScreen()
```
  - getPlayerMode
```
public int getPlayerMode()
```
    Returns the players gamemode. 0 is normal, 1 is ironman, 2 is ultimate, 3 is hardcore.
    
    Returns:
    
    int -- Mode
  - isPlayerAnIronMode
```
public boolean isPlayerAnIronMode()
```
    Returns whether the player is an ironman mode.
    
    Returns:
    
    boolean

Class Controller

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mud

bankerIds

temporaryToggleSideMenu

CTRL_DOWN_MASK

SHIFT_DOWN_MASK

Constructor Detail

Controller

Method Detail

isRunning

stop

sleep

sleepUntil

sleepUntil

sleepUntilGainedXp

getTotalXp

getTotalLevel

isLoaded

isLoggedIn

typeKey

chatMessage

paste

setFightMode

getFightMode

isItemInInventory

getInventorySlotItemId

getInventoryItemCount

getInventoryItemCount

getUnnotedInventoryItemCount

getNotedInventoryItemCount

getGroundItemsStacked

getGroundItems

getGroundItemsCount

getGroundItemsX

getGroundItemsY

getGroundItemsNoted

getGroundItemAmount

getPlayer

getPlayer

getPlayers

getPlayerCount

isCurrentlyWalking

sleepUntilMoving

sleepUntilNotMoving

isPlayerCurrentlyWalking

isNpcCurrentlyWalking

getDistanceFromLocalPlayer

currentX

currentY

walkTo

walkTo

walkDamnit

walkToAsync

walkTowards

walkTowardsBank

getWebWalker

isTileEmpty

getNearestObjectById

getNearestReachableObjectById

getNearestReachableObjectByIds

getObjectsById

getNearestObjectByIds

atObject

atObject

atObject2

atObject

atObject2

isCloseToCoord

getObjects

getObjectsCount

getObjectsIds

getObjectsX

getObjectsZ

getNpcs

getNpcsAsArray