Package rs.kreme.ksbot.api.scripts
Class Script
- java.lang.Object
-
- rs.kreme.ksbot.api.scripts.Script
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classScript.Status
-
Constructor Summary
Constructors Constructor Description Script()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.io.FilegetConfigFile()ScriptManifestgetManifest()java.io.FilegetStorageDirectory()booleanisOnBreak()booleanisPaused()booleanisRunning()booleanisStopped()booleanloadConfig()Loads the script's configuration.booleanonBreak()abstract intonProcess()booleanonStart()Called when the script starts.voidonStop()Called when the script stops.
-
-
-
Field Detail
-
ctx
public final KSContext ctx
-
-
Method Detail
-
onStart
public boolean onStart()
Called when the script starts. Override for custom behavior.
-
onStop
public void onStop()
Called when the script stops. Override for custom behavior.
-
loadConfig
public boolean loadConfig()
Loads the script's configuration.
-
onBreak
public boolean onBreak()
-
getManifest
public final ScriptManifest getManifest()
-
getConfigFile
public final java.io.File getConfigFile()
-
getStorageDirectory
public final java.io.File getStorageDirectory()
-
onProcess
public abstract int onProcess()
-
isRunning
public boolean isRunning()
-
isPaused
public boolean isPaused()
-
isStopped
public boolean isStopped()
-
isOnBreak
public boolean isOnBreak()
-
-