scripting.idlescript

Class IdleScript

java.lang.Object

scripting.idlescript.IdleScript

Direct Known Subclasses:

AIOAIO, AIOCooker, AIOFighter, AIOMagic, AIOMiner, AIOQuester, AIOSmelter, AIOThiever, AKMiner, AlchWheat, AntiDragonShields, ArrowMaker, CasketFisher, CatherbyFishFarm, ColeslawGuildFisher, CraftingGuildMining, DamRc, DamWildyAgility, DropEverything, EssenceMiner, FarmBankEverything, FarmDropItemById, FarmFollow, FarmGetBankItems, FarmGetInventoryItems, FarmLogout, FarmMassAcceptShantay, FarmMassGive, FarmMassTake, FarmTradeEverything, Flaxx0r, FletchnBankBows, FoulRunecraft, GetMeToArdougne, GnomeFlaxx0r, HarvesterTrainer, HerbHarvester, HerbIdentifier, K_kailaScript, Ledger, LimpySnapez, MiningGuild, Monkz, ObtainSleepingBag, PotionDrinker, PotionMaker, PowercraftTalisman, PowerFletcha, S_CurseGrapesZ, SeattaScript, SellToShop, ShearSheep, SkipTutorialIsland, SmithGearSet, SmithingVarrock, SpinStrings, TaverlyBuyer, VialCrafter, WebwalkTester, Wildberries, Woodcutting

public abstract class IdleScript
extends java.lang.Object

This is the base class from which all IdleScript scripts are derived; this class also contains interrupts called by patched client hooks.

Field Summary

Fields

Modifier and Type	Field and Description
protected PaintBuilder	paintBuilder
protected RowBuilder	rowBuilder

Constructor Summary

Constructors

Constructor and Description
IdleScript()

Method Summary

Modifier and Type	Method and Description
void	chatCommandInterrupt(java.lang.String commandText) This is called by CommandCallback if a player types a "::" command into the chatbox.
void	chatMessageInterrupt(java.lang.String message) Called by MessageCallback every time a new chat message is drawn on the screen.
void	keyPressInterrupt(int keyCode) This is called by KeyCallback every time the user presses a key.
void	npcDamagedInterrupt(int currentHealth, int damageAmount) This is called by DamageCallback every time the NPC we are currently fighting is damaged.
void	paintInterrupt() This will be called by DrawCallback every game frame.
void	playerDamagedInterrupt(int currentHealth, int damageAmount) This is called by DamageCallback every time the player is damaged.
void	privateMessageReceivedInterrupt(java.lang.String sender, java.lang.String message) Called by MessageCallback every time a new private message is received on the screen.
void	questMessageInterrupt(java.lang.String message) Called by MessageCallback every time a new quest message is drawn on the screen.
void	serverMessageInterrupt(java.lang.String message) Called by MessageCallback every time a new server message is drawn on the screen.
void	setController(Controller _controller)
int	start(java.lang.String[] parameters) This function is the entry point for the program.
void	tradeMessageInterrupt(java.lang.String message) Called by MessageCallback every time a new trade message is drawn on the screen.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

paintBuilder

protected PaintBuilder paintBuilder

rowBuilder

protected RowBuilder rowBuilder

Constructor Detail

IdleScript

public IdleScript()

Method Detail

serverMessageInterrupt

public void serverMessageInterrupt(java.lang.String message)

Called by MessageCallback every time a new server message is drawn on the screen. Override this in your script to process these messages.

Parameters:

message - -- variable containing the message.

privateMessageReceivedInterrupt

public void privateMessageReceivedInterrupt(java.lang.String sender,
                                            java.lang.String message)

Called by MessageCallback every time a new private message is received on the screen. Override this in your script to process these messages.

Parameters:

sender - -- variable containing the sender.

message - -- variable containing the message.

chatMessageInterrupt

public void chatMessageInterrupt(java.lang.String message)

Called by MessageCallback every time a new chat message is drawn on the screen. Override this in your script to process these messages.

Parameters:

message - -- variable containing the message.

questMessageInterrupt

public void questMessageInterrupt(java.lang.String message)

Called by MessageCallback every time a new quest message is drawn on the screen. Override this in your script to process these messages.

Parameters:

message - -- variable containing the message.

tradeMessageInterrupt

public void tradeMessageInterrupt(java.lang.String message)

Called by MessageCallback every time a new trade message is drawn on the screen. Override this in your script to process these messages.

Parameters:

message - -- variable containing the message.

setController

public void setController(Controller _controller)

start

public int start(java.lang.String[] parameters)

This function is the entry point for the program. It takes an array of parameters and executes script based on the values of the parameters.
Parameters in this context can be from CLI parsing or in the script options parameters text box

Parameters:

parameters - an array of String values representing the parameters passed to the function

paintInterrupt

public void paintInterrupt()

This will be called by DrawCallback every game frame. Override this in your script to paint on the screen.

npcDamagedInterrupt

public void npcDamagedInterrupt(int currentHealth,
                                int damageAmount)

This is called by DamageCallback every time the NPC we are currently fighting is damaged. Override this in your script to intercept hitsplats.

playerDamagedInterrupt

public void playerDamagedInterrupt(int currentHealth,
                                   int damageAmount)

This is called by DamageCallback every time the player is damaged. Override this in your script to intercept hitsplats.

chatCommandInterrupt

public void chatCommandInterrupt(java.lang.String commandText)

This is called by CommandCallback if a player types a "::" command into the chatbox. Override this in your script to intercept and read these.

keyPressInterrupt

public void keyPressInterrupt(int keyCode)

This is called by KeyCallback every time the user presses a key. Override this in your script to implement actions on key presses.