Package com.epicbot.api.shared.script

Class LoopScript

java.lang.Object

com.epicbot.api.shared.script.Script

com.epicbot.api.shared.script.LoopScript

Direct Known Subclasses:

TreeScript

public abstract class LoopScript
extends Script

A script that loops until a negative number is returned by loop(), otherwise this will run for ever.

This script has one ScriptTask that calls the loop() function. The amount to sleep is determined by the result of loop(). Therefore Script.setIterationDelay(int) is set to 0.

Constructor Summary

Constructors

Constructor	Description
LoopScript()

Method Summary

Modifier and Type	Method	Description
protected abstract int	loop()	The script loop function.

Methods inherited from class com.epicbot.api.shared.script.Script

addTask, antiRandom, getAPIContext, getIterationDelay, getLogger, getManifest, getRandomHandler, getScriptProfile, getScriptType, getSettingsDirectory, getState, getTaskContainer, init, isPaused, isRunning, isStopping, onBreak, onChatMessage, onGameTick, onPaint, onPause, onResume, onStart, onStop, pause, removeTask, removeTask, resume, setIterationDelay, startBreak, stop, submitTask

Methods inherited from class java.lang.Object

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

Constructor Details

LoopScript

public LoopScript()

Method Details

loop

protected abstract int loop()

The script loop function.

Returns:

a positive number of the amount the script should sleep or a negative number to the stop script