QuestHandler (app API)

java.lang.Object
- scripting.idlescript.AIOQuester.QuestHandler

Direct Known Subclasses:

_Example, BarCrawl, CooksAssistant, DoricsQuest, ErnestTheChicken, FishingContest, ImpCatcher, MonksFriend, PrinceAliRescue, RomeoAndJuliet, ScorpionCatcher, SheepShearer, TheRestlessGhost, TribalTotem, VampireSlayer, WitchsPotion
```
public abstract class QuestHandler
extends java.lang.Object
```
The superclass that AIOQuester quest scripts extend. Contains useful methods for quest script writing. Quest scripts MUST extend this class, or they will not be found by AIOQuester!

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.Map<java.lang.Integer,java.lang.Integer>`	`bankItems`
`protected static BotController`	`bc`
`protected static Controller`	`c`
`protected static java.lang.String`	`CURRENT_QUEST_STEP`
`protected static boolean`	`hasWalkedToStart`
`static PaintBuilder`	`paintBuilder`
`static QuestDef`	`quest`
`protected static int`	`QUEST_STAGE`
`static RowBuilder`	`rowBuilder`
`protected static Location`	`START_LOCATION`
`protected static int[][]`	`STEP_ITEMS`
`protected static boolean`	`timeToDrinkAntidote`

Constructor Summary

Constructors
Constructor and Description

QuestHandler()

Constructors
Constructor and Description
`QuestHandler()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`atObject(int[] coords)` Does c.atObject command and sleeps until you are moved to the destination, Climbs a ladder or stairs and sleeps until you are moved to the destination Also Supports going through fixed (does not stay open) doors
`static void`	`atObject(int x, int y)` Does c.atObject command and sleeps until you are moved to the destination.
`static void`	`atObject2(int[] coords)` Does c.atObject2 command and sleeps until you are moved to the destination, Climbs a ladder or stairs and sleeps until you are moved to the destination Also Supports going through a fixed (does not stay open) doors
`static void`	`atObject2(int x, int y)` Does c.atObject2 command and sleeps until you are moved to the destination, Climbs a ladder or stairs and sleeps until you are moved to the destination Also Supports going through fixed (does not stay open) doors
`static void`	`atObjectSequence(int[][] coords)` Interacts with objects in a given order based on coords.
`static void`	`atWallObject(int[] coords)` Opens a fixed (does not stay open) wall object (c.atWallObject()) and sleeps until you are moved to the destination
`static void`	`atWallObject(int x, int y)` Opens a fixed (does not stay open) wall object (c.atWallObject()) and sleeps until you are moved to the destination
`static void`	`atWallObject2(int[] coords)` Opens a fixed (does not stay open) wall object (c.atWallObject2())and sleeps until you are moved to the destination
`static void`	`atWallObject2(int x, int y)` Opens a fixed (does not stay open) wall object (c.atWallObject2())and sleeps until you are moved to the destination
`static void`	`climb(int[] coords)` Climbs a ladder or stairs and sleeps until you are moved to the destination Also Supports going through fixed (does not stay open) doors
`static void`	`climb(int x, int y)` Climbs a ladder or stairs and sleeps until you are moved to the destination
`static int`	`distanceFromTile(int[] coords)` Returns the distance the player is from the specified tile
`static int`	`distanceFromTile(MapPoint mapPoint)` Returns the distance the player is from the specified Map Point
`static void`	`drawPaint()` Draws the quest paint using PaintBuilder.
`static void`	`dropAllButAmount(int itemId, int amountToKeep)` Drops all of a given item id except one.
`static void`	`followNPCDialog(int npcId, java.lang.String[] dialogChoices)` Goes through a dialog with the nearest instance of a npc id with dialogChoices[] being the responses from the character.
`static void`	`followNPCDialogPopUps(int npcId, java.lang.String[] dialogChoices)` Goes through a dialog with the nearest instance of a npc id with dialogChoices[] being the responses from the character.
`static int`	`getQuestStage()` If TESTING_QUESTS is false, returns the quest's stage; if not, then it returns TESTING_STAGE
`static boolean`	`hasAtLeastItemAmount(int id, int amount)` Checks if the player has at least a certain amount of an item id.
`static boolean`	`hasAtLeastItemAmount(ItemId item, int amount)` Checks if the player has at least a certain amount of an ItemId.
`static boolean`	`hasSkillLevel(SkillId skill, int requiredLevel)` Checks if the player has the required level of a specified skill.
`static boolean`	`isAtCoords(int x, int y)` Returns whether the player is at a specific coordinate.
`static boolean`	`isAtLocation(Location location)` Checks if the player is within the boundary of a Location
`static boolean`	`isQuesting()` Returns whether the controller is still running; while handling sleep, afk anti-logout movement, setting QUEST_STAGE, and doing the initial walk to START_LOCATION.
`static void`	`openShopThenBuy(int[] npcIds, int[][] buyItems)` Opens the shop for the closest NPC with a given id and buys items from them.
`static void`	`openShopThenSell(int[] npcIds, int[][] sellItems)` Opens the shop for the closest NPC with a given id and sells items to them.
`static void`	`openShopThenSellAndBuy(int[] npcIds, int[][] sellItems, int[][] buyItems)` Opens the shop for the closest NPC with a given id and sells then buys items.
`static void`	`pathWalker(int[] coords)` Ideally, this will eventually be removed in place of walkToward().
`static void`	`pathWalker(int x, int y)` Ideally, this will eventually be removed in place of walkToward().
`static void`	`pathWalker(MapPoint mapPoint)` Ideally, this will eventually be removed in place of walkToward().
`static void`	`pickupGroundItem(int itemId, int amount)` Picks up the nearest item matching the given item id.
`static void`	`pickupUnreachableItem(int itemId, int[] standTile, int amount)` Walks to specified tile and picks up an item id from an unreachable tile.
`static void`	`quit(QuitReason reason)` Quits the script and prints out a corresponding message.
`static void`	`serverMessageInterrupt(java.lang.String message)` Check if the client receives a server message and do something with it.
`static void`	`sleepUntilQuestStageChanges()`
`static void`	`startTestingLoop()` Used for testing only
`static void`	`talkToNpcId(int npcId)` Talks to the nearest npc with the given id.
`static void`	`updateBankItems()` Update the bankItems Map from controller.getDebuggerBank().
`static void`	`useItemOnNearestNpcId(int npcId, int itemId)` Uses an item id on the nearest npc with matching npc id.
`static void`	`walkPath(int[][] path)` Ideally, this will eventually be removed in place of walkToward().
`static void`	`walkPathReverse(int[][] path)` Ideally, this will eventually be removed in place of walkToward().
`static void`	`walkToStartLocation()` Uses WebWalker to walk to the start location.
`static void`	`walkTowards(int x, int y)` Uses WebWalker to walk to a set of coordinates.
`static void`	`walkTowards(Location location)` Uses WebWalker to walk to a location's standable tile or if null, to the first corner in its bounds.

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

- Field Detail
  - c
```
protected static final Controller c
```
  - bc
```
protected static final BotController bc
```
  - paintBuilder
```
public static PaintBuilder paintBuilder
```
  - rowBuilder
```
public static RowBuilder rowBuilder
```
  - quest
```
public static QuestDef quest
```
  - bankItems
```
public static java.util.Map<java.lang.Integer,java.lang.Integer> bankItems
```
  - timeToDrinkAntidote
```
protected static boolean timeToDrinkAntidote
```
  - hasWalkedToStart
```
protected static boolean hasWalkedToStart
```
  - CURRENT_QUEST_STEP
```
protected static java.lang.String CURRENT_QUEST_STEP
```
  - QUEST_STAGE
```
protected static int QUEST_STAGE
```
  - STEP_ITEMS
```
protected static int[][] STEP_ITEMS
```
  - START_LOCATION
```
protected static Location START_LOCATION
```
- Constructor Detail
  - QuestHandler
```
public QuestHandler()
```
- Method Detail
  - startTestingLoop
```
public static void startTestingLoop()
```
    Used for testing only
  - walkToStartLocation
```
public static void walkToStartLocation()
```
    Uses WebWalker to walk to the start location.
  - walkTowards
```
public static void walkTowards(Location location)
```
    Uses WebWalker to walk to a location's standable tile or if null, to the first corner in its bounds.
    
    Parameters:
    
    location - - Location to walk to
  - walkTowards
```
public static void walkTowards(int x,
                               int y)
```
    Uses WebWalker to walk to a set of coordinates.
    
    Parameters:
    
    x - - X coordinate to walk to
    
    y - - y coordinate to walk to
  - hasAtLeastItemAmount
```
public static boolean hasAtLeastItemAmount(int id,
                                           int amount)
```
    Checks if the player has at least a certain amount of an item id.
    
    Parameters:
    
    id - int -- The item id to check
    
    amount - int -- The amount to check for
    
    Returns:
    
    boolean
  - hasAtLeastItemAmount
```
public static boolean hasAtLeastItemAmount(ItemId item,
                                           int amount)
```
    Checks if the player has at least a certain amount of an ItemId.
    
    Parameters:
    
    item - ItemId -- The ItemId to check
    
    amount - int -- The amount to check for
    
    Returns:
    
    boolean
  - hasSkillLevel
```
public static boolean hasSkillLevel(SkillId skill,
                                    int requiredLevel)
```
    Checks if the player has the required level of a specified skill.
    
    Parameters:
    
    skill - SkillId -- SkillId enum value
    
    requiredLevel - int -- Level required for the skill
    
    Returns:
    
    boolean -- Does the player have the specified skill level
  - isAtLocation
```
public static boolean isAtLocation(Location location)
```
    Checks if the player is within the boundary of a Location
    
    Parameters:
    
    location - Location to check
    
    Returns:
    
    boolean
  - isAtCoords
```
public static boolean isAtCoords(int x,
                                 int y)
```
    Returns whether the player is at a specific coordinate.
    
    Parameters:
    
    x - int - X coordinate to check
    
    y - int - Y coordinate to check
    
    Returns:
    
    boolean
  - isQuesting
```
public static boolean isQuesting()
```
    Returns whether the controller is still running; while handling sleep, afk anti-logout movement, setting QUEST_STAGE, and doing the initial walk to START_LOCATION. Use this for looping the stage switch in scripts.
    
    Returns:
    
    boolean
  - dropAllButAmount
```
public static void dropAllButAmount(int itemId,
                                    int amountToKeep)
```
    Drops all of a given item id except one.
    
    Parameters:
    
    itemId - int -- Id of the item to drop
    
    amountToKeep - int -- Amount of item to keep
  - openShopThenSell
```
public static void openShopThenSell(int[] npcIds,
                                    int[][] sellItems)
```
    Opens the shop for the closest NPC with a given id and sells items to them.
    
    Parameters:
    
    npcIds - int[] -- Ids of npcs to look for
    
    sellItems - int[][] -- ItemId/amount pairs. Example: {{SILK_ID, 1}, {EGG_ID, 12}}
  - openShopThenBuy
```
public static void openShopThenBuy(int[] npcIds,
                                   int[][] buyItems)
```
    Opens the shop for the closest NPC with a given id and buys items from them.
    
    Parameters:
    
    npcIds - int[] -- Ids of npcs to look for
    
    buyItems - int[][] -- ItemId/amount pairs. Example: {{SILK_ID, 1}, {EGG_ID, 12}}
  - openShopThenSellAndBuy
```
public static void openShopThenSellAndBuy(int[] npcIds,
                                          int[][] sellItems,
                                          int[][] buyItems)
```
    Opens the shop for the closest NPC with a given id and sells then buys items.
    
    Parameters:
    
    npcIds - int[] -- Ids of npcs to look for
    
    sellItems - int[][] -- ItemId/amount pairs. Example: {{SILK_ID, 1}, {EGG_ID, 12}}
    
    buyItems - int[][] -- ItemId/amount pairs. Example: {{SILK_ID, 1}, {EGG_ID, 12}}
  - pickupUnreachableItem
```
public static void pickupUnreachableItem(int itemId,
                                         int[] standTile,
                                         int amount)
```
    Walks to specified tile and picks up an item id from an unreachable tile. Keeps retrying ever two ticks until the specified amount is picked up.
    
    Parameters:
    
    itemId - int -- Id of the item to pick up
    
    standTile - int[] -- Tile to stand at to pick up item
    
    amount - int -- The amount to pick up
  - pickupGroundItem
```
public static void pickupGroundItem(int itemId,
                                    int amount)
```
    Picks up the nearest item matching the given item id. Keeps retrying every two ticks until the specified amount is picked up.
    
    Parameters:
    
    itemId - int -- Id of the item to pick up
    
    amount - int -- The amount to pick up
  - useItemOnNearestNpcId
```
public static void useItemOnNearestNpcId(int npcId,
                                         int itemId)
```
    Uses an item id on the nearest npc with matching npc id.
    
    Parameters:
    
    npcId - int -- Id of npc, not server index
    
    itemId - int -- Id of the item to use on the npc
  - talkToNpcId
```
public static void talkToNpcId(int npcId)
```
    Talks to the nearest npc with the given id.
    
    Parameters:
    
    npcId - int -- Id of the npc to talk to
  - followNPCDialogPopUps
```
public static void followNPCDialogPopUps(int npcId,
                                         java.lang.String[] dialogChoices)
```
    Goes through a dialog with the nearest instance of a npc id with dialogChoices[] being the responses from the character.
    This method is for pop up quest dialog after interacting with an object
    
    Parameters:
    
    npcId - int -- Id of the npc to talk to
    
    dialogChoices - String[] -- Responses to dialogs
  - followNPCDialog
```
public static void followNPCDialog(int npcId,
                                   java.lang.String[] dialogChoices)
```
    Goes through a dialog with the nearest instance of a npc id with dialogChoices[] being the responses from the character.
    
    Parameters:
    
    npcId - int -- Id of the npc to talk to
    
    dialogChoices - String[] -- Responses to dialogs
  - sleepUntilQuestStageChanges
```
public static void sleepUntilQuestStageChanges()
```
  - pathWalker
```
public static void pathWalker(MapPoint mapPoint)
```
    Ideally, this will eventually be removed in place of walkToward(). Uses PathWalkerApi to walk to a tile.
    
    Parameters:
    
    mapPoint - MapPoint -- Coordinates of the tile to walk to
  - pathWalker
```
public static void pathWalker(int[] coords)
```
    Ideally, this will eventually be removed in place of walkToward(). Uses PathWalkerApi to walk to a tile.
    
    Parameters:
    
    coords - int[] -- Coordinates of the tile to walk to
  - pathWalker
```
public static void pathWalker(int x,
                              int y)
```
    Ideally, this will eventually be removed in place of walkToward(). Uses PathWalkerApi to walk to a tile.
    
    Parameters:
    
    x - int -- X coordinate of the tile to walk to
    
    y - int -- Y coordinate of the tile to walk to
  - walkPath
```
public static void walkPath(int[][] path)
```
    Ideally, this will eventually be removed in place of walkToward(). Follows a given path while checking for and opening closed doors next to given tiles.
    
    Parameters:
    
    path - - Int[][] -- Each index is a different tile. Either {{X, Y}, {X2, Y2}} or {TILE1[],TILE2[]}
  - walkPathReverse
```
public static void walkPathReverse(int[][] path)
```
    Ideally, this will eventually be removed in place of walkToward(). Follows the reverse of a given path while checking for and opening closed doors next to given tiles.
    
    Parameters:
    
    path - - Int[][] -- Each index is a different tile. Either {{X, Y}, {X2, Y2}} or {TILE1[], TILE2[]}
  - distanceFromTile
```
public static int distanceFromTile(int[] coords)
```
    Returns the distance the player is from the specified tile
    
    Parameters:
    
    coords - int[] -- Coordinates to specified tile
    
    Returns:
    
    boolean -- Returns the distance from the tile
  - distanceFromTile
```
public static int distanceFromTile(MapPoint mapPoint)
```
    Returns the distance the player is from the specified Map Point
    
    Parameters:
    
    mapPoint - MapPoint -- MapPoint to check
    
    Returns:
    
    int -- Returns the distance from the MapPoint
  - atObject
```
public static void atObject(int[] coords)
```
    Does c.atObject command and sleeps until you are moved to the destination, Climbs a ladder or stairs and sleeps until you are moved to the destination Also Supports going through fixed (does not stay open) doors
    *Requires the object moving your coordinates*
    
    Parameters:
    
    coords - int[] -- Coordinates of an object
  - atObject2
```
public static void atObject2(int[] coords)
```
    Does c.atObject2 command and sleeps until you are moved to the destination, Climbs a ladder or stairs and sleeps until you are moved to the destination Also Supports going through a fixed (does not stay open) doors
    *Requires the object moving your coordinates*
    
    Parameters:
    
    coords - int[] -- Coordinates of an object
  - atObject
```
public static void atObject(int x,
                            int y)
```
    Does c.atObject command and sleeps until you are moved to the destination. Climbs a ladder or stairs and sleeps until you are moved to the destination. Also Supports going through a fixed (does not stay open) doors
    *Requires the object moving your coordinates*
    
    Parameters:
    
    x - int x coordinate of the object
    
    y - int y coordinate of the object
  - atObject2
```
public static void atObject2(int x,
                             int y)
```
    Does c.atObject2 command and sleeps until you are moved to the destination, Climbs a ladder or stairs and sleeps until you are moved to the destination Also Supports going through fixed (does not stay open) doors
    *Requires the object moving your coordinates*
    
    Parameters:
    
    x - int x coordinate of the object
    
    y - int y coordinate of the object
  - atWallObject
```
public static void atWallObject(int[] coords)
```
    Opens a fixed (does not stay open) wall object (c.atWallObject()) and sleeps until you are moved to the destination
    *Requires the object moving your coordinates*
    
    Parameters:
    
    coords - int[] -- Coordinates of a wall object
  - atWallObject2
```
public static void atWallObject2(int[] coords)
```
    Opens a fixed (does not stay open) wall object (c.atWallObject2())and sleeps until you are moved to the destination
    *Requires the object moving your coordinates*
    
    Parameters:
    
    coords - int[] -- Coordinates of a wall object
  - atWallObject
```
public static void atWallObject(int x,
                                int y)
```
    Opens a fixed (does not stay open) wall object (c.atWallObject()) and sleeps until you are moved to the destination
    *Requires the object moving your coordinates*
    
    Parameters:
    
    x - int x coordinate of the object
    
    y - int y coordinate of the object
  - atWallObject2
```
public static void atWallObject2(int x,
                                 int y)
```
    Opens a fixed (does not stay open) wall object (c.atWallObject2())and sleeps until you are moved to the destination
    *Requires the object moving your coordinates*
    
    Parameters:
    
    x - int x coordinate of the object
    
    y - int y coordinate of the object
  - climb
```
public static void climb(int[] coords)
```
    Climbs a ladder or stairs and sleeps until you are moved to the destination Also Supports going through fixed (does not stay open) doors
    
    Parameters:
    
    coords - int[] -- Coordinates of a climbable object
  - climb
```
public static void climb(int x,
                         int y)
```
    Climbs a ladder or stairs and sleeps until you are moved to the destination
    
    Parameters:
    
    x - int -- X coordinate of a climbable object
    
    y - int -- Y coordinate of a climbable object
  - atObjectSequence
```
public static void atObjectSequence(int[][] coords)
```
    Interacts with objects in a given order based on coords. This has no pathing between objects, so they must be clickable.
    
    Parameters:
    
    coords - - Int[][] -- Each index is a different Object's tile coordinates. Either {{X, Y}, {X2, Y2}} or {TILE1[], TILE2[]}
  - getQuestStage
```
public static int getQuestStage()
```
    If TESTING_QUESTS is false, returns the quest's stage; if not, then it returns TESTING_STAGE
    
    Returns:
    
    int -- Quest stage
  - updateBankItems
```
public static void updateBankItems()
```
    Update the bankItems Map from controller.getDebuggerBank(). This should always be run after opening a bank interface.
  - quit
```
public static void quit(QuitReason reason)
```
    Quits the script and prints out a corresponding message.
    
    Parameters:
    
    reason - QuestReason - Reason to quit
  - serverMessageInterrupt
```
public static void serverMessageInterrupt(java.lang.String message)
```
    Check if the client receives a server message and do something with it. This method is called in AIOQuester where it overrides IdleScripts serverMessageInterrupt()
    
    Parameters:
    
    message - String - Message to check for
  - drawPaint
```
public static void drawPaint()
```
    Draws the quest paint using PaintBuilder.

Class QuestHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

c

bc

paintBuilder

rowBuilder

quest

bankItems

timeToDrinkAntidote

hasWalkedToStart

CURRENT_QUEST_STEP

QUEST_STAGE

STEP_ITEMS

START_LOCATION

Constructor Detail

QuestHandler

Method Detail

startTestingLoop

walkToStartLocation

walkTowards

walkTowards

hasAtLeastItemAmount

hasAtLeastItemAmount

hasSkillLevel

isAtLocation

isAtCoords

isQuesting

dropAllButAmount

openShopThenSell

openShopThenBuy

openShopThenSellAndBuy

pickupUnreachableItem

pickupGroundItem

useItemOnNearestNpcId

talkToNpcId

followNPCDialogPopUps

followNPCDialog

sleepUntilQuestStageChanges

pathWalker

pathWalker

pathWalker

walkPath

walkPathReverse

distanceFromTile

distanceFromTile

atObject

atObject2

atObject

atObject2

atWallObject

atWallObject2

atWallObject

atWallObject2

climb

climb

atObjectSequence

getQuestStage

updateBankItems

quit

serverMessageInterrupt

drawPaint