Package com.epicbot.api.shared.script

Class Script

java.lang.Object
com.epicbot.api.shared.script.Script
Direct Known Subclasses:
LoopScript
public abstract class Script extends Object

  • Constructor Details

    • Script

      public Script()

  • Method Details

    • init

      @Inject public void init()

    • onStart

      public abstract boolean onStart(String... args)

    • onBreak

      protected void onBreak()

    • onPause

      protected void onPause()

    • onResume

      protected void onResume()

    • onStop

      protected void onStop()

    • onGameTick

      protected void onGameTick(GameTickEvent event)

    • onChatMessage

      protected void onChatMessage(ChatMessageEvent event)

    • onPaint

      protected void onPaint(PaintContext paintContext, APIContext ctx)

    • getManifest

      public final ScriptManifest getManifest()

    • isRunning

      public final boolean isRunning()

    • isPaused

      public final boolean isPaused()

    • isStopping

      public final boolean isStopping()

    • getState

      public final ScriptState getState()

    • getLogger

      public final org.apache.logging.log4j.Logger getLogger()

    • resume

      public final void resume()

    • pause

      public final void pause(String reason)

    • startBreak

      public final void startBreak()

    • stop

      public final void stop(String reason)

    • antiRandom

      public final void antiRandom(String reason)

    • addTask

      public void addTask(ScriptTask task)

    • removeTask

      public void removeTask(ScriptTask task)

    • submitTask

      public void submitTask(LoopScriptTask task)

    • removeTask

      public void removeTask(LoopScriptTask task)

    • setIterationDelay

      public void setIterationDelay(int iterationDelay)
      The time to sleep after running/checking all tasks.

      Note: set to 0 when using LoopScript since LoopScript.loop() decides how long to sleep.

      Note: when using TreeScript this will be used as the time to sleep after each loop.

      Parameters:
      iterationDelay - the iteration delay/sleep

    • getIterationDelay

      public int getIterationDelay()
      Set the time to sleep after running/checking all tasks.
      Returns:
      int
      See Also:

    • getAPIContext

      public APIContext getAPIContext()

    • getTaskContainer

      public ScriptTaskContainer getTaskContainer()

    • getRandomHandler

      public RandomHandler getRandomHandler()

    • getScriptType

      public final ScriptType getScriptType()

    • getScriptProfile

      public final Optional<File> getScriptProfile()
      Get the profile/settings this script was started with by the script scheduler.
      Returns:
      File

    • getSettingsDirectory

      public final File getSettingsDirectory()
      Get the settings directory for this script.
      Returns:
      the directory, for example C:/Users/John/EpicBot/ScriptSettings/Pro Agility/