org.osbot.rs07.script

Class Script

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.Script

All Implemented Interfaces:

Painter, AudioListener, ConfigListener, GameTickListener, LoginResponseCodeListener, MessageListener

Direct Known Subclasses:

Plugin, RandomSolver

public abstract class Script
extends MethodProvider
implements Painter, MessageListener, ConfigListener, LoginResponseCodeListener, AudioListener, GameTickListener

Represents the base of a script.

Field Summary

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, bot, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
Script()

Method Summary

Modifier and Type	Method and Description
boolean	canStart() Functionality to execute code before any login validation and calling onStart() Return false to keep looping this method.
void	complete() Signals this Script has finished execution.
void	complete(boolean logout) Signals this Script has finished execution.
java.lang.String	getAuthor() Gets the author of the script.
java.io.InputStream	getDataResourceAsStream(java.lang.String name) Scripts are allowed to access the OSBot Data folder; this method returns an InputStream of a file relative to this Data folder.
java.lang.String	getDirectoryData() Scripts are limited to working inside the Data folder, you may append files inside this directory.
java.lang.String	getName() Gets the name of the script.
java.lang.String	getParameters()
int	getRecommendedMirrorFps() Gets recommended fps for mirror client.
int	getRecommendedMirrorReactionTime() Gets recommended reaction time for mirror client.
int	getScriptId() Gets the id of this script, when launched from the SDN.
java.io.InputStream	getScriptResourceAsStream(java.lang.String name)
double	getVersion() Gets the version of the script.
boolean	isPlugin() Deprecated.
void	onConfig(int id, int value) Event listener used for callbacks on config change events
void	onExit() Called when this script exits and after the event queue has been terminated.
void	onGameTick() Do not do any calculations (or anything computational) in this.
abstract int	onLoop() Called by the script executor.
void	onMessage(Message message) Event listener used for callbacks on message events
void	onPaint(java.awt.Graphics2D g) Called when the next frame should be painted.
void	onPlayAudio(int track)
void	onResponseCode(int code)
void	onStart() Called when this script gets started.
void	onStop() Called when this script stops and before the event queue has been terminated.
void	pause() This method gets called when the ScriptExecutor gets suspended or paused.
void	resume() This method gets called when the ScriptExecutor gets resumed.
Script	setParameters(java.lang.String parameters) Deprecated.
void	setScriptId(int scriptId) Deprecated.
void	stop() Stops the script and will logout the accounts.
void	stop(boolean logout) Stops the script by stopping the script executor threads.

Methods inherited from class org.osbot.rs07.script.MethodProvider

exchangeContext, execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

Script

public Script()

Method Detail

getScriptId

public int getScriptId()

Gets the id of this script, when launched from the SDN.

Returns:

The id of this script, when launched from the SDN.

setScriptId

@Deprecated
public void setScriptId(int scriptId)

Deprecated.

Internal use only

Parameters:

scriptId - The id of the script

isPlugin

@Deprecated
public boolean isPlugin()

Deprecated.

Internal use only - this method will be removed at some point!

Returns:

false

getDirectoryData

public java.lang.String getDirectoryData()

Scripts are limited to working inside the Data folder, you may append files inside this directory.
Usage: new File(getDirectoryData()+getName()+File.separator+"info.txt");

Returns:

The directory of OSBot's Data folder

getScriptResourceAsStream

public java.io.InputStream getScriptResourceAsStream(java.lang.String name)

getDataResourceAsStream

public java.io.InputStream getDataResourceAsStream(java.lang.String name)
                                            throws java.io.FileNotFoundException

Scripts are allowed to access the OSBot Data folder; this method returns an InputStream of a file relative to this Data folder. If your resource is packaged with your script, please use getScriptResourceAsStream instead.

Parameters:

name - The name of the file

Returns:

InputStream of a file relative to getDataDirectory()

Throws:

java.io.FileNotFoundException - Thrown when the file could not be found

setParameters

@Deprecated
public Script setParameters(java.lang.String parameters)

Deprecated.

getParameters

public java.lang.String getParameters()

getName

public java.lang.String getName()

Gets the name of the script.

Returns:

The name of the script.

getAuthor

public java.lang.String getAuthor()

Gets the author of the script.

Returns:

The author of the script.

getVersion

public double getVersion()

Gets the version of the script.

Returns:

The version of the script.

getRecommendedMirrorReactionTime

public int getRecommendedMirrorReactionTime()

Gets recommended reaction time for mirror client.

Returns:

The reaction time or -1 if user selected one should be used.

getRecommendedMirrorFps

public int getRecommendedMirrorFps()

Gets recommended fps for mirror client.

Returns:

The fps or -1 if user selected one should be used.

canStart

public boolean canStart()

Functionality to execute code before any login validation and calling onStart() Return false to keep looping this method. Return true to continue script startup flow.

Returns:

True to login and call onStart()

onStart

public void onStart()
             throws java.lang.InterruptedException

Called when this script gets started. This method may be overridden.

Throws:

java.lang.InterruptedException - Throws when execution is interrupted

onLoop

public abstract int onLoop()
                    throws java.lang.InterruptedException

Called by the script executor. This method should return a Cycle instance with the next event to run and its respective wait time.

Returns:

The Cycle instance.

Throws:

java.lang.InterruptedException - Throws when execution is interrupted

onPaint

public void onPaint(java.awt.Graphics2D g)

Called when the next frame should be painted.

Specified by:

onPaint in interface Painter

Parameters:

g - The Graphics2D context.

onMessage

public void onMessage(Message message)
               throws java.lang.InterruptedException

Event listener used for callbacks on message events

Specified by:

onMessage in interface MessageListener

Parameters:

message - The Message instance

Throws:

java.lang.InterruptedException

onConfig

public void onConfig(int id,
                     int value)
              throws java.lang.InterruptedException

Event listener used for callbacks on config change events

Specified by:

onConfig in interface ConfigListener

Parameters:

id - The id of the config

value - The new value of the config

Throws:

java.lang.InterruptedException

onResponseCode

public void onResponseCode(int code)
                    throws java.lang.InterruptedException

Specified by:

onResponseCode in interface LoginResponseCodeListener

Throws:

java.lang.InterruptedException

onPlayAudio

public void onPlayAudio(int track)

Specified by:

onPlayAudio in interface AudioListener

onGameTick

public void onGameTick()

Do not do any calculations (or anything computational) in this. It should only be used for setting a variable to show the script that a tick has occurred.

Specified by:

onGameTick in interface GameTickListener

onStop

public void onStop()
            throws java.lang.InterruptedException

Called when this script stops and before the event queue has been terminated. This method can be used for final interactions with the game before the script is terminated. However, execution can't be guaranteed. This depends on account login state.

Throws:

java.lang.InterruptedException - Throws when execution is interrupted

onExit

public void onExit()
            throws java.lang.InterruptedException

Called when this script exits and after the event queue has been terminated. This method therefor can't be used to interact with the game and is called after onStop().

Throws:

java.lang.InterruptedException - Throws when execution is interrupted

stop

public final void stop()

Stops the script and will logout the accounts.

stop

public final void stop(boolean logout)

Stops the script by stopping the script executor threads. Will logout if desired.

Parameters:

logout - True if you want the account to logout.

complete

public final void complete()

Signals this Script has finished execution. In case of a script queue, it will start the next script. Otherwise it will be equal to calling stop()

complete

public final void complete(boolean logout)

Signals this Script has finished execution. In case of a script queue, it will start the next script. Otherwise it will be equal to calling stop()

Parameters:

logout - True if you want the account to logout if this is the last script in the queue.

pause

public void pause()

This method gets called when the ScriptExecutor gets suspended or paused. Usage of overriding this method could be for example shutting down/pausing/suspending any runnables/threads that run outside the OSBot threading. Examples of cases where this method gets called are: pausing a script, activation of a random handler.

resume

public void resume()

This method gets called when the ScriptExecutor gets resumed. Usage of overriding this method could be for example resuming any runnables/threads that run outside the OSBot threading.