Package org.dreambot.api.script

Class AbstractScript

java.lang.Object

org.dreambot.api.methods.MethodProvider

org.dreambot.api.script.AbstractScript

All Implemented Interfaces:

java.lang.Runnable, java.util.EventListener, Loggable, Sleepable, PaintListener

Direct Known Subclasses:

TaskScript, TreeScript

public abstract class AbstractScript
extends MethodProvider
implements java.lang.Runnable, PaintListener, Sleepable, Loggable

This is the base class of any script to be run on the client.

Please note that this class requires a ScriptManifest to be present in order to show up in the client.

What happens when a script is started:

1. onStart(String...) is called if script parameters are passed, otherwise onStart() will be called
2. The RandomManager is started, which will fire onSolverStart(RandomSolver) when those are wanting to run and onSolverEnd(RandomSolver) when they're complete
3. onLoop() is then repeatedly called until the script is stopped
4. After the script has stopped, onExit() is finally called

Constructor Summary

Constructors

Constructor	Description
AbstractScript()

Method Summary

Modifier and Type	Method	Description
void	buildRandomManager()	Creates the random manager and thread for this script
ScriptManager.State	getCurrentState()
ScriptManifest	getManifest()
RandomManager	getRandomManager()
java.lang.Thread	getRandomThread()
int	getScriptId()
ScriptManager	getScriptManager()
java.lang.String	getSDNName()
java.lang.String	getSDNParameters()	This is arbitrary data you've included in the SDN as a String
int	getStoreId()
java.lang.String	getThreadURL()
double	getVersion()
boolean	isPaused()
boolean	isUserSponsor()	Checks whether the DreamBot member logged into the client is a Sponsor or above (This includes but may not be limited to: Staff, Ex-Staff, Scripters, and Lead Designer)
boolean	isUserVIP()	Checks whether the DreamBot member logged into the client is a VIP member or above (this includes but may not be limited to: Staff, Ex-Staff, Sponsor, Scripters, and Lead Designer)
void	onExit()	Called when the script ends.
abstract int	onLoop()	This is the script's primary loop that runs as long as the script does.
void	onPaint(java.awt.Graphics graphics)	Handles the graphic for the script.
void	onPaint(java.awt.Graphics2D graphics)	Handles the graphic for the script.
void	onPause()	Called when the script is paused.
void	onResume()	Called when the script is resumed.
boolean	onScheduledStop()	Called when the DreamBot Scheduler wants to stop the current script.
void	onSolverEnd(RandomSolver solver)	Called after the random solver has ended.
boolean	onSolverStart(RandomSolver solver)	Called during the random solver reset stage, before solver.onStart is called.
void	onStart()	Called when the script starts with no script parameters passed in.
void	onStart(java.lang.String... params)	Called when the script is started with parameters
void	run()
void	setState(ScriptManager.State state)
void	stop()

Methods inherited from class org.dreambot.api.methods.MethodProvider

debug, error, info, log, print, sleep, sleep, sleepUntil, sleepUntil, sleepWhile, sleepWhile

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dreambot.api.script.frameworks.utility.Loggable

debug, debug, error, error, error, info, info, log, log, log, print, warn

Methods inherited from interface org.dreambot.api.script.frameworks.utility.Sleepable

sleep, sleep, sleepUntil, sleepUntil, sleepWhile, sleepWhile

Constructor Detail

AbstractScript

public AbstractScript()

Method Detail

onStart

public void onStart()

Called when the script starts with no script parameters passed in.

onStart

public void onStart(java.lang.String... params)

Called when the script is started with parameters

onSolverStart

public boolean onSolverStart(RandomSolver solver)

Called during the random solver reset stage, before solver.onStart is called. Must return true in order for the solver.onStart to be called, and the solver to begin.

Parameters:

solver - The Random Solver that is about to be activated

Returns:

True starts the solver, false will delay the start.

onSolverEnd

public void onSolverEnd(RandomSolver solver)

Called after the random solver has ended.

Parameters:

solver - The Random Solver that has just finished

onLoop

public abstract int onLoop()

This is the script's primary loop that runs as long as the script does.

Returns:

How long to wait in milliseconds before onLoop is called again. Note that returning a number less than 0 will result in the script being stopped.

onScheduledStop

public boolean onScheduledStop()

Called when the DreamBot Scheduler wants to stop the current script. Must return true in order for the script to actually begin stopping.

Returns:

True allows the script to stop, false will delay the stop

onExit

public void onExit()

Called when the script ends.

onPause

public void onPause()

Called when the script is paused.

onResume

public void onResume()

Called when the script is resumed.

onPaint

public void onPaint(java.awt.Graphics graphics)

Handles the graphic for the script.

Specified by:

onPaint in interface PaintListener

Parameters:

graphics - The Graphics instance sent from the canvas.

onPaint

public void onPaint(java.awt.Graphics2D graphics)

Handles the graphic for the script.

Specified by:

onPaint in interface PaintListener

Parameters:

graphics - The Graphics2D instance sent from the canvas.

buildRandomManager

public final void buildRandomManager()

Creates the random manager and thread for this script

stop

public void stop()

run

public final void run()

Specified by:

run in interface java.lang.Runnable

isPaused

public boolean isPaused()

setState

public void setState(ScriptManager.State state)

getManifest

public final ScriptManifest getManifest()

getVersion

public double getVersion()

getSDNName

public final java.lang.String getSDNName()

getThreadURL

public final java.lang.String getThreadURL()

getScriptId

public final int getScriptId()

getStoreId

public final int getStoreId()

getSDNParameters

public final java.lang.String getSDNParameters()

This is arbitrary data you've included in the SDN as a String

You can use this as a way to differentiate between scripts with a similar code base, such as a basic and advanced version, without needing to maintain two separate (but extremely similar) script repos/modules.

Returns:

The script parameters you've set on the SDN for this script, only shown during runs loaded from the SDN. If no parameters have been set, it will return an empty string.

getScriptManager

public ScriptManager getScriptManager()

Overrides:

getScriptManager in class MethodProvider

isUserVIP

public boolean isUserVIP()

Checks whether the DreamBot member logged into the client is a VIP member or above (this includes but may not be limited to: Staff, Ex-Staff, Sponsor, Scripters, and Lead Designer)

Overrides:

isUserVIP in class MethodProvider

Returns:

true if VIP or above

isUserSponsor

public boolean isUserSponsor()

Checks whether the DreamBot member logged into the client is a Sponsor or above (This includes but may not be limited to: Staff, Ex-Staff, Scripters, and Lead Designer)

Overrides:

isUserSponsor in class MethodProvider

Returns:

true if Sponsor or above

getCurrentState

public ScriptManager.State getCurrentState()

getRandomManager

public RandomManager getRandomManager()

Overrides:

getRandomManager in class MethodProvider

getRandomThread

public java.lang.Thread getRandomThread()