Script (app API)

java.lang.Object
- compatibility.apos.Script

All Implemented Interfaces:

IScript

Direct Known Subclasses:

Abyte0_DarkWizard, Abyte0_FallyMiner, Abyte0_Flax, Abyte0_Fletch, Abyte0_MagicSmelter, Abyte0_Nature, Abyte0_Paladin, Abyte0_SwampMiner, AlchPlates, AlchWheat, AlchWheatApos, ASCGiants, B_Herblore, B_Smithy, Bank, BankDepositAll, ChestTrader, CleanAllHerbs, D_DeepWildyGiants, D_WildyDarkWiz, EdgeEggs, FaladorSpinnerFlax, FarmPathWalkerArgs, flax, getlimp, getSnape, GnomeAgility, GnomeAgilityApos, HighAlcher, J_Quester, k_ArdyHerber, k_Grinder, k_ShopBuyer, k_ShopBuyer2, lowwall, OgrePicker, OgreRanger, PathWalker, PathWalker_Wild, PathWalkerArgs, Quester_F2P, rena_antidragon, rena_rdkpro, rena_unis, Rope, S_AmuletSmelter, S_AmuletStringer, S_ArdArrowBuyer, S_ArdBuyVials, S_ArdMinePickup, S_ArdougneShearer, S_ArmourConverter, S_ArrowMaker, S_AutoTalker, S_BankBury, S_Barbarian, S_BowStringer, S_Catherby, S_CatherbyBNet, S_CatherbyBuyer, S_CatherbySeller, S_Certer, S_CrystalKeyChest, S_CrystalKeyMaker, S_DraynorPower, S_DummyTrainer, S_EdgevilleChef, S_EdgevilleDruids, S_EdgevilleGiants, S_Enchant, S_FaladorSpinner, S_Fatigue, S_FatigueCrandor, S_FirePower, S_FishingTrawler, S_GemCutter, S_GnomeFlax, S_GnomeFlaxBank, S_GnomeFlaxPower, S_HerblawShop, S_HighAlcher, S_Idle, S_JailRanged, S_KBDKiller, S_KBDLooter, S_LowWall, S_Miner, S_MultiSmith, S_NatureChest, S_OgreFatigue, S_OgreFatigueBones, S_Pickpocket, S_RedDragons, S_Shilo, S_Stake, S_Stitcher, S_SuperSetCerter, S_SymbolSmelter, S_SymbolStringer, S_Tanner, S_TavBlackDemons, S_TavBlueDragons, S_Teleporter, S_TradeGiver, S_TradeTaker, S_UncertBury, S_Use2x14Bank14, S_VialFiller, S_WineMaker, SAF_BloodThiever, SAF_Fally_DnD, SAF_GrandExchange, SAF_HerblawGUI, SAF_Market, SAF_MossFatigue, SAF_PurgeShit, SAF_Wolf, Shantay_Trader, Shrimp, SleepingBag, StealCake, Storm_Script, Stouts, Stouts_Upstairs, Stoutsdownstairs, T_HerbGather, UNIHornGrind, WalkToMiningGuild, YanilleLedge, ZanarisCooker
```
public abstract class Script
extends java.lang.Object
implements IScript
```
This is the APOS API, implemented as a compatibility abstraction layer.

Field Summary

Fields
Modifier and Type	Field and Description
`static int[]`	`BANKERS` An array of all the Banker NPC IDs.
`static int[]`	`BONES` An array of all the bone item IDs.
`static int`	`DIR_EAST`
`static int`	`DIR_NORTH`
`static int`	`DIR_NORTHEAST`
`static int`	`DIR_NORTHWEST`
`static int`	`DIR_SOUTH`
`static int`	`DIR_SOUTHEAST`
`static int`	`DIR_SOUTHWEST`
`static int`	`DIR_WEST`
`static java.lang.String[]`	`FIGHTMODES` An array containing: "Controlled", "Strength", "Attack", "Defence"
`static int`	`MAX_INV_SIZE` The maximum number of items the client's inventory can hold.
`static java.lang.String[]`	`SKILL` An array of all the skill names.
`static java.lang.String[]`	`SPELL` An array of all the spell names.

Constructor Summary

Constructors
Constructor and Description

Script()

Constructors
Constructor and Description
`Script()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`acceptTrade()` Attempts to accept the trade offer.
`void`	`addFriend(java.lang.String name)`
`void`	`addIgnore(java.lang.String name)`
`void`	`answer(int i)` Selects the quest menu option with the given position.
`void`	`atObject(int x, int y)` Attempts to perform the primary action on the object at the given coordinates.
`void`	`atObject2(int x, int y)` Attempts to perform the secondary action on the object at the given coordinates.
`void`	`attackNpc(int local_index)` Attempts to start melee combat with the NPC with the given local index.
`void`	`attackPlayer(int local_index)` Attempts to start melee combat with the given player.
`void`	`atWallObject(int x, int y)` Attempts to perform the primary action on the boundary at the given coordinates.
`void`	`atWallObject2(int x, int y)` Attempts to perform the secondary action on the boundary at the given coordinates.
`void`	`autohop(boolean veteran)` Hops to the next world in a predefined sequence.
`int`	`bankCount(int... ids)` Returns the number of items with the given ids(s) in the client's bank if the bank is visible.
`void`	`buyShopItem(int i, int amount)` Attempts to buy the given number of the item at the given position from the visible shop.
`boolean`	`canCastSpell(int spell)` Returns true if the client has the required magic level and reagents to cast the given spell.
`boolean`	`canLogout()` Returns true if the client can log out.
`void`	`castOnGroundItem(int spell, int item_id, int item_x, int item_y)` Casts a spell on a ground item.
`void`	`castOnItem(int spell, int slot)` Casts the specified spell on the specified slot in the player's inventory.
`void`	`castOnSelf(int spell)` Casts a spell with the given id on the local player.
`void`	`closeBank()` Closes the client's bank.
`void`	`closeShop()` Attempts to close the shop screen.
`void`	`confirmTrade()` Attempts to confirm the trade offer.
`int`	`countNpcs()` Returns the number of NPCs visible to the this.
`int`	`countPlayers()` Returns the number of players visible to the this.
`void`	`declineTrade()` Attempts to decline the trade.
`void`	`deposit(int id, int amount)` Attempts to deposit the given amount of the given item in the client's bank.
`void`	`disableKeys()` Disables keys used by the bot so they can be used by the script.
`void`	`disablePrayer(int prayer)` Attempts to disable a prayer.
`int`	`distanceTo(int x, int y)` Returns the distance between the client and the tile at x, y.
`static int`	`distanceTo(int x1, int y1, int x2, int y2)` Returns the distance between x1, y1 and x2, y2.
`int`	`distanceTo(java.awt.Point coordinate)` Returns the distance between the client and the tile at x, y.
`void`	`drawBoxAlphaFill(int x, int y, int width, int height, int trans, int colour)` Draws a filled equiangular quadrilateral with transparency on the game.
`void`	`drawBoxFill(int x, int y, int width, int height, int colour)` Draws a filled equiangular quadrilateral on the game.
`void`	`drawBoxOutline(int x, int y, int width, int height, int colour)` Draws a 1px outline of a equiangular quadrilateral on the game.
`void`	`drawCircleFill(int x, int y, int radius, int colour, int trans)` Draws a filled circle with optional transparency (use 255 for solid) on the game.
`void`	`drawHLine(int x, int y, int length, int colour)` Draws a horizontal 1px line on the game.
`void`	`drawImage(java.awt.Image image, int start_x, int start_y)` Draws an image on the game.
`void`	`drawString(java.lang.String str, int x, int y, int size, int colour)` Draws a string on the game's canvas.
`void`	`drawVLine(int x, int y, int length, int colour)` Draws a vertical 1px line on the game.
`void`	`dropItem(int slot)` Attempts to drop an item in the client's inventory.
`void`	`enablePrayer(int prayer)` Attempts to enable a prayer.
`void`	`followPlayer(int server_index)` Attempts to start following the player with the given server index.
`double`	`getAccurateFatigue()`
`double`	`getAccurateXpForLevel(int skill)` Returns the client's experience in the given skill.
`int[]`	`getAllNpcById(int... ids)` Locates the nearest NPC with the given id(s).
`int`	`getBankId(int i)`
`int`	`getBankSize()`
`int`	`getBankStack(int i)`
`int`	`getCurrentLevel(int skill)` Returns the client's current level in the given skill.
`int`	`getEmptySlots()` Returns the number of unoccupied slots in the client's inventory.
`int[]`	`getEquippedItemIds()`
`int`	`getFatigue()` Returns the client's fatigue percentage.
`int`	`getFightMode()` Returns the client's combat style.
`int`	`getFriendCount()`
`java.lang.String`	`getFriendName(int i)`
`int`	`getGameHeight()`
`int`	`getGameWidth()`
`int`	`getGroundItemCount()`
`int`	`getGroundItemId(int index)`
`int`	`getHpPercent()` Returns the percentage of hitpoints the client has remaining.
`int`	`getIgnoredCount()`
`java.lang.String`	`getIgnoredName(int i)`
`int`	`getInventoryCount()` Returns the number of individual items in the client's inventory.
`int`	`getInventoryCount(int... ids)` Returns the total number of items in the client's inventory with the specified IDs.
`int`	`getInventoryId(int slot)`
`int`	`getInventoryIndex(int... ids)` Returns the position of the item with the given ID in the client's inventory.
`int`	`getInventoryStack(int slot)`
`int`	`getItemBasePrice(int slot)` Returns the approximate value of an item in the client's inventory.
`static int`	`getItemBasePriceId(int id)`
`int[]`	`getItemById(int... ids)` Locates the nearest ground item with the given id(s).
`java.lang.String`	`getItemCommand(int slot)` Returns the primary action ("eat", "bury") of an item in the client's inventory.
`static java.lang.String`	`getItemCommandId(int id)`
`java.lang.String`	`getItemDescription(int slot)` Returns the description (examine text) of an item in the client's inventory.
`static java.lang.String`	`getItemDescriptionId(int id)`
`java.lang.String`	`getItemName(int slot)` Returns the name of an item in the client's inventory.
`static java.lang.String`	`getItemNameId(int id)`
`int`	`getItemX(int index)`
`int`	`getItemY(int index)`
`int`	`getLevel(int skill)` Returns the client's level in the given skill.
`int`	`getLocalTradeItemCount()`
`int`	`getLocalTradeItemId(int i)`
`int`	`getLocalTradeItemStack(int i)`
`int`	`getMenuIndex(java.lang.String str)` Returns the position of the specified quest menu option, or -1 if the option could not be found.
`int[]`	`getNpcById(int... ids)` Locates the nearest NPC with the given id(s).
`int[]`	`getNpcByIdNotTalk(int... ids)` Locates the nearest NPC with the given id(s).
`int`	`getNpcCombatLevel(int index)` Returns the combat level of the given NPC.
`static int`	`getNpcCombatLevelId(int id)`
`java.lang.String`	`getNpcDescription(int index)` Returns the description (examine text) of the given NPC.
`static java.lang.String`	`getNpcDescriptionId(int id)`
`int`	`getNpcId(int index)`
`int[]`	`getNpcInExtendedRadius(int id, int start_x, int start_y, int latitude, int longitude)` Locates the nearest NPC with the given id(s) within a radius.
`int[]`	`getNpcInRadius(int id, int start_x, int start_y, int radius)` Locates the nearest NPC with the given id within a radius.
`java.lang.String`	`getNpcName(int index)` Returns the name of the given NPC.
`static java.lang.String`	`getNpcNameId(int id)`
`int`	`getNpcServerIndex(int local_index)`
`int`	`getNpcX(int index)`
`int`	`getNpcY(int index)`
`int[]`	`getObjectById(int... ids)` Locates the nearest object with the given id(s).
`int`	`getObjectCount()`
`static java.lang.String`	`getObjectDesc(int id)`
`int`	`getObjectId(int index)`
`int`	`getObjectIdFromCoords(int x, int y)` Returns the id of the object at the given coordinates, or -1 if no object could be found.
`static java.lang.String`	`getObjectName(int id)`
`int`	`getObjectX(int index)`
`int`	`getObjectY(int index)`
`int`	`getOurTradedItemCount()` Deprecated. use Script#getLocalTradeItemCount()
`int[]`	`getPlayerByName(java.lang.String name)` Locates the player with the given display name.
`int[]`	`getPlayerByPid(int server_index)` Deprecated. Unreliable in comparison to `getPlayerByName(String)`.
`int`	`getPlayerCombatLevel(int local_index)` Returns the combat level of the given player.
`int`	`getPlayerDirection(int local_index)` Returns the direction the given player is facing.
`java.lang.String`	`getPlayerName(int local_index)` Returns the display name of the given player.
`int`	`getPlayerPID(int local_index)` Returns the server index of the given player.
`int`	`getPlayerX(int index)`
`int`	`getPlayerY(int index)`
`static int`	`getPrayerCount()`
`static int`	`getPrayerLevel(int i)`
`static java.lang.String`	`getPrayerName(int i)`
`int`	`getQuestCount()`
`java.lang.String`	`getQuestMenuOption(int i)`
`java.lang.String`	`getQuestName(int i)`
`int`	`getQuestStage(int questId)` Retrieves the quest stage for the specified quest ID.
`int`	`getRemoteTradeItemCount()`
`int`	`getRemoteTradeItemId(int i)`
`int`	`getRemoteTradeItemStack(int i)`
`int`	`getShopItemAmount(int i)` Returns the size of the stack the shop has for the item at the given shop position, starting at 0.
`int`	`getShopItemById(int id)` Returns the position of the item with the given id in the shop screen.
`int`	`getShopItemId(int i)` Returns the ID of the item at the given shop position, starting at 0.
`int`	`getSleepingFatigue()` Deprecated. Use `getFatigue()`.
`int`	`getTheirTradedItemCount()` Deprecated. use Script#getRemoteTradeItemCount()
`int[]`	`getWallObjectById(int... ids)` Locates the nearest boundary with the given id(s).
`int`	`getWallObjectCount()`
`static java.lang.String`	`getWallObjectDesc(int id)`
`int`	`getWallObjectId(int index)`
`int`	`getWallObjectIdFromCoords(int x, int y)` Returns the id of the boundary at the given coordinates, or -1.
`static java.lang.String`	`getWallObjectName(int id)`
`int`	`getWallObjectX(int index)`
`int`	`getWallObjectY(int index)`
`int`	`getWorld()` Returns the world the client is logged in to.
`int`	`getX()` Returns the X position of the tile the client is standing on.
`int`	`getXpForLevel(int skill)` Returns the client's experience in the given skill.
`int`	`getY()` Returns the Y position of the tile the client is standing on.
`boolean`	`hasBankItem(int id)` Returns true if the client's bank contains at least one item with the given id if the bank is visible.
`boolean`	`hasInventoryItem(int id)` Returns true if the client's inventory contains at least one item with the given ID.
`boolean`	`hasOtherTraded(int id, int amount)` Returns true if the other player's trade offer contains at least the given number of the given item.
`boolean`	`hasRemoteAcceptedTrade()`
`void`	`hop(int world)` Hops to the specified world.
`static boolean`	`inArray(int[] haystack, int needle)` Returns true if the int[] contains the int.
`boolean`	`inCombat()` Returns true if the client is in combat.
`void`	`init(java.lang.String params)` Called when the Script is selected by the user - override it and use it to process the parameters.
`boolean`	`isAtApproxCoords(int x, int y, int radius)` Returns true if the tile the client is standing on is within radius distance of x, y.
`boolean`	`isAuthentic()` Whether or not the server is configured to be authentic.
`boolean`	`isAutoLogin()` See `setAutoLogin(boolean)`.
`boolean`	`isBanking()` Returns true if the bank screen is visible.
`boolean`	`isBatching()` New APOS function. On Coleslaw, returns whether or not we are currently batching.
`static boolean`	`isCastableOnGroundItem(int spell)`
`static boolean`	`isCastableOnInv(int spell)`
`static boolean`	`isCastableOnSelf(int spell)`
`static boolean`	`isCombatSpell(int spell)`
`boolean`	`isControllerSet()`
`boolean`	`isFriend(java.lang.String name)`
`boolean`	`isHpBarShowing()`
`boolean`	`isIgnored(java.lang.String name)`
`boolean`	`isInTradeConfirm()` Returns true if the trade confirm screen is visible.
`boolean`	`isInTradeOffer()` Returns true if the trade offer screen is visible.
`boolean`	`isItemAt(int id, int x, int y)` Returns true if there is a ground item with the specified id on the specified tile.
`boolean`	`isItemEquipped(int slot)` Returns true if the specified SLOT is equipped.
`boolean`	`isItemIdEquipped(int itemId)` Returns true if the specified itemId is equipped.
`boolean`	`isItemStackable(int slot)`
`static boolean`	`isItemStackableId(int id)`
`boolean`	`isItemTradable(int slot)` Returns true if an item in the client's inventory is tradeable.
`static boolean`	`isItemTradableId(int id)`
`boolean`	`isLoggedIn()`
`boolean`	`isNpcHpBarVisible(int index)`
`boolean`	`isNpcInCombat(int index)`
`boolean`	`isNpcTalking(int index)`
`boolean`	`isObjectAt(int x, int y)` Returns true if the tile at the given coordinates contains an object.
`boolean`	`isPaintOverlay()` See `setPaintOverlay(boolean)`.
`boolean`	`isPlayerHpBarVisible(int index)`
`boolean`	`isPlayerInCombat(int local_index)` Returns true if the given player is in combat.
`boolean`	`isPlayerTalking(int local_index)` Returns true if the given player is talking.
`boolean`	`isPlayerWalking(int local_index)` Returns true if the given player is walking.
`boolean`	`isPrayerEnabled(int prayer)` Returns true if the specified prayer is enabled.
`boolean`	`isQuestComplete(int i)`
`boolean`	`isQuestMenu()` Returns true if a quest menu is visible.
`boolean`	`isReachable(int x, int y)` Returns true if it is possible for the client to walk to x, y.
`boolean`	`isRendering()` See `setRendering(boolean)`.
`boolean`	`isShopOpen()` Returns true if the shop screen is visible.
`boolean`	`isSkilling()` Returns true if an icon is visible over the client's head.
`boolean`	`isSkipLines()` See `setSkipLines(boolean)`.
`boolean`	`isSleeping()` Returns true if the sleeping/fatigue screen is visible.
`boolean`	`isTalking()`
`boolean`	`isTricking()` Deprecated. For internal use. Legacy.
`boolean`	`isWalking()` Returns true if the client is walking.
`boolean`	`isWithinArea(java.awt.Point northEast, java.awt.Point southWest)` Returns true if we are within the given NE/SW coordinates.
`boolean`	`isWithinArea(java.awt.Point coord, java.awt.Point[] points)` Returns true if the coordinate is within an area of points.
`boolean`	`isWithinArea(java.awt.Point searchCoord, java.awt.Point northEast, java.awt.Point southWest)` Returns true if the coordinate is within a basic square area, using North East and South West coordinates.
`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`	`logout()` Attempts to log the client out.
`void`	`mageNpc(int local_index, int spell)` Attempts to cast a spell on the NPC with the given local index.
`void`	`magePlayer(int local_index, int spell)` Attempts to cast a spell on the given player.
`int`	`main()` The bot will wait for the milliseconds main() returns before calling it again.
`boolean`	`next()` Types the next character of the setTypeLine or newline if it has reached the end of the String.
`void`	`offerItemTrade(int slot, int amount)` Attempts to add items to the current trade offer.
`void`	`onChatMessage(java.lang.String msg, java.lang.String name, boolean mod, boolean admin)` Called when a player speaks in public chat.
`void`	`onKeyPress(int keycode)` Called when the user presses a key on the keyboard and the client is the active window.
`void`	`onPrivateMessage(java.lang.String msg, java.lang.String name, boolean mod, boolean admin)` Called when a player speaks in private chat.
`void`	`onServerMessage(java.lang.String str)` Called when a server message is sent, i.e "Welcome to RuneScape!".
`void`	`onTradeRequest(java.lang.String name)` Called when a trade request is recieved by your player.
`void`	`paint()` Called when the game is re-drawn.
`void`	`pickupItem(int id, int x, int y)` Takes an item from the ground by the item's id, x, y
`void`	`print(java.lang.String toPrint)`
`int`	`questMenuCount()` Returns the number of visible quest menu options.
`java.lang.String[]`	`questMenuOptions()` Returns an array of the visible quest menu options.
`static int`	`random(int min, int max)` Generates a psuedo-random number.
`void`	`removeFriend(java.lang.String name)`
`void`	`removeIgnore(java.lang.String name)`
`void`	`removeItem(int slot)` Attemps to unequip an item in the client's inventory.
`void`	`sellShopItem(int i, int amount)` Attempts to sell the given number of the item at the given position from the visible shop.
`void`	`sendPrivateMessage(java.lang.String msg, java.lang.String name)` Attempts to send a private message to the player with the given display name.
`void`	`sendTradeRequest(int server_index)` Attempts to send a trade request to the player with the given server index.
`void`	`setAutoLogin(boolean flag)` Enables or disables autologin.
`static void`	`setController(Controller _controller)` Used internally by the bot to set `Controller`, as that is what adapts APOS to IdleRSC.
`void`	`setFightMode(int style)` Sets the client's combat style.
`void`	`setPaintOverlay(boolean flag)` If paint_overlay is disabled, `paint()` will not be called and the built-in bot display (if any) will be hidden.
`void`	`setPixel(int x, int y, int colour)` Sets a pixel on the game.
`void`	`setRendering(boolean flag)` When disabled (false), may cause the game to enter a non-standard (implemented by the bot) low graphics mode.
`void`	`setSkipLines(boolean flag)` Some implementations support a low graphics mode that skips lines when rendering (usually toggled by pressing F1).
`void`	`setTrickMode(boolean flag)` Enables or disables fatigue tricking, which is disabled by default.
`void`	`setTypeLine(java.lang.String str)` Sets the line to be typed by next().
`static void`	`sleep(int ms)` Deprecated. Will cause the entire game to freeze when called in main()'s thread. The RSC servers expect a ping every 5 seconds among other things, so use of this method is definitely not recommended. If you find yourself using this, consider updating your code to make use of System.currentTimeMillis() or System.nanoTime().
`void`	`stopScript()` Stops the script.
`void`	`takeScreenshot(java.lang.String file)` Attempts to save a screenshot with the specified file name in the Screenshots directory.
`void`	`talkToNpc(int local_index)` Attempts to start talking to the NPC with the given local index.
`void`	`thieveNpc(int local_index)` Attempts to pickpocket the NPC with the given local index.
`void`	`useItem(int slot)` Attempts to perform the primary action on an item in the client's inventory.
`void`	`useItemOnGroundItem(int item_slot, int ground_id, int ground_x, int ground_y)` Uses an item based on its position in the players inventory with an item on the ground based on its id, x position, y position.
`void`	`useItemOnObject(int item_id, int object_id)` Uses an item by id with an object by id - only works if the player has the item, and the object is within distance.
`void`	`useItemOnObject(int item_id, int object_x, int object_y)` Uses an item by id with the object at the specified coordinates.
`void`	`useItemOnWallObject(int slot, int x, int y)` Attempts to use an item in the client's inventory with the boundary at the given coordinates.
`void`	`useItemWithItem(int slot_1, int slot_2)` Uses one item with another based on their positions in the player's inventory.
`void`	`useItemWithPlayer(int local_index, int slot)` Attempts to use an item in the client's inventory with a player.
`void`	`useOnNpc(int local_index, int slot)` Attempts to use an item in the client's inventory with a NPC.
`void`	`useSleepingBag()` Uses the client's sleeping bag.
`void`	`useSlotOnObject(int slot, int object_x, int object_y)`
`void`	`walkTo(int x, int y)` Attempts to walk to the given x, y coordinates.
`void`	`wearItem(int slot)` Attempts to equip an item in the client's inventory.
`void`	`withdraw(int id, int amount)` Attempts to withdraw the given amount of the given item from the client's bank.
`void`	`writeLine(java.lang.String str)` Prints a line of text in the in-game chat box and console.

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

- Field Detail
  - BANKERS
```
public static final int[] BANKERS
```
    An array of all the Banker NPC IDs.
  - BONES
```
public static final int[] BONES
```
    An array of all the bone item IDs.
  - SKILL
```
public static java.lang.String[] SKILL
```
    An array of all the skill names.
  - SPELL
```
public static java.lang.String[] SPELL
```
    An array of all the spell names.
  - FIGHTMODES
```
public static final java.lang.String[] FIGHTMODES
```
    An array containing: "Controlled", "Strength", "Attack", "Defence"
  - MAX_INV_SIZE
```
public static final int MAX_INV_SIZE
```
    The maximum number of items the client's inventory can hold.
    
    See Also:
    
    Constant Field Values
  - DIR_NORTH
```
public static final int DIR_NORTH
```
    See Also:
    
    Constant Field Values
  - DIR_NORTHWEST
```
public static final int DIR_NORTHWEST
```
    See Also:
    
    Constant Field Values
  - DIR_WEST
```
public static final int DIR_WEST
```
    See Also:
    
    Constant Field Values
  - DIR_SOUTHWEST
```
public static final int DIR_SOUTHWEST
```
    See Also:
    
    Constant Field Values
  - DIR_SOUTH
```
public static final int DIR_SOUTH
```
    See Also:
    
    Constant Field Values
  - DIR_SOUTHEAST
```
public static final int DIR_SOUTHEAST
```
    See Also:
    
    Constant Field Values
  - DIR_EAST
```
public static final int DIR_EAST
```
    See Also:
    
    Constant Field Values
  - DIR_NORTHEAST
```
public static final int DIR_NORTHEAST
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Script
```
public Script()
```
- Method Detail
  - setController
```
public static void setController(Controller _controller)
```
    Used internally by the bot to set Controller, as that is what adapts APOS to IdleRSC.
    
    Parameters:
    
    _controller - controller
  - init
```
public void init(java.lang.String params)
```
    Called when the Script is selected by the user - override it and use it to process the parameters.
    
    Specified by:
    
    init in interface IScript
    
    Parameters:
    
    params - the parameters entered by the user when the script is selected.
  - main
```
public int main()
```
    The bot will wait for the milliseconds main() returns before calling it again. It is only called when logged in and not sleeping. Override it and use it for your Script's logic processing.
    
    Specified by:
    
    main in interface IScript
  - paint
```
public void paint()
```
    Called when the game is re-drawn. Override it and use it for your Script's drawing functions.
    
    Specified by:
    
    paint in interface IScript
  - onServerMessage
```
public void onServerMessage(java.lang.String str)
```
    Called when a server message is sent, i.e "Welcome to RuneScape!".
    
    Specified by:
    
    onServerMessage in interface IScript
    
    Parameters:
    
    str - the message.
  - onTradeRequest
```
public void onTradeRequest(java.lang.String name)
```
    Called when a trade request is recieved by your player.
    
    Specified by:
    
    onTradeRequest in interface IScript
    
    Parameters:
    
    name - the display name of the player who sent the request.
  - onChatMessage
```
public void onChatMessage(java.lang.String msg,
                          java.lang.String name,
                          boolean mod,
                          boolean admin)
```
    Called when a player speaks in public chat.
    
    Specified by:
    
    onChatMessage in interface IScript
    
    Parameters:
    
    msg - the message.
    
    name - the display name of the player who sent the message.
    
    mod - true if the sender is a player moderator (silver crown).
    
    admin - true if the sender is a Jagex moderator (gold crown).
  - onPrivateMessage
```
public void onPrivateMessage(java.lang.String msg,
                             java.lang.String name,
                             boolean mod,
                             boolean admin)
```
    Called when a player speaks in private chat.
    
    Specified by:
    
    onPrivateMessage in interface IScript
    
    Parameters:
    
    msg - the message.
    
    name - the display name of the player who sent the message.
    
    mod - true if the sender is a player moderator (silver crown).
    
    admin - true if the sender is a jagex moderator (gold crown).
  - onKeyPress
```
public void onKeyPress(int keycode)
```
    Called when the user presses a key on the keyboard and the client is the active window. Do not use this to send key events, it does not work that way. Instead use void setTypeLine(String s) and boolean next().
    
    Specified by:
    
    onKeyPress in interface IScript
    
    Parameters:
    
    keycode - the key pressed expressed as an integer
    
    See Also:
    
    disableKeys()
  - disableKeys
```
public void disableKeys()
```
    Disables keys used by the bot so they can be used by the script. They are enabled again when the user stops the script.
  - hop
```
public void hop(int world)
```
    Hops to the specified world.
    
    Parameters:
    
    world - the world.
  - autohop
```
public void autohop(boolean veteran)
```
    Hops to the next world in a predefined sequence.
    
    Parameters:
    
    veteran - true to enable hopping to world one
  - getWorld
```
public int getWorld()
```
    Returns the world the client is logged in to.
    
    Returns:
    
    the world the client is logged in to.
  - stopScript
```
public void stopScript()
```
    Stops the script.
    
    See Also:
    
    setAutoLogin(boolean)
  - logout
```
public void logout()
```
    Attempts to log the client out.
    
    Specified by:
    
    logout in interface IScript
  - isSleeping
```
public boolean isSleeping()
```
    Returns true if the sleeping/fatigue screen is visible.
    
    Specified by:
    
    isSleeping in interface IScript
    
    Returns:
    
    true if the sleeping/fatigue screen is visible.
  - getFatigue
```
public int getFatigue()
```
    Returns the client's fatigue percentage.
    
    Specified by:
    
    getFatigue in interface IScript
    
    Returns:
    
    the client's fatigue percentage.
  - getAccurateFatigue
```
public double getAccurateFatigue()
```
  - getX
```
public int getX()
```
    Returns the X position of the tile the client is standing on.
    
    Returns:
    
    the X position of the tile the client is standing on.
  - getY
```
public int getY()
```
    Returns the Y position of the tile the client is standing on.
    
    Returns:
    
    the Y position of the tile the client is standing on.
  - canLogout
```
public boolean canLogout()
```
    Returns true if the client can log out. This is determined by the time since the client was last in combat.
    
    Returns:
    
    true if the client can log out.
  - isTalking
```
public boolean isTalking()
```
  - isHpBarShowing
```
public boolean isHpBarShowing()
```
  - inCombat
```
public boolean inCombat()
```
    Returns true if the client is in combat.
    
    Returns:
    
    true if the client is in combat.
  - isWithinArea
```
public boolean isWithinArea(java.awt.Point northEast,
                            java.awt.Point southWest)
```
    Returns true if we are within the given NE/SW coordinates.
    
    Parameters:
    
    northEast - The North East coordinate.
    
    southWest - The South West coordinate.
    
    Returns:
    
    true if we are within the NE/SW coordinates.
  - isWithinArea
```
public boolean isWithinArea(java.awt.Point searchCoord,
                            java.awt.Point northEast,
                            java.awt.Point southWest)
```
    Returns true if the coordinate is within a basic square area, using North East and South West coordinates.
    
    Parameters:
    
    searchCoord - The coordinate to check
    
    northEast - The North East coordinate.
    
    southWest - The South West coordinate.
    
    Returns:
    
    true if the searchCoord is within the NE/SW area.
  - isWithinArea
```
public boolean isWithinArea(java.awt.Point coord,
                            java.awt.Point[] points)
```
    Returns true if the coordinate is within an area of points. Can be an irregular shape to support rooms which aren't square. Points provided should be generated in either a clockwise, or anti-clockwise list, with the first and last entry of the Point[] array being the same coordinate to "join up" the bounds of the shape.
    
    Parameters:
    
    coord - The coordinate to check
    
    points - The area of points to search within
    
    Returns:
    
    True if coordinate inside the points area array
  - distanceTo
```
public int distanceTo(java.awt.Point coordinate)
```
    Returns the distance between the client and the tile at x, y.
    
    Parameters:
    
    coordinate - The X/Y coordinate to check the distance.
    
    Returns:
    
    the distance between the client and the given tile.
  - isSkilling
```
public boolean isSkilling()
```
    Returns true if an icon is visible over the client's head. An icon is drawn when certain actions such as mining, cutting down a tree, or cooking food are performed. Note that this will not return true if the client only has a skull icon.
    
    Returns:
    
    true if the player has a head icon visible.
  - isWalking
```
public boolean isWalking()
```
    Returns true if the client is walking.
    
    Returns:
    
    true if the client is walking.
  - isTricking
```
@Deprecated
public boolean isTricking()
```
    Deprecated. For internal use. Legacy.
    
    Specified by:
    
    isTricking in interface IScript
    
    Returns:
    
    not what you think it returns!
  - setTrickMode
```
public void setTrickMode(boolean flag)
```
    Enables or disables fatigue tricking, which is disabled by default. If the player kills certain NPCs with 99% fatigue in melee combat, they can gain combat XP without hitpoints XP. If the bot is instructed to use the fatigue trick, it will attempt to keep the fatigue at 99% when it sleeps. The script should take care of the rest.
    
    Parameters:
    
    flag - on/off
  - getSleepingFatigue
```
@Deprecated
public int getSleepingFatigue()
```
    Deprecated. Use getFatigue().
    
    Returns:
    
    the client's current fatigue percentage.
  - setTypeLine
```
public void setTypeLine(java.lang.String str)
```
    Sets the line to be typed by next().
    
    Parameters:
    
    str - the line.
  - next
```
public boolean next()
```
    Types the next character of the setTypeLine or newline if it has reached the end of the String.
    
    Returns:
    
    false until it has finished typing the set line.
  - getFightMode
```
public int getFightMode()
```
    Returns the client's combat style.
    
    Returns:
    
    the client's selected combat style (position in the list starting at 0).
  - setFightMode
```
public void setFightMode(int style)
```
    Sets the client's combat style.
    
    Parameters:
    
    style - the combat style's position in the list starting at 0.
  - getLevel
```
public int getLevel(int skill)
```
    Returns the client's level in the given skill.
    
    Parameters:
    
    skill - the skill's identifer (position in the list starting at 0).
    
    Returns:
    
    the player's level in specified skill.
    
    See Also:
    
    getCurrentLevel(int)
  - getCurrentLevel
```
public int getCurrentLevel(int skill)
```
    Returns the client's current level in the given skill. The returned integer, unlike getLevel, will be different if the skill has been drained or raised.
    
    Parameters:
    
    skill - the skill's identifer (position in the list starting at 0).
    
    Returns:
    
    the player's current level in specified skill.
    
    See Also:
    
    getLevel(int)
  - getXpForLevel
```
public int getXpForLevel(int skill)
```
    Returns the client's experience in the given skill.
    
    Parameters:
    
    skill - the skill's identifer (position in the list starting at 0).
    
    Returns:
    
    the client's experience in specified skill.
  - getAccurateXpForLevel
```
public double getAccurateXpForLevel(int skill)
```
    Returns the client's experience in the given skill.
    
    Parameters:
    
    skill - the skill's identifer (position in the list starting at 0).
    
    Returns:
    
    the client's experience in specified skill.
  - getHpPercent
```
public int getHpPercent()
```
    Returns the percentage of hitpoints the client has remaining.
    
    Returns:
    
    the percentage of hitpoints the client has remaining.
  - castOnSelf
```
public void castOnSelf(int spell)
```
    Casts a spell with the given id on the local player. For teleport/charge spells.
    
    Parameters:
    
    spell - the spell's identifier (position in the list starting at 0).
  - walkTo
```
public void walkTo(int x,
                   int y)
```
    Attempts to walk to the given x, y coordinates.
    
    Parameters:
    
    x - the x position of the target tile.
    
    y - the y position of the target tile.
  - getInventoryCount
```
public int getInventoryCount()
```
    Returns the number of individual items in the client's inventory.
    
    Returns:
    
    the number of individual items in the client's inventory. Between 0 and MAX_INV_SIZE.
  - getEmptySlots
```
public int getEmptySlots()
```
    Returns the number of unoccupied slots in the client's inventory.
    
    Returns:
    
    MAX_INV_SIZE - getInventoryCount()
  - getInventoryCount
```
public int getInventoryCount(int... ids)
```
    Returns the total number of items in the client's inventory with the specified IDs. Stack sizes and individual items are counted.
    
    Parameters:
    
    ids - the IDs of the items to search for.
    
    Returns:
    
    the total number of items in the client's inventory with the specified ids. Stack sizes and individual items are counted.
  - hasInventoryItem
```
public boolean hasInventoryItem(int id)
```
    Returns true if the client's inventory contains at least one item with the given ID.
    
    Parameters:
    
    id - the ID of the item to search for.
    
    Returns:
    
    true if the client's inventory contains at least one item with the given id.
  - getInventoryIndex
```
public int getInventoryIndex(int... ids)
```
    Returns the position of the item with the given ID in the client's inventory.
    
    Parameters:
    
    ids - the identifiers of the items to search for.
    
    Returns:
    
    the position of the first item with the given id(s). May range from 0 to MAX_INV_SIZE.
  - useSleepingBag
```
public void useSleepingBag()
```
    Uses the client's sleeping bag. If the client's inventory does not contain a sleeping bag the script will be stopped.
  - 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.
  - getGroundItemCount
```
public int getGroundItemCount()
```
  - getGroundItemId
```
public int getGroundItemId(int index)
```
  - getItemX
```
public int getItemX(int index)
```
  - getItemY
```
public int getItemY(int index)
```
  - getItemById
```
public int[] getItemById(int... ids)
```
    Locates the nearest ground item with the given id(s).
    
    Parameters:
    
    ids - the item id(s) to search for.
    
    Returns:
    
    always an integer array of size 3. If no item can be found, the array will contain -1, -1, -1. If an item was found, the array will contain the item's ID, X, Y.
  - isItemAt
```
public boolean isItemAt(int id,
                        int x,
                        int y)
```
    Returns true if there is a ground item with the specified id on the specified tile.
    
    Parameters:
    
    id - the item to search for.
    
    x - the x position of the tile to examine.
    
    y - the y position of the tile to examine.
    
    Returns:
    
    true if the item is on the tile.
  - isAuthentic
```
public boolean isAuthentic()
```
    Whether or not the server is configured to be authentic. This returns true for Uranium, false for Coleslaw.
    
    Returns:
    
    boolean
  - isItemEquipped
```
public boolean isItemEquipped(int slot)
```
    Returns true if the specified SLOT is equipped.
    
    Parameters:
    
    slot - the position of the item in the client's inventory, starting at 0.
    
    Returns:
    
    true if the specified item is equipped.
    
    See Also:
    
    getInventoryIndex(int...)
  - getEquippedItemIds
```
public int[] getEquippedItemIds()
```
  - isItemIdEquipped
```
public boolean isItemIdEquipped(int itemId)
```
    Returns true if the specified itemId is equipped. (coleslaw)
    
    Parameters:
    
    itemId - the position of the item in the client's inventory, starting at 0.
    
    Returns:
    
    true if the specified item is equipped.
    
    See Also:
    
    getInventoryIndex(int...)
  - useItem
```
public void useItem(int slot)
```
    Attempts to perform the primary action on an item in the client's inventory. This can be "eat", "bury", etc.
    
    Parameters:
    
    slot - the position of the item in the client's inventory, starting at 0.
    
    See Also:
    
    getInventoryIndex(int...)
  - dropItem
```
public void dropItem(int slot)
```
    Attempts to drop an item in the client's inventory.
    
    Parameters:
    
    slot - the position of the item in the client's inventory, starting at 0.
  - wearItem
```
public void wearItem(int slot)
```
    Attempts to equip an item in the client's inventory.
    
    Parameters:
    
    slot - the position of the item in the client's inventory, starting at 0.
    
    See Also:
    
    getInventoryIndex(int...)
  - removeItem
```
public void removeItem(int slot)
```
    Attemps to unequip an item in the client's inventory.
    
    Parameters:
    
    slot - the position of the item in the client's inventory, starting at 0.
    
    See Also:
    
    getInventoryIndex(int...)
  - useItemWithItem
```
public void useItemWithItem(int slot_1,
                            int slot_2)
```
    Uses one item with another based on their positions in the player's inventory. Useful for cutting gems, fletching, etc.
    
    Parameters:
    
    slot_1 - the position of the item in the client's inventory.
    
    slot_2 - the position of the item in the client's inventory.
    
    See Also:
    
    getInventoryIndex(int...)
  - castOnItem
```
public void castOnItem(int spell,
                       int slot)
```
    Casts the specified spell on the specified slot in the player's inventory. Useful for high alchemy, superheat, etc.
    
    Parameters:
    
    spell - the spell's ID (position in the list starting at 0).
    
    slot - the position of the item in the client's inventory, starting at 0.
    
    See Also:
    
    getInventoryIndex(int...)
  - pickupItem
```
public void pickupItem(int id,
                       int x,
                       int y)
```
    Takes an item from the ground by the item's id, x, y
    
    Parameters:
    
    id - the id of the ground item.
    
    x - the x position of the ground item.
    
    y - the y position of the ground item.
  - useItemOnGroundItem
```
public void useItemOnGroundItem(int item_slot,
                                int ground_id,
                                int ground_x,
                                int ground_y)
```
    Uses an item based on its position in the players inventory with an item on the ground based on its id, x position, y position.
    
    Parameters:
    
    item_slot - the position of the item in the players inventory, starting at 0.
    
    ground_id - the id of the ground item.
    
    ground_x - the x position of the ground item.
    
    ground_y - the y position of the ground item.
    
    See Also:
    
    getItemById(int...), getInventoryIndex(int...)
  - castOnGroundItem
```
public void castOnGroundItem(int spell,
                             int item_id,
                             int item_x,
                             int item_y)
```
    Casts a spell on a ground item.
    
    Parameters:
    
    spell - the spell's position in the list starting at 0.
    
    item_id - the item's id.
    
    item_x - the item's x position.
    
    item_y - the item's y position.
    
    See Also:
    
    getItemById(int...)
  - useItemOnObject
```
public void useItemOnObject(int item_id,
                            int object_id)
```
    Uses an item by id with an object by id - only works if the player has the item, and the object is within distance.
    
    Parameters:
    
    item_id - the ID of the item to use.
    
    object_id - the ID of the object to use the item on.
  - useItemOnObject
```
public void useItemOnObject(int item_id,
                            int object_x,
                            int object_y)
```
    Uses an item by id with the object at the specified coordinates. This only works if the player has the item, and the object is within distance.
    
    Parameters:
    
    item_id - the id of the item to use.
    
    object_x - x tile of the object.
    
    object_y - y tile of the object.
  - useSlotOnObject
```
public void useSlotOnObject(int slot,
                            int object_x,
                            int object_y)
```
  - getAllNpcById
```
public int[] getAllNpcById(int... ids)
```
    Locates the nearest NPC with the given id(s). This will search all NPCs in the area regardless of whether they are in combat or talking.
    
    Parameters:
    
    ids - the NPC id(s) to search for.
    
    Returns:
    
    always an integer array of size 3. If no NPC can be found, the array will contain -1, -1, -1. If an NPC was found, the array will contain the NPC's local index, X, Y.
    
    See Also:
    
    getNpcById(int...), getNpcByIdNotTalk(int...), getNpcInExtendedRadius(int, int, int, int, int), getNpcInRadius(int, int, int, int)
  - getNpcById
```
public int[] getNpcById(int... ids)
```
    Locates the nearest NPC with the given id(s). This will skip NPCs which are in combat.
    
    Parameters:
    
    ids - the NPC id(s) to search for.
    
    Returns:
    
    always an integer array of size 3. If no NPC can be found, the array will contain -1, -1, -1. If an NPC was found, the array will contain the NPC's local index, X, Y.
    
    See Also:
    
    getAllNpcById(int...), getNpcByIdNotTalk(int...), getNpcInExtendedRadius(int, int, int, int, int), getNpcInRadius(int, int, int, int)
  - getNpcByIdNotTalk
```
public int[] getNpcByIdNotTalk(int... ids)
```
    Locates the nearest NPC with the given id(s). This will skip NPCs which are talking.
    
    Parameters:
    
    ids - the NPC id(s) to search for.
    
    Returns:
    
    always an integer array of size 3. If no NPC can be found, the array will contain -1, -1, -1. If an NPC was found, the array will contain the NPC's local index, X, Y.
    
    See Also:
    
    getAllNpcById(int...), getNpcById(int...), getNpcInExtendedRadius(int, int, int, int, int), getNpcInRadius(int, int, int, int)
  - getNpcInRadius
```
public final int[] getNpcInRadius(int id,
                                  int start_x,
                                  int start_y,
                                  int radius)
```
    Locates the nearest NPC with the given id within a radius. This is equivalent to a call to getNpcInExtendedRadius(id, start_x, start_y, radius, radius).
    
    Parameters:
    
    id - the ID of the NPC to search for.
    
    start_x - the center X of the circle area.
    
    start_y - the center Y of the circle area.
    
    radius - the radius of the circle area.
    
    Returns:
    
    always an integer array of size 3. If no NPC can be found, the array will contain -1, -1, -1. If an NPC was found, the array will contain the NPC's local index, X, Y.
    
    See Also:
    
    getNpcInExtendedRadius(int, int, int, int, int), getAllNpcById(int...), getNpcById(int...), getNpcByIdNotTalk(int...)
  - getNpcInExtendedRadius
```
public int[] getNpcInExtendedRadius(int id,
                                    int start_x,
                                    int start_y,
                                    int latitude,
                                    int longitude)
```
    Locates the nearest NPC with the given id(s) within a radius. This will skip NPCs which are in combat.
    
    Parameters:
    
    id - the ID of the NPC to search for.
    
    start_x - the center X of the circle area.
    
    start_y - the center Y of the circle area.
    
    latitude - the distance east and west of center X's area.
    
    longitude - the distance north and south of center Y's area.
    
    Returns:
    
    always an integer array of size 3. If no NPC can be found, the array will contain -1, -1, -1. If an NPC was found, the array will contain the NPC's local index, X, Y.
    
    See Also:
    
    getNpcInRadius(int, int, int, int), getAllNpcById(int...), getNpcById(int...), getNpcByIdNotTalk(int...)
  - attackNpc
```
public void attackNpc(int local_index)
```
    Attempts to start melee combat with the NPC with the given local index.
    
    Parameters:
    
    local_index - the NPC's local index.
    
    See Also:
    
    getNpcById(int...), getAllNpcById(int...), getNpcInRadius(int, int, int, int), getNpcInExtendedRadius(int, int, int, int, int)
  - talkToNpc
```
public void talkToNpc(int local_index)
```
    Attempts to start talking to the NPC with the given local index.
    
    Parameters:
    
    local_index - the NPC's local index.
    
    See Also:
    
    getNpcByIdNotTalk(int...)
  - thieveNpc
```
public void thieveNpc(int local_index)
```
    Attempts to pickpocket the NPC with the given local index.
    
    Parameters:
    
    local_index - the NPC's local index.
    
    See Also:
    
    getNpcById(int...), getNpcInRadius(int, int, int, int), getNpcInExtendedRadius(int, int, int, int, int)
  - mageNpc
```
public void mageNpc(int local_index,
                    int spell)
```
    Attempts to cast a spell on the NPC with the given local index.
    
    Parameters:
    
    local_index - the NPC's local index.
    
    spell - the spell's ID (position in the list starting at 0).
    
    See Also:
    
    getAllNpcById(int...)
  - 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
  - useOnNpc
```
public void useOnNpc(int local_index,
                     int slot)
```
    Attempts to use an item in the client's inventory with a NPC.
    
    Parameters:
    
    local_index - the NPC's local index.
    
    slot - the item's ID.
    
    See Also:
    
    getAllNpcById(int...), getNpcByIdNotTalk(int...)
  - isQuestMenu
```
public boolean isQuestMenu()
```
    Returns true if a quest menu is visible.
    
    Returns:
    
    true if a quest menu is visible.
  - questMenuOptions
```
public java.lang.String[] questMenuOptions()
```
    Returns an array of the visible quest menu options.
    
    Returns:
    
    an array of the visible quest menu options.
  - questMenuCount
```
public int questMenuCount()
```
    Returns the number of visible quest menu options.
    
    Returns:
    
    the number of visible quest menu options.
  - getQuestMenuOption
```
public java.lang.String getQuestMenuOption(int i)
```
  - getMenuIndex
```
public int getMenuIndex(java.lang.String str)
```
    Returns the position of the specified quest menu option, or -1 if the option could not be found. NOT CASE SENSITIVE.
    
    Parameters:
    
    str - the string to compare to the visible options.
    
    Returns:
    
    the specified string's position in the array, or -1.
  - answer
```
public void answer(int i)
```
    Selects the quest menu option with the given position.
    
    Parameters:
    
    i - the option's position in the list, starting at 0.
    
    See Also:
    
    getMenuIndex(String), questMenuOptions()
  - getPlayerByName
```
public int[] getPlayerByName(java.lang.String name)
```
    Locates the player with the given display name. CASE SENSITIVE.
    
    Parameters:
    
    name - the display name of the player to search for.
    
    Returns:
    
    always an integer array of size 3. If no player can be found, the array will contain -1, -1, -1. If a player was found, the array will contain the player's local index, X, Y.
  - getPlayerByPid
```
@Deprecated
public int[] getPlayerByPid(int server_index)
```
    Deprecated. Unreliable in comparison to getPlayerByName(String).
    
    Parameters:
    
    server_index - the server index of the player to search for.
    
    Returns:
    
    always an integer array of size 3. If no player can be found, the array will contain -1, -1, -1. If a player was found, the array will contain the player's local index, X, Y.
  - getPlayerName
```
public java.lang.String getPlayerName(int local_index)
```
    Returns the display name of the given player.
    
    Parameters:
    
    local_index - the player's local index.
    
    Returns:
    
    the player's display name.
    
    See Also:
    
    countPlayers()
  - getPlayerPID
```
public int getPlayerPID(int local_index)
```
    Returns the server index of the given player.
    
    Parameters:
    
    local_index - the player's local index.
    
    Returns:
    
    the player's server index.
    
    See Also:
    
    countPlayers(), getPlayerByName(String)
  - getNpcServerIndex
```
public int getNpcServerIndex(int local_index)
```
  - getPlayerX
```
public int getPlayerX(int index)
```
  - getPlayerY
```
public int getPlayerY(int index)
```
  - getPlayerDirection
```
public int getPlayerDirection(int local_index)
```
    Returns the direction the given player is facing.
    
    Parameters:
    
    local_index - the player's local index.
    
    Returns:
    
    the direction the player is facing: DIR_NORTH, DIR_NORTHWEST, DIR_WEST, DIR_SOUTHWEST, DIR_SOUTH, DIR_SOUTHEAST, DIR_EAST, DIR_NORTHEAST
    
    See Also:
    
    countPlayers(), getPlayerByName(String)
  - getPlayerCombatLevel
```
public int getPlayerCombatLevel(int local_index)
```
    Returns the combat level of the given player.
    
    Parameters:
    
    local_index - the player's local index.
    
    Returns:
    
    the player's combat level.
    
    See Also:
    
    countPlayers(), getPlayerByName(String)
  - isPlayerInCombat
```
public boolean isPlayerInCombat(int local_index)
```
    Returns true if the given player is in combat.
    
    Parameters:
    
    local_index - the player's local index.
    
    Returns:
    
    true if the player is in combat.
    
    See Also:
    
    countPlayers(), getPlayerByName(String)
  - isPlayerHpBarVisible
```
public boolean isPlayerHpBarVisible(int index)
```
  - isPlayerTalking
```
public boolean isPlayerTalking(int local_index)
```
    Returns true if the given player is talking.
    
    Parameters:
    
    local_index - the player's local index.
    
    Returns:
    
    true if the player is in talking.
    
    See Also:
    
    countPlayers(), getPlayerByName(String)
  - isPlayerWalking
```
public boolean isPlayerWalking(int local_index)
```
    Returns true if the given player is walking.
    
    Parameters:
    
    local_index - the player's local index.
    
    Returns:
    
    true if the player is in walking.
    
    See Also:
    
    countPlayers(), getPlayerByName(String)
  - countPlayers
```
public int countPlayers()
```
    Returns the number of players visible to the this.
    
    Returns:
    
    the number of players visible to the this.
  - attackPlayer
```
public void attackPlayer(int local_index)
```
    Attempts to start melee combat with the given player.
    
    Parameters:
    
    local_index - the player's local index.
    
    See Also:
    
    countPlayers(), getPlayerByName(String)
  - magePlayer
```
public void magePlayer(int local_index,
                       int spell)
```
    Attempts to cast a spell on the given player.
    
    Parameters:
    
    local_index - the player's local index.
    
    spell - the spell's identifier (position in the list starting at 0).
    
    See Also:
    
    countPlayers(), getPlayerByName(String)
  - getObjectById
```
public int[] getObjectById(int... ids)
```
    Locates the nearest object with the given id(s).
    
    Parameters:
    
    ids - the object id(s) to search for.
    
    Returns:
    
    always an integer array of size 3. If no object can be found, the array will contain -1, -1, -1. If an object was found, the array will contain the object's id, X, Y.
  - getObjectCount
```
public int getObjectCount()
```
  - getObjectId
```
public int getObjectId(int index)
```
  - getObjectX
```
public int getObjectX(int index)
```
  - getObjectY
```
public int getObjectY(int index)
```
  - getObjectName
```
public static java.lang.String getObjectName(int id)
```
  - getObjectDesc
```
public static java.lang.String getObjectDesc(int id)
```
  - getObjectIdFromCoords
```
public int getObjectIdFromCoords(int x,
                                 int y)
```
    Returns the id of the object at the given coordinates, or -1 if no object could be found.
    
    Parameters:
    
    x - the x position of the tile to examine.
    
    y - the y position of the tile to examine.
    
    Returns:
    
    the id of the object at the given coordinates, or -1 if no object could be found.
  - isObjectAt
```
public boolean isObjectAt(int x,
                          int y)
```
    Returns true if the tile at the given coordinates contains an object.
    
    Parameters:
    
    x - the x position of the tile to examine.
    
    y - the y position of the tile to examine.
    
    Returns:
    
    true if the tile at the given coordinates contains an object.
  - atObject
```
public void atObject(int x,
                     int y)
```
    Attempts to perform the primary action on the object at the given coordinates.
    
    Parameters:
    
    x - the x position of the object to interact with.
    
    y - the y position of the object to interact with.
    
    See Also:
    
    getObjectById(int...), atObject2(int, int)
  - atObject2
```
public void atObject2(int x,
                      int y)
```
    Attempts to perform the secondary action on the object at the given coordinates.
    
    Parameters:
    
    x - the x position of the object to interact with.
    
    y - the y position of the object to interact with.
    
    See Also:
    
    getObjectById(int...), atObject(int, int)
  - getWallObjectById
```
public int[] getWallObjectById(int... ids)
```
    Locates the nearest boundary with the given id(s).
    
    Parameters:
    
    ids - the boundary id(s) to search for.
    
    Returns:
    
    always an integer array of size 3. If no boundary can be found, the array will contain -1, -1, -1. If a boundary was found, the array will contain the boundary's id, X, Y.
  - getWallObjectIdFromCoords
```
public int getWallObjectIdFromCoords(int x,
                                     int y)
```
    Returns the id of the boundary at the given coordinates, or -1.
    
    Parameters:
    
    x - the x position of the tile to examine.
    
    y - the y position of the tile to examine.
    
    Returns:
    
    the id of the boundary at the given coordinates, or -1.
  - getWallObjectCount
```
public int getWallObjectCount()
```
  - getWallObjectId
```
public int getWallObjectId(int index)
```
  - getWallObjectX
```
public int getWallObjectX(int index)
```
  - getWallObjectY
```
public int getWallObjectY(int index)
```
  - getWallObjectName
```
public static java.lang.String getWallObjectName(int id)
```
  - getWallObjectDesc
```
public static java.lang.String getWallObjectDesc(int id)
```
  - atWallObject
```
public void atWallObject(int x,
                         int y)
```
    Attempts to perform the primary action on the boundary at the given coordinates.
    
    Parameters:
    
    x - the x position of the boundary to interact with.
    
    y - the y position of the boundary to interact with.
    
    See Also:
    
    getWallObjectById(int...), atWallObject2(int, int)
  - atWallObject2
```
public void atWallObject2(int x,
                          int y)
```
    Attempts to perform the secondary action on the boundary at the given coordinates.
    
    Parameters:
    
    x - the x position of the boundary to interact with.
    
    y - the y position of the boundary to interact with.
    
    See Also:
    
    getWallObjectById(int...), atWallObject(int, int)
  - useItemOnWallObject
```
public void useItemOnWallObject(int slot,
                                int x,
                                int y)
```
    Attempts to use an item in the client's inventory with the boundary at the given coordinates.
    
    Parameters:
    
    slot - the position of the item in the client's inventory, starting at 0.
    
    x - the x position of the boundary to interact with.
    
    y - the y position of the boundary to interact with.
  - deposit
```
public void deposit(int id,
                    int amount)
```
    Attempts to deposit the given amount of the given item in the client's bank.
    
    Parameters:
    
    id - the id of the item to deposit.
    
    amount - the number of the given item to deposit.
  - withdraw
```
public void withdraw(int id,
                     int amount)
```
    Attempts to withdraw the given amount of the given item from the client's bank.
    
    Parameters:
    
    id - the id of the item to withdraw.
    
    amount - the number of the given item to withdraw.
  - bankCount
```
public int bankCount(int... ids)
```
    Returns the number of items with the given ids(s) in the client's bank if the bank is visible.
    
    Parameters:
    
    ids - the item id(s) to search for.
    
    Returns:
    
    the number of items with the given id(s) in the client's bank.
  - getBankSize
```
public int getBankSize()
```
  - getBankId
```
public int getBankId(int i)
```
  - getBankStack
```
public int getBankStack(int i)
```
  - hasBankItem
```
public boolean hasBankItem(int id)
```
    Returns true if the client's bank contains at least one item with the given id if the bank is visible.
    
    Parameters:
    
    id - the item to search for.
    
    Returns:
    
    true if the client's bank contains at least one item with the given id.
  - isBanking
```
public boolean isBanking()
```
    Returns true if the bank screen is visible.
    
    Returns:
    
    true if the bank screen is visible.
  - closeBank
```
public void closeBank()
```
    Closes the client's bank.
  - distanceTo
```
public int distanceTo(int x,
                      int y)
```
    Returns the distance between the client and the tile at x, y.
    
    Parameters:
    
    x - the x position of the tile to compare to the client's position.
    
    y - the y position of the tile to compare to the client's position.
    
    Returns:
    
    the distance between the client and the given tile.
  - distanceTo
```
public static int distanceTo(int x1,
                             int y1,
                             int x2,
                             int y2)
```
    Returns the distance between x1, y1 and x2, y2.
    
    Parameters:
    
    x1 - the first x coordinate.
    
    y1 - the first y coordinate.
    
    x2 - the second x coordinate.
    
    y2 - the second y coordinate.
    
    Returns:
    
    the distance between x1, y1 and x2, y2.
  - isAtApproxCoords
```
public boolean isAtApproxCoords(int x,
                                int y,
                                int radius)
```
    Returns true if the tile the client is standing on is within radius distance of x, y.
    
    Parameters:
    
    x - the x position of the comparison tile.
    
    y - the y position of the comparison tile.
    
    radius - the maximum distance between the client and x, y for the method to return true.
    
    Returns:
    
    true if the tile the client is standing on is within radius distance of x, y.
  - isReachable
```
public boolean isReachable(int x,
                           int y)
```
    Returns true if it is possible for the client to walk to x, y.
    
    Parameters:
    
    x - the x position of the comparison tile.
    
    y - the y position of the comparison tile.
    
    Returns:
    
    true if it is possible for the client to walk to x, y.
  - enablePrayer
```
public void enablePrayer(int prayer)
```
    Attempts to enable a prayer.
    
    Parameters:
    
    prayer - the position of the prayer in the list, starting at 0.
  - disablePrayer
```
public void disablePrayer(int prayer)
```
    Attempts to disable a prayer.
    
    Parameters:
    
    prayer - the position of the prayer in the list, starting at 0.
  - isPrayerEnabled
```
public boolean isPrayerEnabled(int prayer)
```
    Returns true if the specified prayer is enabled.
    
    Parameters:
    
    prayer - the position of the prayer in the list, starting at 0.
    
    Returns:
    
    true if the specified prayer is enabled.
  - isShopOpen
```
public boolean isShopOpen()
```
    Returns true if the shop screen is visible.
    
    Returns:
    
    true if the shop screen is visible.
  - getShopItemById
```
public int getShopItemById(int id)
```
    Returns the position of the item with the given id in the shop screen.
    
    Parameters:
    
    id - the item id to search for.
    
    Returns:
    
    the position of the item with the given id in the shop screen.
  - print
```
public void print(java.lang.String toPrint)
```
  - getShopItemId
```
public int getShopItemId(int i)
```
    Returns the ID of the item at the given shop position, starting at 0.
    
    Parameters:
    
    i - the position.
    
    Returns:
    
    the id of the item at i position.
  - getShopItemAmount
```
public int getShopItemAmount(int i)
```
    Returns the size of the stack the shop has for the item at the given shop position, starting at 0.
    
    Parameters:
    
    i - the position of the item in the shop screen.
    
    Returns:
    
    the size of the stack the shop has for the item at the given shop position.
    
    See Also:
    
    getShopItemById(int)
  - buyShopItem
```
public void buyShopItem(int i,
                        int amount)
```
    Attempts to buy the given number of the item at the given position from the visible shop.
    
    Parameters:
    
    i - the position of the item in the shop screen.
    
    amount - the number to buy.
  - sellShopItem
```
public void sellShopItem(int i,
                         int amount)
```
    Attempts to sell the given number of the item at the given position from the visible shop.
    
    Parameters:
    
    i - the position of the item in the shop screen.
    
    amount - the number to sell.
  - closeShop
```
public void closeShop()
```
    Attempts to close the shop screen.
  - sendTradeRequest
```
public void sendTradeRequest(int server_index)
```
    Attempts to send a trade request to the player with the given server index.
    
    Parameters:
    
    server_index - the server index of the player to send the request to.
    
    See Also:
    
    getPlayerPID(int)
  - followPlayer
```
public void followPlayer(int server_index)
```
    Attempts to start following the player with the given server index.
    
    Parameters:
    
    server_index - the server index of the player to start following.
    
    See Also:
    
    getPlayerPID(int)
  - useItemWithPlayer
```
public void useItemWithPlayer(int local_index,
                              int slot)
```
    Attempts to use an item in the client's inventory with a player.
    
    Parameters:
    
    local_index - the NPC's local index.
    
    slot - the item's ID.
    
    See Also:
    
    getAllNpcById(int...), getNpcByIdNotTalk(int...)
  - isInTradeOffer
```
public boolean isInTradeOffer()
```
    Returns true if the trade offer screen is visible.
    
    Returns:
    
    true if the trade offer screen is visible.
    
    See Also:
    
    isInTradeConfirm()
  - isInTradeConfirm
```
public boolean isInTradeConfirm()
```
    Returns true if the trade confirm screen is visible.
    
    Returns:
    
    true if the trade confirm screen is visible.
    
    See Also:
    
    isInTradeOffer()
  - offerItemTrade
```
public void offerItemTrade(int slot,
                           int amount)
```
    Attempts to add items to the current trade offer.
    
    Parameters:
    
    slot - the position of the item to offer in the client's inventory, starting at 0.
    
    amount - the number of the given item to offer.
  - hasOtherTraded
```
public boolean hasOtherTraded(int id,
                              int amount)
```
    Returns true if the other player's trade offer contains at least the given number of the given item.
    
    Parameters:
    
    id - the id of the item to search for.
    
    amount - the number of the item to ensure is there.
    
    Returns:
    
    true if the other player has traded at least the given number of the given item.
  - getOurTradedItemCount
```
@Deprecated
public int getOurTradedItemCount()
```
    Deprecated. use Script#getLocalTradeItemCount()
    
    Returns the number of items in the client's trade offer.
    
    Returns:
    
    the number of items in the client's trade offer.
  - getLocalTradeItemCount
```
public int getLocalTradeItemCount()
```
  - getLocalTradeItemId
```
public int getLocalTradeItemId(int i)
```
  - getLocalTradeItemStack
```
public int getLocalTradeItemStack(int i)
```
  - getTheirTradedItemCount
```
@Deprecated
public int getTheirTradedItemCount()
```
    Deprecated. use Script#getRemoteTradeItemCount()
    
    Returns the number of items in the other player's trade offer.
    
    Returns:
    
    the number of items in the other player's trade offer.
  - getRemoteTradeItemCount
```
public int getRemoteTradeItemCount()
```
  - getRemoteTradeItemId
```
public int getRemoteTradeItemId(int i)
```
  - getRemoteTradeItemStack
```
public int getRemoteTradeItemStack(int i)
```
  - hasRemoteAcceptedTrade
```
public boolean hasRemoteAcceptedTrade()
```
  - acceptTrade
```
public void acceptTrade()
```
    Attempts to accept the trade offer.
    
    See Also:
    
    confirmTrade(), declineTrade()
  - confirmTrade
```
public void confirmTrade()
```
    Attempts to confirm the trade offer.
    
    See Also:
    
    acceptTrade(), declineTrade()
  - declineTrade
```
public void declineTrade()
```
    Attempts to decline the trade.
    
    See Also:
    
    acceptTrade(), confirmTrade()
  - drawString
```
public void drawString(java.lang.String str,
                       int x,
                       int y,
                       int size,
                       int colour)
```
    Draws a string on the game's canvas. Only use in paint().
    
    Parameters:
    
    str - the string to draw.
    
    x - the x position to start at.
    
    y - the y position to start at.
    
    size - the size of the text.
    
    colour - the hex colour (24-bit RGB) of the text.
  - drawHLine
```
public void drawHLine(int x,
                      int y,
                      int length,
                      int colour)
```
    Draws a horizontal 1px line on the game. Only use in paint().
    
    Parameters:
    
    x - the x position to start at.
    
    y - the y position to start at.
    
    length - the length of the line in pixels.
    
    colour - the hex colour (24-bit RGB) of the line.
  - drawVLine
```
public void drawVLine(int x,
                      int y,
                      int length,
                      int colour)
```
    Draws a vertical 1px line on the game. Only use in paint().
    
    Parameters:
    
    x - the x position to start at.
    
    y - the y position to start at.
    
    length - the length of the line in pixels.
    
    colour - the hex colour (24-bit RGB) of the line.
  - drawBoxOutline
```
public void drawBoxOutline(int x,
                           int y,
                           int width,
                           int height,
                           int colour)
```
    Draws a 1px outline of a equiangular quadrilateral on the game. Only use in paint().
    
    Parameters:
    
    x - the x position to start at.
    
    y - the y position to start at.
    
    width - the width of the shape.
    
    height - the height of the shape.
    
    colour - the hex colour (24-bit RGB) of the shape.
  - drawBoxFill
```
public void drawBoxFill(int x,
                        int y,
                        int width,
                        int height,
                        int colour)
```
    Draws a filled equiangular quadrilateral on the game. Only use in paint().
    
    Parameters:
    
    x - the x position to start at.
    
    y - the y position to start at.
    
    width - the width of the shape.
    
    height - the height of the shape.
    
    colour - the colour (24-bit RGB) of the shape.
  - drawBoxAlphaFill
```
public void drawBoxAlphaFill(int x,
                             int y,
                             int width,
                             int height,
                             int trans,
                             int colour)
```
    Draws a filled equiangular quadrilateral with transparency on the game. Only use in paint().
    
    Parameters:
    
    x - the x position to start at.
    
    y - the y position to start at.
    
    width - the width of the shape.
    
    height - the height of the shape.
    
    trans - transparency of the shape (255-0).
    
    colour - the colour (24-bit RGB) of the shape.
  - drawCircleFill
```
public void drawCircleFill(int x,
                           int y,
                           int radius,
                           int colour,
                           int trans)
```
    Draws a filled circle with optional transparency (use 255 for solid) on the game.
    
    Parameters:
    
    x - the x position of the centre of the circle.
    
    y - the y position of the centre of the circle.
    
    radius - the radius of the circle.
    
    colour - the colour (24-bit RGB) of the shape.
    
    trans - transparency of the shape (255-0).
  - setPixel
```
public void setPixel(int x,
                     int y,
                     int colour)
```
    Sets a pixel on the game.
    
    Parameters:
    
    x - the x position of the pixel.
    
    y - the y position of the pixel.
    
    colour - the colour (24-bit RGB) to set.
  - drawImage
```
public void drawImage(java.awt.Image image,
                      int start_x,
                      int start_y)
```
    Draws an image on the game.
    
    Parameters:
    
    image - the image to draw.
    
    start_x - the x position to start drawing.
    
    start_y - the y position to start drawing.
  - writeLine
```
public void writeLine(java.lang.String str)
```
    Prints a line of text in the in-game chat box and console.
    
    Parameters:
    
    str - the text to print.
  - countNpcs
```
public int countNpcs()
```
    Returns the number of NPCs visible to the this.
    
    Returns:
    
    the number of NPCs visible to the this.
  - getNpcId
```
public int getNpcId(int index)
```
  - getNpcX
```
public int getNpcX(int index)
```
  - getNpcY
```
public int getNpcY(int index)
```
  - isNpcInCombat
```
public boolean isNpcInCombat(int index)
```
  - isNpcTalking
```
public boolean isNpcTalking(int index)
```
  - isNpcHpBarVisible
```
public boolean isNpcHpBarVisible(int index)
```
  - getNpcName
```
public java.lang.String getNpcName(int index)
```
    Returns the name of the given NPC.
    
    Parameters:
    
    index - the NPC's local index.
    
    Returns:
    
    the NPC's name.
  - getNpcNameId
```
public static java.lang.String getNpcNameId(int id)
```
  - getNpcDescription
```
public java.lang.String getNpcDescription(int index)
```
    Returns the description (examine text) of the given NPC.
    
    Parameters:
    
    index - the NPC's local index.
    
    Returns:
    
    the NPC's description (examine text).
  - getNpcDescriptionId
```
public static java.lang.String getNpcDescriptionId(int id)
```
  - getNpcCombatLevel
```
public int getNpcCombatLevel(int index)
```
    Returns the combat level of the given NPC.
    
    Parameters:
    
    index - the NPC's local index.
    
    Returns:
    
    the NPC's combat level.
  - getNpcCombatLevelId
```
public static int getNpcCombatLevelId(int id)
```
  - getInventoryId
```
public int getInventoryId(int slot)
```
  - getInventoryStack
```
public int getInventoryStack(int slot)
```
  - getItemName
```
public java.lang.String getItemName(int slot)
```
    Returns the name of an item in the client's inventory.
    
    Parameters:
    
    slot - the position of the item in the client's inventory, starting at 0.
    
    Returns:
    
    the item's name.
  - getItemNameId
```
public static java.lang.String getItemNameId(int id)
```
  - getItemDescription
```
public java.lang.String getItemDescription(int slot)
```
    Returns the description (examine text) of an item in the client's inventory.
    
    Parameters:
    
    slot - the position of the item in the client's inventory, starting at 0.
    
    Returns:
    
    the item's description (examine text).
  - getItemDescriptionId
```
public static java.lang.String getItemDescriptionId(int id)
```
  - getItemCommand
```
public java.lang.String getItemCommand(int slot)
```
    Returns the primary action ("eat", "bury") of an item in the client's inventory.
    
    Parameters:
    
    slot - the position of the item in the client's inventory, starting at 0.
    
    Returns:
    
    the item's primary action ("eat", "bury").
  - getItemCommandId
```
public static java.lang.String getItemCommandId(int id)
```
  - isItemTradable
```
public boolean isItemTradable(int slot)
```
    Returns true if an item in the client's inventory is tradeable.
    
    Parameters:
    
    slot - the position of the item in the client's inventory, starting at 0.
    
    Returns:
    
    true if the item is tradeable.
  - isItemTradableId
```
public static boolean isItemTradableId(int id)
```
  - isItemStackable
```
public boolean isItemStackable(int slot)
```
  - isItemStackableId
```
public static boolean isItemStackableId(int id)
```
  - getItemBasePrice
```
public int getItemBasePrice(int slot)
```
    Returns the approximate value of an item in the client's inventory. Should generally be used just for comparison.
    
    Parameters:
    
    slot - the position of the item in the client's inventory, starting at 0.
    
    Returns:
    
    the approximate value of the item.
  - getItemBasePriceId
```
public static int getItemBasePriceId(int id)
```
  - canCastSpell
```
public boolean canCastSpell(int spell)
```
    Returns true if the client has the required magic level and reagents to cast the given spell.
    
    Parameters:
    
    spell - the spell's position in the list starting at 0.
    
    Returns:
    
    true if the client has the required magic level and reagents to cast the given spell.
  - setAutoLogin
```
public void setAutoLogin(boolean flag)
```
    Enables or disables autologin.
    
    Parameters:
    
    flag - on/off
    
    See Also:
    
    stopScript()
  - isAutoLogin
```
public boolean isAutoLogin()
```
    See setAutoLogin(boolean). This checks the set flag.
    
    Returns:
    
    true if autologin is enabled.
  - setRendering
```
public void setRendering(boolean flag)
```
    When disabled (false), may cause the game to enter a non-standard (implemented by the bot) low graphics mode. The graphics buffer may no longer be updated. When re-enabled, there may be a minor delay before the buffer is updated again.
    
    Parameters:
    
    flag - the rendering flag.
  - isRendering
```
public boolean isRendering()
```
    See setRendering(boolean). This checks the set flag.
    
    Returns:
    
    true if rendering is enabled.
  - setSkipLines
```
public void setSkipLines(boolean flag)
```
    Some implementations support a low graphics mode that skips lines when rendering (usually toggled by pressing F1). This enables or disables that mode.
    
    Parameters:
    
    flag - the skip_lines flag.
  - isSkipLines
```
public boolean isSkipLines()
```
    See setSkipLines(boolean). This checks the set flag.
    
    Returns:
    
    true if skip_lines is enabled.
  - setPaintOverlay
```
public void setPaintOverlay(boolean flag)
```
    If paint_overlay is disabled, paint() will not be called and the built-in bot display (if any) will be hidden. May be effected by the rendering flag setRendering(boolean).
    
    Parameters:
    
    flag - the paint_overlay flag.
  - isPaintOverlay
```
public boolean isPaintOverlay()
```
    See setPaintOverlay(boolean). This checks the set flag.
    
    Returns:
    
    true if paint_overlay is enabled.
  - takeScreenshot
```
public void takeScreenshot(java.lang.String file)
```
    Attempts to save a screenshot with the specified file name in the Screenshots directory. The file type will always be .png.
    
    Parameters:
    
    file - the file name (excluding extension) to save the screenshot as.
  - random
```
public static int random(int min,
                         int max)
```
    Generates a psuedo-random number.
    
    Parameters:
    
    min - lowest possible number to generate.
    
    max - highest possible number to generate.
    
    Returns:
    
    a psuedo-random number between min and max.
  - inArray
```
public static boolean inArray(int[] haystack,
                              int needle)
```
    Returns true if the int[] contains the int.
    
    Parameters:
    
    haystack - int[] to search.
    
    needle - int to search for.
    
    Returns:
    
    true if the int[] contains the int.
  - sleep
```
@Deprecated
public static void sleep(int ms)
```
    Deprecated. Will cause the entire game to freeze when called in main()'s thread. The RSC servers expect a ping every 5 seconds among other things, so use of this method is definitely not recommended. If you find yourself using this, consider updating your code to make use of System.currentTimeMillis() or System.nanoTime().
    
    Parameters:
    
    ms - time in milliseconds to sleep for.
  - sendPrivateMessage
```
public void sendPrivateMessage(java.lang.String msg,
                               java.lang.String name)
```
    Attempts to send a private message to the player with the given display name.
    
    Parameters:
    
    msg - the message to send.
    
    name - the display name to send the private message to.
  - addFriend
```
public void addFriend(java.lang.String name)
```
  - removeFriend
```
public void removeFriend(java.lang.String name)
```
  - addIgnore
```
public void addIgnore(java.lang.String name)
```
  - removeIgnore
```
public void removeIgnore(java.lang.String name)
```
  - getFriendCount
```
public int getFriendCount()
```
  - getFriendName
```
public java.lang.String getFriendName(int i)
```
  - getIgnoredCount
```
public int getIgnoredCount()
```
  - getIgnoredName
```
public java.lang.String getIgnoredName(int i)
```
  - isFriend
```
public boolean isFriend(java.lang.String name)
```
  - isIgnored
```
public boolean isIgnored(java.lang.String name)
```
  - isLoggedIn
```
public boolean isLoggedIn()
```
  - isCombatSpell
```
public static boolean isCombatSpell(int spell)
```
  - isCastableOnInv
```
public static boolean isCastableOnInv(int spell)
```
  - isCastableOnGroundItem
```
public static boolean isCastableOnGroundItem(int spell)
```
  - isCastableOnSelf
```
public static boolean isCastableOnSelf(int spell)
```
  - getPrayerCount
```
public static int getPrayerCount()
```
  - getPrayerName
```
public static java.lang.String getPrayerName(int i)
```
  - getPrayerLevel
```
public static int getPrayerLevel(int i)
```
  - getQuestCount
```
public int getQuestCount()
```
  - getQuestName
```
public java.lang.String getQuestName(int i)
```
  - isQuestComplete
```
public boolean isQuestComplete(int i)
```
  - getGameWidth
```
public int getGameWidth()
```
  - getGameHeight
```
public int getGameHeight()
```
  - isBatching
```
public boolean isBatching()
```
    New APOS function. On Coleslaw, returns whether or not we are currently batching.
    
    Returns:
    
    true if batching and false if not
  - isControllerSet
```
public boolean isControllerSet()
```

Class Script

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BANKERS

BONES

SKILL

SPELL

FIGHTMODES

MAX_INV_SIZE

DIR_NORTH

DIR_NORTHWEST

DIR_WEST

DIR_SOUTHWEST

DIR_SOUTH

DIR_SOUTHEAST

DIR_EAST

DIR_NORTHEAST

Constructor Detail

Script

Method Detail

setController

init

main

paint

onServerMessage

onTradeRequest

onChatMessage

onPrivateMessage

onKeyPress

disableKeys

hop

autohop

getWorld

stopScript

logout

isSleeping

getFatigue

getAccurateFatigue

getX

getY

canLogout

isTalking

isHpBarShowing

inCombat

isWithinArea

isWithinArea

isWithinArea

distanceTo

isSkilling

isWalking

isTricking

setTrickMode

getSleepingFatigue

setTypeLine

next

getFightMode

setFightMode

getLevel

getCurrentLevel

getXpForLevel

getAccurateXpForLevel

getHpPercent

castOnSelf

walkTo

getInventoryCount

getEmptySlots

getInventoryCount

hasInventoryItem

getInventoryIndex

useSleepingBag

log

log

getGroundItemCount

getGroundItemId

getItemX

getItemY

getItemById