Script (app API)

java.lang.Object
- compatibility.sbot.Script

Direct Known Subclasses:

AgilityNet, AirPicker, AnywhereMiner, ArrowBuyer3, BarbFisher2, burybone, CatherbyLobs, ceikplates, ChickenMunch0r, CoalCerter, CoalUnCerter, CopperMiner, drayfish, Draypowerfishnosleep, dummy, Fire, Flax22k, Flaxpick, GnomeAgility, GuildFisher2, GuildMine_v7, HerberTaverly, IronMinerSmelter, JailRanger, LeetFletcher2, Lumby2Edge, MageDogs, Magic, Man, MindPicker, MultiFight, PowerTuna, Steal, VarrockRuneBuyer, walker, WallJumper, YanilleIron
```
public abstract class Script
extends java.lang.Object
```
This is the SBot API, implemented as a compatibility abstraction layer.

Constructor Summary

Constructors
Constructor and Description

Script()

Constructors
Constructor and Description
`Script()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`Accepted()` NOT IMPLEMENTED YET
`void`	`AcceptTrade()` Accepts the trade, as presented.
`void`	`AcceptTrade2()` Accepts the 2nd trade window, as presented.
`void`	`Answer(int answer)` Answers with the specified option answer when in a NPC dialogue.
`void`	`AtObject(int[] coords)` Performs the 1st command action available on the object at the specified tile.
`void`	`AtObject(int x, int y)` Performs the 1st command action available on the object at the specified tile.
`void`	`AtObject2(int[] coords)` Performs the 2nd command action available on the object at the specified tile.
`void`	`AtObject2(int x, int y)` Performs the 2nd command action available on the object at the specified tile.
`void`	`AttackNPC(int serverIndex)` Attacks the specified npc server index.
`void`	`AttackPlayer(int player)` Attacks the specified player index.
`boolean`	`AutoLogin()`
`boolean`	`Bank()` Whether or not the bank window is currently open.
`int`	`BankCount(int item)` Retrieves how many of `item` is inside the bank.
`void`	`Beep()` Plays a "beep" noise via AWT.
`void`	`Buy(int item)` Buys 1 of the specified item id from the shop window.
`boolean`	`CanReach(int x, int y)` Retrieves whether or not the specified tile is currently reachable by the player.
`void`	`ChatMessage(java.lang.String message)` Interrupt which is called when a chat message is sent to the client.
`void`	`CheckFighters(boolean check)` Not used, but remains for compatability.
`void`	`CloseBank()` Closes the current bank window.
`void`	`CloseDoor(int x, int y, int dir)` Closes the door at the specified tile.
`void`	`CloseShop()` Closes the current shop window.
`boolean`	`CoordsAt(int[] pos)`
`boolean`	`CoordsAt(int x, int y)`
`void`	`DeclineTrade()` Declines the trade.
`void`	`Deposit(int type, int amount)` Deposits the specified amount of the specified item.
`void`	`DisableAutoLogin()`
`void`	`DisplayMessage(java.lang.String message, int type)` Displays a message to the user via the client chat window.
`int`	`Distance(int x, int y)` Retrieves the distance between the player and the respective coordinates.
`int`	`DoorAt(int x, int y, int dir)` Whether or not the door at the specified coordinates is open or closed.
`void`	`Drop(int slot)` Drops one of the item at the specified slot.
`void`	`DuelPlayer(int player)` Sends a duel request to the specified player.
`boolean`	`EmptyTile(int x, int y)` Whether or not the specified tile is empty.
`void`	`EnableAutoLogin()`
`void`	`EndScript()`
`int`	`Fatigue()` Retrieves the current amount of fatigue.
`int`	`FindInv(int type)` Retrieves the slot index of the specified item id.
`void`	`FollowPlayer(int player)` Follows the specified player.
`void`	`ForceWalk(int x, int y)` Walks to the specified tile, and does not give up until it is there.
`void`	`ForceWalkNoWait(int x, int y)` Walks to the specified tile, and does not give up until it is there -- asynchronous.
`java.lang.String`	`GetAnswer(int pos)` Retrieves the text of the specified option answer in NPC dialogue.
`int`	`GetAnswerCount()`
`java.lang.String[]`	`getCommands()` Not used, but remains for compatability.
`int`	`GetCurrentStat(int statno)` Retrieves the current boosted/degraded stat of the specified skill.
`int`	`GetDistance(int x1, int y1, int x2, int y2)` Retrieves the distance between two points.
`int`	`GetExperience(int statno)` Retrieves the experience in the specified skill.
`int`	`GetFightMode()` Retrieves the current fight mode.
`int`	`GetHP()` Retrieves the players current amount of health.
`int`	`GetHPPercent()` Retrieves the current percentage of player hp.
`java.lang.String`	`GetItemCommand(int type)` Retrieves the command of the specified item id.
`int`	`GetItemCount()`
`java.lang.String`	`GetItemDesc(int type)` Retrieves the examine text of the specified item id.
`java.lang.String`	`GetItemName(int type)` Retrieves the name of the specified item id.
`int`	`GetMaxHP()` Retrieves the maximum amount of HP available to the player.
`int[]`	`GetNearestItem(int type)` Retrieves the coordinates of the nearest item id.
`int[]`	`GetNearestItem(int[] type)` Retrieves the coordinates of the nearest item from the list of ids.
`int`	`GetNearestNPC(int type)` Retrieves the server index of the nearest npc of the specified npc id.
`int`	`GetNearestNPC(int[] type)` Retrieves the server index of the nearest npc from the specified npc ids.
`int`	`GetNearestNPC(int[] type, int x1, int y1, int x2, int y2)` NOT IMPLEMENTED YET
`int`	`GetNearestNPC(int type, int x1, int y1, int x2, int y2)` NOT IMPLEMENTED YET
`int[]`	`GetNearestObject(int type)` Retrieves the coordinates of the closest object id.
`int[]`	`GetNearestObject(int[] type)` Retrieves the coordinates of the closest object in the specified array of object ids.
`int[]`	`GetNearestObject(int[] type, int x1, int y1, int x2, int y2)` NOT IMPLEMENTED YET
`int[]`	`GetNearestObject(int type, int x1, int y1, int x2, int y2)` NOT IMPLEMENTED YET
`java.lang.String`	`GetNPCCommand(int type)`
`int`	`GetNPCCount()`
`java.lang.String`	`GetNPCDesc(int type)`
`int`	`GetNPCLevel(int type)`
`int`	`GetNPCMaxHP(int type)`
`java.lang.String`	`GetNPCName(int type)`
`int`	`GetNPCType(int id)` NOT IMPLEMENTED YET
`java.lang.String`	`GetObjectCommand1(int type)`
`java.lang.String`	`GetObjectCommand2(int type)`
`int`	`GetObjectCount()`
`java.lang.String`	`GetObjectDesc(int type)`
`java.lang.String`	`GetObjectName(int type)`
`int`	`GetPlayerCount()`
`int`	`GetPrayerDrain(int prayer)`
`int`	`GetPrayerLevel(int prayer)`
`int`	`GetRandomNPC(int id)`
`int`	`GetRandomNPC(int[] id)`
`int`	`GetStat(int statno)` Retrieves the skill level of the specified skill.
`int`	`GetX()` Retrieves the current X coordinate of the player.
`int`	`GetY()` Retrieves the current Y coordinate of the player.
`boolean`	`InArea(int x1, int y1, int x2, int y2)`
`boolean`	`InCombat()` Whether or not we are currently in combat.
`void`	`init()` The init function for the script -- almost never used.
`boolean`	`InLastServerMessage(java.lang.String st)` Whether or not the specified substring is inside the last server message.
`boolean`	`InStr(java.lang.String str, java.lang.String locate)` Whether or not the specified substring is inside the string.
`java.lang.String`	`IntToStr(int num)` Converts an integer to a string.
`int`	`Inv(int slot)` Retrieves the item id of the specified slot.
`int`	`InvByName(java.lang.String name)`
`int`	`InvCount()` Retrieves how many items are in your inventory.
`int`	`InvCount(int type)` Retrieves how many of the specified item id you have in your inventory.
`int`	`InvCountByName(java.lang.String name)`
`boolean`	`IsAccepted()` Whether or not the trade recipient is accepting the current trade offer.
`boolean`	`IsBatching()` New SBot function. On Coleslaw, returns whether or not we are currently batching.
`boolean`	`IsNPCAttackable(int type)`
`boolean`	`IsStackable(int id)`
`boolean`	`IsWalking()`
`boolean`	`IsWorn(int slot)` Since this function uses an item slot, on Coleslaw, it is permanently broken.
`boolean`	`ItemAt(int x, int y, int type)` Whether or not an item of the specified type is at the specified coordinates.
`void`	`KeyPressed(int key)` NOT IMPLEMENTED YET
`void`	`KeyReleased(int key)` NOT IMPLEMENTED YET
`java.lang.String`	`LastChatMessage()` Retrieves the last spoken chat message.
`int`	`LastChatter()` Retrieves the timestamp of the last chat message to the client.
`java.lang.String`	`LastChatterName()` Retrieves the username of the individual who sent the last message to the client.
`java.lang.String`	`LastNPCMessage()` Retrieves the last quest message.
`int`	`LastPlayerAttacked()` NOT IMPLEMENTED YET
`java.lang.String`	`LastServerMessage()` Retrieves the last server message.
`boolean`	`Loading()` Whether or not the client has loaded.
`boolean`	`LoggedIn()` Whether or not the player is currently logged in.
`void`	`Login(java.lang.String username, java.lang.String password)` Attempts to login with the specified user and password.
`void`	`Logout()` Attempts to logout.
`void`	`Magic(int spell)` Casts the specified spell id on the player.
`void`	`MagicDoor(int x, int y, int dir, int spell)` NOT IMPLEMENTED YET
`void`	`MagicInventory(int slot, int spell)` Casts the specified spell on the specified slot.
`void`	`MagicItem(int x, int y, int item, int spell)` Casts the specified magic index against the specified item id on the specified tile.
`void`	`MagicNPC(int id, int spell)` Casts the specified spell index against the specified npc server index.
`void`	`MagicObject(int x, int y, int spell)` Casts the specified spell index against the object at the specified tile.
`void`	`MagicPlayer(int player, int spell)` Casts the specified spell index against the specified player index.
`boolean`	`NPCExists(int id)`
`boolean`	`NPCInCombat(int id)`
`void`	`NPCMessage(java.lang.String message)` Interrupt which is called when a quest message is sent to the cilent.
`int`	`NPCX(int id)` Retrieves the X coordinates of a npc id.
`int`	`NPCY(int id)` Retrieves the Y coordinates of a npc id.
`int`	`ObjectAt(int x, int y)` Retrieves the object id at the specified coordinates.
`boolean`	`Obstructed(int x, int y)` Whether or not the specified tile is reachable or obstructed.
`void`	`OpenBank()` Opens a nearby bank (banker or chest.)
`void`	`OpenDoor(int x, int y, int dir)` Opens the door at the specified tile.
`void`	`OpenUnbusyBank()` Opens a nearby bank (banker or chest.)
`int`	`PID()` Not used, but remains for compatibility.
`int`	`PlayerAt(int x, int y)` Retrieves the server index of the player at the specified coordinates.
`int`	`PlayerByName(java.lang.String name)` Retrieves the server index of the specified player name.
`int`	`PlayerDestX(int id)` Retrieves the X coordinate of where the player index is currently headed.
`int`	`PlayerDestY(int id)` Retrieves the Y coordinate of where the player index is currently headed.
`int`	`PlayerHP(int id)` Retrieves the HP level of the specified player index.
`boolean`	`PlayerInCombat(int id)` Whether or not the specified player is in combat.
`int`	`PlayerX(int id)` Retrieves the X coordinate of the specified player index.
`int`	`PlayerY(int id)` Retrieves the Y coordinate of the specified player index.
`boolean`	`Prayer(int prayer)` Whether or not the specified prayer index is currently on.
`void`	`PrayerOff(int prayer)` Turns off the specified prayer index.
`void`	`PrayerOn(int prayer)` Turns on the specified prayer index.
`void`	`Print(java.lang.String message)` Prints a message, with no newline, to the system console.
`void`	`Println(java.lang.String message)` Prints a message, followed by newline, to the system console.
`boolean`	`QuestMenu()` Whether or not an NPC option menu is present.
`void`	`Quit()` Exits the bot.
`int`	`Rand(int lower, int higher)` Returns a number between `low` and `higher`.
`void`	`Remove(int slot)` Removes the specified item at the specified slot, if equipped.
`void`	`ResetLastChatMessage()` Not used, but remains for compatability.
`void`	`ResetLastNPCMessage()` Not used, but remains for compatability.
`void`	`ResetLastPlayerAttacked()` NOT IMPLEMENTED YET
`void`	`ResetLastServerMessage()` Not used, but remains for compatability.
`void`	`ResetTrade()` Removes all items from the trade window.
`boolean`	`Running()` Whether or not the script is currenty running.
`void`	`Say(java.lang.String message)` Sends the specified message to the chat.
`void`	`Sell(int item)` Sells 1 of the specified item id from the shop window.
`void`	`ServerMessage(java.lang.String message)` Interrupt which is called when a server message is sent to the client.
`void`	`setController(Controller _controller)` Used internally by the bot to set `Controller`, as that is what adapts SBot to IdleRSC.
`void`	`SetFightMode(int style)` Sets the fight mode to the specified style.
`void`	`SetWorld(int world)` Not used, but remains for compatability.
`void`	`SexyPrint(java.lang.String message)` Prints a nicely formatted message to the system console.
`boolean`	`Shop()` whether or not a shop window is currently open.
`int`	`ShopCount(int item)` Retrieves how many of the specifed item id the shop has in stock.
`boolean`	`Sleeping()` Whether or not we are currently sleeping in a bag/bed.
`void`	`SleepWord()` Not used, but remains for compatability.
`void`	`start(java.lang.String command, java.lang.String[] parameters)` The start function for the script.
`int`	`StrToInt(java.lang.String st)` Converts a string to an integer.
`boolean`	`TakeItem(int x, int y, int type)` Picks up the specified item on the ground.
`void`	`TalkToNPC(int serverIndex)` Talks to the specified npc server index.
`void`	`ThieveNPC(int serverIndex)` Thieves the specified npc server index.
`long`	`TickCount()` Retrieves the current system time in milliseconds.
`void`	`TradeArray(int[] item, int[] amount)` Puts up the respective item ids, of the respective amounts.
`void`	`TradeArray(int item, int amount)` Puts up the respective item id, of the respective amount.
`void`	`TradeOver()` NOT IMPLEMENTED YET
`void`	`TradePlayer(int player)` Trades the specified player.
`void`	`TradeRequest(int PlayerID)` NOT IMPLEMENTED YET
`int`	`TradeStatus()` The current status index of the trade.
`void`	`Use(int slot)` Uses the primary command on the item at the specified slot.
`void`	`UseOnDoor(int x, int y, int dir, int item)` Uses the specified item on the specified door tile.
`void`	`UseOnItem(int x, int y, int type, int item)` Uses the specified inventory item on the specified ground item on the specified tile.
`void`	`UseOnNPC(int id, int item)` Uses the specified item against the specified npc server index.
`void`	`UseOnObject(int x, int y, int slotId)` Uses the specified item from the specified slot on the specified object tile.
`void`	`UseOnPlayer(int player, int slot)` NOT IMPLEMENTED YET
`java.lang.String`	`Username()` Retrieves the name of the logged in user.
`void`	`UseWithInventory(int slot1, int slot2)` Uses the item at `slot1` on `slot2`.
`java.lang.String`	`Version()`
`void`	`Wait(int ticks)` Sleeps for the specified number of milliseconds.
`void`	`WaitForBatchFinish()` New SBot function. On Coleslaw, if batching, sleeps until batching is finished.
`void`	`WaitForLoad()` Waits for the client to finish loading.
`void`	`WaitForServerMessage(int timeout)` Waits until a server message appears.
`void`	`Walk(int x, int y)` Walks to the specified tile.
`void`	`Walk(int x, int y, int step)` Some hacky SBot method for walking to a tile involving wait -- not recommended for use.
`void`	`WalkEmpty(int x1, int y1, int x2, int y2)` Within the specified 2 points, walks to an empty tile within that rectangle.
`void`	`WalkEmptyNoWait(int x1, int y1, int x2, int y2)` Within the specified 2 points, walks to an empty tile within that rectangle -- asynchronous.
`void`	`WalkNoWait(int x, int y)` Walks to the specified tile -- asynchronous.
`void`	`WalkPath(int[] pathx, int[] pathy)`
`void`	`WalkPath(int[] pathx, int[] pathy, int ticks)`
`void`	`WalkPathReverse(int[] pathx, int[] pathy)`
`void`	`WalkPathReverse(int[] pathx, int[] pathy, int ticks)`
`boolean`	`Wearable(int type)`
`void`	`Wield(int slot)` Wields the specified item at the specified slot, if equipped.
`void`	`Withdraw(int type, int amount)` Withdraws the specified amount of the specified item.

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

- Constructor Detail
  - Script
```
public Script()
```
- Method Detail
  - setController
```
public void setController(Controller _controller)
```
    Used internally by the bot to set Controller, as that is what adapts SBot to IdleRSC.
    
    Parameters:
    
    _controller -
  - start
```
public void start(java.lang.String command,
                  java.lang.String[] parameters)
```
    The start function for the script.
    
    Parameters:
    
    command - -- usually the name of the script.
    
    parameters - -- script parameters.
  - getCommands
```
public java.lang.String[] getCommands()
```
    Not used, but remains for compatability.
    
    Returns:
  - init
```
public void init()
```
    The init function for the script -- almost never used.
  - ServerMessage
```
public void ServerMessage(java.lang.String message)
```
    Interrupt which is called when a server message is sent to the client.
    
    Parameters:
    
    message -
  - ChatMessage
```
public void ChatMessage(java.lang.String message)
```
    Interrupt which is called when a chat message is sent to the client.
    
    Parameters:
    
    message -
  - NPCMessage
```
public void NPCMessage(java.lang.String message)
```
    Interrupt which is called when a quest message is sent to the cilent.
    
    Parameters:
    
    message -
  - TradeRequest
```
public void TradeRequest(int PlayerID)
```
    NOT IMPLEMENTED YET
    
    Parameters:
    
    PlayerID -
  - Accepted
```
public void Accepted()
```
    NOT IMPLEMENTED YET
  - TradeOver
```
public void TradeOver()
```
    NOT IMPLEMENTED YET
  - KeyPressed
```
public void KeyPressed(int key)
```
    NOT IMPLEMENTED YET
  - KeyReleased
```
public void KeyReleased(int key)
```
    NOT IMPLEMENTED YET
  - LastChatter
```
public int LastChatter()
```
    Retrieves the timestamp of the last chat message to the client.
    Not 2038 safe.
    
    Returns:
    
    int -- timestamp in seconds
  - LastChatterName
```
public java.lang.String LastChatterName()
```
    Retrieves the username of the individual who sent the last message to the client.
    
    Returns:
    
    String -- username
  - BankCount
```
public int BankCount(int item)
```
    Retrieves how many of `item` is inside the bank.
    
    Parameters:
    
    item - -- item id
    
    Returns:
    
    int
  - StrToInt
```
public int StrToInt(java.lang.String st)
```
    Converts a string to an integer.
    
    Parameters:
    
    st -
    
    Returns:
    
    int
  - IntToStr
```
public java.lang.String IntToStr(int num)
```
    Converts an integer to a string.
    
    Parameters:
    
    num -
    
    Returns:
    
    String
  - NPCX
```
public int NPCX(int id)
```
    Retrieves the X coordinates of a npc id.
    
    Parameters:
    
    id - -- npc id, not a server index.
    
    Returns:
    
    int
  - NPCY
```
public int NPCY(int id)
```
    Retrieves the Y coordinates of a npc id.
    
    Parameters:
    
    id - -- npc id, not a server index.
    
    Returns:
    
    int
  - IsAccepted
```
public boolean IsAccepted()
```
    Whether or not the trade recipient is accepting the current trade offer.
    
    Returns:
  - Quit
```
public void Quit()
```
    Exits the bot.
  - Distance
```
public int Distance(int x,
                    int y)
```
    Retrieves the distance between the player and the respective coordinates.
    
    Parameters:
    
    x -
    
    y -
    
    Returns:
  - TradeStatus
```
public int TradeStatus()
```
    The current status index of the trade.
    0: no trade 1: 1st trade window 2: 2nd trade window
    
    Returns:
  - AcceptTrade
```
public void AcceptTrade()
```
    Accepts the trade, as presented.
  - AcceptTrade2
```
public void AcceptTrade2()
```
    Accepts the 2nd trade window, as presented.
  - DeclineTrade
```
public void DeclineTrade()
```
    Declines the trade.
  - TradeArray
```
public void TradeArray(int item,
                       int amount)
```
    Puts up the respective item id, of the respective amount.
    
    Parameters:
    
    item -
    
    amount -
  - TradeArray
```
public void TradeArray(int[] item,
                       int[] amount)
```
    Puts up the respective item ids, of the respective amounts.
    
    Parameters:
    
    item - -- multiple ids
    
    amount - -- multiple amounts
  - ResetTrade
```
public void ResetTrade()
```
    Removes all items from the trade window.
  - CanReach
```
public boolean CanReach(int x,
                        int y)
```
    Retrieves whether or not the specified tile is currently reachable by the player.
    
    Parameters:
    
    x -
    
    y -
    
    Returns:
  - Beep
```
public void Beep()
```
    Plays a "beep" noise via AWT.
  - Wait
```
public void Wait(int ticks)
```
    Sleeps for the specified number of milliseconds.
    
    Parameters:
    
    ticks -
  - DisplayMessage
```
public void DisplayMessage(java.lang.String message,
                           int type)
```
    Displays a message to the user via the client chat window.
    
    Parameters:
    
    message - -- text (may contain @col@ etc)
    
    type - -- message type (index specified in orsc.enumerations.MessageType)
  - SetFightMode
```
public void SetFightMode(int style)
```
    Sets the fight mode to the specified style.
    
    Parameters:
    
    style -
  - GetFightMode
```
public int GetFightMode()
```
    Retrieves the current fight mode.
    
    Returns:
  - Println
```
public void Println(java.lang.String message)
```
    Prints a message, followed by newline, to the system console.
    
    Parameters:
    
    message -
  - Print
```
public void Print(java.lang.String message)
```
    Prints a message, with no newline, to the system console.
    
    Parameters:
    
    message -
  - SexyPrint
```
public void SexyPrint(java.lang.String message)
```
    Prints a nicely formatted message to the system console.
    
    Parameters:
    
    message -
  - ForceWalk
```
public void ForceWalk(int x,
                      int y)
```
    Walks to the specified tile, and does not give up until it is there.
    
    Parameters:
    
    x -
    
    y -
  - ForceWalkNoWait
```
public void ForceWalkNoWait(int x,
                            int y)
```
    Walks to the specified tile, and does not give up until it is there -- asynchronous.
    
    Parameters:
    
    x -
    
    y -
  - AtObject
```
public void AtObject(int x,
                     int y)
```
    Performs the 1st command action available on the object at the specified tile.
    
    Parameters:
    
    x -
    
    y -
  - AtObject
```
public void AtObject(int[] coords)
```
    Performs the 1st command action available on the object at the specified tile.
    
    Parameters:
    
    coords -
  - AtObject2
```
public void AtObject2(int x,
                      int y)
```
    Performs the 2nd command action available on the object at the specified tile.
    
    Parameters:
    
    x -
    
    y -
  - AtObject2
```
public void AtObject2(int[] coords)
```
    Performs the 2nd command action available on the object at the specified tile.
    
    Parameters:
    
    coords -
  - Walk
```
public void Walk(int x,
                 int y)
```
    Walks to the specified tile.
    
    Parameters:
    
    x -
    
    y -
  - Walk
```
public void Walk(int x,
                 int y,
                 int step)
```
    Some hacky SBot method for walking to a tile involving wait -- not recommended for use.
    
    Parameters:
    
    x -
    
    y -
    
    step -
  - WalkNoWait
```
public void WalkNoWait(int x,
                       int y)
```
    Walks to the specified tile -- asynchronous.
    
    Parameters:
    
    x -
    
    y -
  - TickCount
```
public long TickCount()
```
    Retrieves the current system time in milliseconds.
    
    Returns:
  - WalkEmpty
```
public void WalkEmpty(int x1,
                      int y1,
                      int x2,
                      int y2)
```
    Within the specified 2 points, walks to an empty tile within that rectangle.
    
    Parameters:
    
    x1 -
    
    y1 -
    
    x2 -
    
    y2 -
  - PlayerAt
```
public int PlayerAt(int x,
                    int y)
```
    Retrieves the server index of the player at the specified coordinates.
    
    Parameters:
    
    x -
    
    y -
    
    Returns:
  - Obstructed
```
public boolean Obstructed(int x,
                          int y)
```
    Whether or not the specified tile is reachable or obstructed.
    
    Parameters:
    
    x -
    
    y -
    
    Returns:
  - WalkEmptyNoWait
```
public void WalkEmptyNoWait(int x1,
                            int y1,
                            int x2,
                            int y2)
```
    Within the specified 2 points, walks to an empty tile within that rectangle -- asynchronous.
    
    Parameters:
    
    x1 -
    
    y1 -
    
    x2 -
    
    y2 -
  - GetX
```
public int GetX()
```
    Retrieves the current X coordinate of the player.
    
    Returns:
  - GetY
```
public int GetY()
```
    Retrieves the current Y coordinate of the player.
    
    Returns:
  - Rand
```
public int Rand(int lower,
                int higher)
```
    Returns a number between `low` and `higher`.
    
    Parameters:
    
    lower -
    
    higher -
    
    Returns:
  - Say
```
public void Say(java.lang.String message)
```
    Sends the specified message to the chat.
    
    Parameters:
    
    message -
  - EmptyTile
```
public boolean EmptyTile(int x,
                         int y)
```
    Whether or not the specified tile is empty.
    
    Parameters:
    
    x -
    
    y -
    
    Returns:
  - MagicPlayer
```
public void MagicPlayer(int player,
                        int spell)
```
    Casts the specified spell index against the specified player index.
    
    Parameters:
    
    player -
    
    spell -
  - UseOnPlayer
```
public void UseOnPlayer(int player,
                        int slot)
```
    NOT IMPLEMENTED YET
  - AttackPlayer
```
public void AttackPlayer(int player)
```
    Attacks the specified player index.
    
    Parameters:
    
    player -
  - DuelPlayer
```
public void DuelPlayer(int player)
```
    Sends a duel request to the specified player.
    
    Parameters:
    
    player -
  - TradePlayer
```
public void TradePlayer(int player)
```
    Trades the specified player.
    
    Parameters:
    
    player -
  - FollowPlayer
```
public void FollowPlayer(int player)
```
    Follows the specified player.
    
    Parameters:
    
    player -
  - MagicItem
```
public void MagicItem(int x,
                      int y,
                      int item,
                      int spell)
```
    Casts the specified magic index against the specified item id on the specified tile.
    
    Parameters:
    
    x -
    
    y -
    
    item -
    
    spell -
  - UseOnItem
```
public void UseOnItem(int x,
                      int y,
                      int type,
                      int item)
```
    Uses the specified inventory item on the specified ground item on the specified tile.
    
    Parameters:
    
    x -
    
    y -
    
    type - -- inventory item id
    
    item - -- ground item id
  - TakeItem
```
public boolean TakeItem(int x,
                        int y,
                        int type)
```
    Picks up the specified item on the ground.
    
    Parameters:
    
    x -
    
    y -
    
    type -
    
    Returns:
  - MagicNPC
```
public void MagicNPC(int id,
                     int spell)
```
    Casts the specified spell index against the specified npc server index.
    
    Parameters:
    
    id - -- server index
    
    spell -
  - UseOnNPC
```
public void UseOnNPC(int id,
                     int item)
```
    Uses the specified item against the specified npc server index.
    
    Parameters:
    
    id - -- server index
    
    item -
  - TalkToNPC
```
public void TalkToNPC(int serverIndex)
```
    Talks to the specified npc server index.
    
    Parameters:
    
    serverIndex -
  - AttackNPC
```
public void AttackNPC(int serverIndex)
```
    Attacks the specified npc server index.
    
    Parameters:
    
    serverIndex -
  - ThieveNPC
```
public void ThieveNPC(int serverIndex)
```
    Thieves the specified npc server index.
    
    Parameters:
    
    serverIndex -
  - MagicDoor
```
public void MagicDoor(int x,
                      int y,
                      int dir,
                      int spell)
```
    NOT IMPLEMENTED YET
  - UseOnDoor
```
public void UseOnDoor(int x,
                      int y,
                      int dir,
                      int item)
```
    Uses the specified item on the specified door tile.
    
    Parameters:
    
    x -
    
    y -
    
    dir - -- not used, put anything here.
    
    item - -- item id
  - OpenDoor
```
public void OpenDoor(int x,
                     int y,
                     int dir)
```
    Opens the door at the specified tile.
    
    Parameters:
    
    x -
    
    y -
    
    dir - -- not used, put anything here.
  - CloseDoor
```
public void CloseDoor(int x,
                      int y,
                      int dir)
```
    Closes the door at the specified tile.
    
    Parameters:
    
    x -
    
    y -
    
    dir - -- not used, put anything here.
  - MagicObject
```
public void MagicObject(int x,
                        int y,
                        int spell)
```
    Casts the specified spell index against the object at the specified tile.
    
    Parameters:
    
    x -
    
    y -
    
    spell -
  - UseOnObject
```
public void UseOnObject(int x,
                        int y,
                        int slotId)
```
    Uses the specified item from the specified slot on the specified object tile.
    
    Parameters:
    
    x -
    
    y -
    
    slotId -
  - Magic
```
public void Magic(int spell)
```
    Casts the specified spell id on the player.
  - QuestMenu
```
public boolean QuestMenu()
```
    Whether or not an NPC option menu is present.
    
    Returns:
  - Answer
```
public void Answer(int answer)
```
    Answers with the specified option answer when in a NPC dialogue.
    
    Parameters:
    
    answer -
  - MagicInventory
```
public void MagicInventory(int slot,
                           int spell)
```
    Casts the specified spell on the specified slot.
    
    Parameters:
    
    slot -
    
    spell -
  - UseWithInventory
```
public void UseWithInventory(int slot1,
                             int slot2)
```
    Uses the item at `slot1` on `slot2`.
    
    Parameters:
    
    slot1 -
    
    slot2 -
  - Remove
```
public void Remove(int slot)
```
    Removes the specified item at the specified slot, if equipped.
    
    Parameters:
    
    slot -
  - Wield
```
public void Wield(int slot)
```
    Wields the specified item at the specified slot, if equipped.
    
    Parameters:
    
    slot -
  - Use
```
public void Use(int slot)
```
    Uses the primary command on the item at the specified slot.
    
    Parameters:
    
    slot -
  - Drop
```
public void Drop(int slot)
```
    Drops one of the item at the specified slot.
    
    Parameters:
    
    slot -
  - Deposit
```
public void Deposit(int type,
                    int amount)
```
    Deposits the specified amount of the specified item.
    
    Parameters:
    
    type -
    
    amount -
  - Withdraw
```
public void Withdraw(int type,
                     int amount)
```
    Withdraws the specified amount of the specified item.
    
    Parameters:
    
    type -
    
    amount -
  - InvCount
```
public int InvCount(int type)
```
    Retrieves how many of the specified item id you have in your inventory.
    
    Parameters:
    
    type -
    
    Returns:
  - InvCount
```
public int InvCount()
```
    Retrieves how many items are in your inventory.
    
    Returns:
  - Logout
```
public void Logout()
```
    Attempts to logout.
  - GetNearestObject
```
public int[] GetNearestObject(int[] type)
```
    Retrieves the coordinates of the closest object in the specified array of object ids.
    
    Parameters:
    
    type -
    
    Returns:
  - GetNearestObject
```
public int[] GetNearestObject(int type)
```
    Retrieves the coordinates of the closest object id.
    
    Parameters:
    
    type -
    
    Returns:
  - GetNearestObject
```
public int[] GetNearestObject(int type,
                              int x1,
                              int y1,
                              int x2,
                              int y2)
```
    NOT IMPLEMENTED YET
  - GetNearestObject
```
public int[] GetNearestObject(int[] type,
                              int x1,
                              int y1,
                              int x2,
                              int y2)
```
    NOT IMPLEMENTED YET
  - GetNearestNPC
```
public int GetNearestNPC(int type)
```
    Retrieves the server index of the nearest npc of the specified npc id.
    
    Parameters:
    
    type -
    
    Returns:
  - GetNearestNPC
```
public int GetNearestNPC(int[] type)
```
    Retrieves the server index of the nearest npc from the specified npc ids.
    
    Parameters:
    
    type -
    
    Returns:
  - GetNearestNPC
```
public int GetNearestNPC(int type,
                         int x1,
                         int y1,
                         int x2,
                         int y2)
```
    NOT IMPLEMENTED YET
  - GetNearestNPC
```
public int GetNearestNPC(int[] type,
                         int x1,
                         int y1,
                         int x2,
                         int y2)
```
    NOT IMPLEMENTED YET
  - GetNearestItem
```
public int[] GetNearestItem(int type)
```
    Retrieves the coordinates of the nearest item id.
    
    Parameters:
    
    type -
    
    Returns:
  - GetNearestItem
```
public int[] GetNearestItem(int[] type)
```
    Retrieves the coordinates of the nearest item from the list of ids.
    
    Parameters:
    
    type -
    
    Returns:
  - CloseShop
```
public void CloseShop()
```
    Closes the current shop window.
  - CloseBank
```
public void CloseBank()
```
    Closes the current bank window.
  - Buy
```
public void Buy(int item)
```
    Buys 1 of the specified item id from the shop window.
    
    Parameters:
    
    item -
  - Sell
```
public void Sell(int item)
```
    Sells 1 of the specified item id from the shop window.
    
    Parameters:
    
    item -
  - Bank
```
public boolean Bank()
```
    Whether or not the bank window is currently open.
    
    Returns:
  - Shop
```
public boolean Shop()
```
    whether or not a shop window is currently open.
    
    Returns:
  - DoorAt
```
public int DoorAt(int x,
                  int y,
                  int dir)
```
    Whether or not the door at the specified coordinates is open or closed.
    1 = open 2 = closed
    
    Parameters:
    
    x -
    
    y -
    
    dir - -- not used, put anything in here.
    
    Returns:
  - ItemAt
```
public boolean ItemAt(int x,
                      int y,
                      int type)
```
    Whether or not an item of the specified type is at the specified coordinates.
    
    Parameters:
    
    x -
    
    y -
    
    type -
    
    Returns:
  - ObjectAt
```
public int ObjectAt(int x,
                    int y)
```
    Retrieves the object id at the specified coordinates.
    
    Parameters:
    
    x -
    
    y -
    
    Returns:
  - PlayerByName
```
public int PlayerByName(java.lang.String name)
```
    Retrieves the server index of the specified player name.
    
    Parameters:
    
    name -
    
    Returns:
  - GetExperience
```
public int GetExperience(int statno)
```
    Retrieves the experience in the specified skill.
    
    Parameters:
    
    statno -
    
    Returns:
  - GetCurrentStat
```
public int GetCurrentStat(int statno)
```
    Retrieves the current boosted/degraded stat of the specified skill.
    
    Parameters:
    
    statno -
    
    Returns:
  - GetStat
```
public int GetStat(int statno)
```
    Retrieves the skill level of the specified skill.
    
    Parameters:
    
    statno -
    
    Returns:
  - PlayerHP
```
public int PlayerHP(int id)
```
    Retrieves the HP level of the specified player index.
    
    Parameters:
    
    id -
    
    Returns:
  - InCombat
```
public boolean InCombat()
```
    Whether or not we are currently in combat.
    
    Returns:
  - PlayerInCombat
```
public boolean PlayerInCombat(int id)
```
    Whether or not the specified player is in combat.
    
    Parameters:
    
    id -
    
    Returns:
  - PlayerX
```
public int PlayerX(int id)
```
    Retrieves the X coordinate of the specified player index.
    
    Parameters:
    
    id -
    
    Returns:
  - PlayerY
```
public int PlayerY(int id)
```
    Retrieves the Y coordinate of the specified player index.
    
    Parameters:
    
    id -
    
    Returns:
  - PlayerDestX
```
public int PlayerDestX(int id)
```
    Retrieves the X coordinate of where the player index is currently headed.
    
    Parameters:
    
    id -
    
    Returns:
  - PlayerDestY
```
public int PlayerDestY(int id)
```
    Retrieves the Y coordinate of where the player index is currently headed.
    
    Parameters:
    
    id -
    
    Returns:
  - LastChatMessage
```
public java.lang.String LastChatMessage()
```
    Retrieves the last spoken chat message.
    
    Returns:
  - ResetLastChatMessage
```
public void ResetLastChatMessage()
```
    Not used, but remains for compatability.
  - LastNPCMessage
```
public java.lang.String LastNPCMessage()
```
    Retrieves the last quest message.
    
    Returns:
  - ResetLastNPCMessage
```
public void ResetLastNPCMessage()
```
    Not used, but remains for compatability.
  - LastServerMessage
```
public java.lang.String LastServerMessage()
```
    Retrieves the last server message.
    
    Returns:
  - ResetLastServerMessage
```
public void ResetLastServerMessage()
```
    Not used, but remains for compatability.
  - WaitForServerMessage
```
public void WaitForServerMessage(int timeout)
```
    Waits until a server message appears.
    
    Parameters:
    
    timeout -
  - InLastServerMessage
```
public boolean InLastServerMessage(java.lang.String st)
```
    Whether or not the specified substring is inside the last server message.
    
    Parameters:
    
    st -
    
    Returns:
  - FindInv
```
public int FindInv(int type)
```
    Retrieves the slot index of the specified item id.
    
    Parameters:
    
    type -
    
    Returns:
  - Running
```
public boolean Running()
```
    Whether or not the script is currenty running.
    
    Returns:
  - CheckFighters
```
public void CheckFighters(boolean check)
```
    Not used, but remains for compatability.
  - SleepWord
```
public void SleepWord()
```
    Not used, but remains for compatability.
  - Sleeping
```
public boolean Sleeping()
```
    Whether or not we are currently sleeping in a bag/bed.
    
    Returns:
  - Fatigue
```
public int Fatigue()
```
    Retrieves the current amount of fatigue.
    
    Returns:
  - Loading
```
public boolean Loading()
```
    Whether or not the client has loaded.
    
    Returns:
  - WaitForLoad
```
public void WaitForLoad()
```
    Waits for the client to finish loading.
  - PrayerOn
```
public void PrayerOn(int prayer)
```
    Turns on the specified prayer index.
    
    Parameters:
    
    prayer -
  - PrayerOff
```
public void PrayerOff(int prayer)
```
    Turns off the specified prayer index.
    
    Parameters:
    
    prayer -
  - Prayer
```
public boolean Prayer(int prayer)
```
    Whether or not the specified prayer index is currently on.
    
    Parameters:
    
    prayer -
    
    Returns:
  - ShopCount
```
public int ShopCount(int item)
```
    Retrieves how many of the specifed item id the shop has in stock.
    
    Parameters:
    
    item -
    
    Returns:
  - SetWorld
```
public void SetWorld(int world)
```
    Not used, but remains for compatability.
  - LastPlayerAttacked
```
public int LastPlayerAttacked()
```
    NOT IMPLEMENTED YET
  - ResetLastPlayerAttacked
```
public void ResetLastPlayerAttacked()
```
    NOT IMPLEMENTED YET
  - Login
```
public void Login(java.lang.String username,
                  java.lang.String password)
```
    Attempts to login with the specified user and password.
    
    Parameters:
    
    username -
    
    password -
  - LoggedIn
```
public boolean LoggedIn()
```
    Whether or not the player is currently logged in.
    
    Returns:
  - OpenUnbusyBank
```
public void OpenUnbusyBank()
```
    Opens a nearby bank (banker or chest.)
  - OpenBank
```
public void OpenBank()
```
    Opens a nearby bank (banker or chest.)
  - InStr
```
public boolean InStr(java.lang.String str,
                     java.lang.String locate)
```
    Whether or not the specified substring is inside the string.
    
    Parameters:
    
    str - -- string
    
    locate - -- substring
    
    Returns:
  - GetAnswer
```
public java.lang.String GetAnswer(int pos)
```
    Retrieves the text of the specified option answer in NPC dialogue.
    
    Parameters:
    
    pos -
    
    Returns:
  - GetDistance
```
public int GetDistance(int x1,
                       int y1,
                       int x2,
                       int y2)
```
    Retrieves the distance between two points.
    
    Parameters:
    
    x1 -
    
    y1 -
    
    x2 -
    
    y2 -
    
    Returns:
  - GetHP
```
public int GetHP()
```
    Retrieves the players current amount of health.
    
    Returns:
  - GetMaxHP
```
public int GetMaxHP()
```
    Retrieves the maximum amount of HP available to the player.
    
    Returns:
  - GetHPPercent
```
public int GetHPPercent()
```
    Retrieves the current percentage of player hp.
    
    Returns:
  - Inv
```
public int Inv(int slot)
```
    Retrieves the item id of the specified slot.
    
    Parameters:
    
    slot -
    
    Returns:
  - GetItemCommand
```
public java.lang.String GetItemCommand(int type)
```
    Retrieves the command of the specified item id.
    
    Parameters:
    
    type -
    
    Returns:
  - GetItemDesc
```
public java.lang.String GetItemDesc(int type)
```
    Retrieves the examine text of the specified item id.
    
    Parameters:
    
    type -
    
    Returns:
  - GetItemName
```
public java.lang.String GetItemName(int type)
```
    Retrieves the name of the specified item id.
    
    Parameters:
    
    type -
    
    Returns:
  - Username
```
public java.lang.String Username()
```
    Retrieves the name of the logged in user.
    
    Returns:
  - GetPrayerLevel
```
public int GetPrayerLevel(int prayer)
```
  - GetPrayerDrain
```
public int GetPrayerDrain(int prayer)
```
  - GetNPCCommand
```
public java.lang.String GetNPCCommand(int type)
```
  - GetNPCDesc
```
public java.lang.String GetNPCDesc(int type)
```
  - GetNPCLevel
```
public int GetNPCLevel(int type)
```
  - GetNPCType
```
public int GetNPCType(int id)
```
    NOT IMPLEMENTED YET
  - GetNPCMaxHP
```
public int GetNPCMaxHP(int type)
```
  - GetNPCName
```
public java.lang.String GetNPCName(int type)
```
  - GetAnswerCount
```
public int GetAnswerCount()
```
  - GetItemCount
```
public int GetItemCount()
```
  - GetNPCCount
```
public int GetNPCCount()
```
  - GetPlayerCount
```
public int GetPlayerCount()
```
  - GetObjectCount
```
public int GetObjectCount()
```
  - GetObjectCommand1
```
public java.lang.String GetObjectCommand1(int type)
```
  - GetObjectCommand2
```
public java.lang.String GetObjectCommand2(int type)
```
  - GetObjectDesc
```
public java.lang.String GetObjectDesc(int type)
```
  - GetObjectName
```
public java.lang.String GetObjectName(int type)
```
  - InArea
```
public boolean InArea(int x1,
                      int y1,
                      int x2,
                      int y2)
```
  - Wearable
```
public boolean Wearable(int type)
```
  - IsWorn
```
public boolean IsWorn(int slot)
```
    Since this function uses an item slot, on Coleslaw, it is permanently broken. Scripts will have to be rewritten which use this function on Coleslaw.
    
    Parameters:
    
    slot -
    
    Returns:
  - IsNPCAttackable
```
public boolean IsNPCAttackable(int type)
```
  - WalkPath
```
public void WalkPath(int[] pathx,
                     int[] pathy)
```
  - WalkPath
```
public void WalkPath(int[] pathx,
                     int[] pathy,
                     int ticks)
```
  - WalkPathReverse
```
public void WalkPathReverse(int[] pathx,
                            int[] pathy)
```
  - WalkPathReverse
```
public void WalkPathReverse(int[] pathx,
                            int[] pathy,
                            int ticks)
```
  - CoordsAt
```
public boolean CoordsAt(int[] pos)
```
  - CoordsAt
```
public boolean CoordsAt(int x,
                        int y)
```
  - IsWalking
```
public boolean IsWalking()
```
  - EndScript
```
public void EndScript()
```
  - AutoLogin
```
public boolean AutoLogin()
```
  - EnableAutoLogin
```
public void EnableAutoLogin()
```
  - DisableAutoLogin
```
public void DisableAutoLogin()
```
  - Version
```
public java.lang.String Version()
```
  - NPCExists
```
public boolean NPCExists(int id)
```
  - NPCInCombat
```
public boolean NPCInCombat(int id)
```
  - InvCountByName
```
public int InvCountByName(java.lang.String name)
```
  - InvByName
```
public int InvByName(java.lang.String name)
```
  - IsStackable
```
public boolean IsStackable(int id)
```
  - GetRandomNPC
```
public int GetRandomNPC(int id)
```
  - GetRandomNPC
```
public int GetRandomNPC(int[] id)
```
  - PID
```
public int PID()
```
    Not used, but remains for compatibility. "PID" is not a real thing on OpenRSC. Always returns 0.
    
    Returns:
  - WaitForBatchFinish
```
public void WaitForBatchFinish()
```
    New SBot function. On Coleslaw, if batching, sleeps until batching is finished.
  - IsBatching
```
public boolean IsBatching()
```
    New SBot function. On Coleslaw, returns whether or not we are currently batching.
    
    Returns:

Class Script

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Script

Method Detail

setController

start

getCommands

init

ServerMessage

ChatMessage

NPCMessage

TradeRequest

Accepted

TradeOver

KeyPressed

KeyReleased

LastChatter

LastChatterName

BankCount

StrToInt

IntToStr

NPCX

NPCY

IsAccepted

Quit

Distance

TradeStatus

AcceptTrade

AcceptTrade2

DeclineTrade

TradeArray

TradeArray

ResetTrade

CanReach

Beep

Wait

DisplayMessage

SetFightMode

GetFightMode

Println

Print

SexyPrint

ForceWalk

ForceWalkNoWait

AtObject

AtObject

AtObject2

AtObject2

Walk

Walk

WalkNoWait

TickCount

WalkEmpty

PlayerAt

Obstructed

WalkEmptyNoWait

GetX

GetY

Rand

Say

EmptyTile

MagicPlayer

UseOnPlayer

AttackPlayer

DuelPlayer

TradePlayer

FollowPlayer

MagicItem

UseOnItem

TakeItem

MagicNPC

UseOnNPC

TalkToNPC

AttackNPC

ThieveNPC

MagicDoor

UseOnDoor