Bot

java.lang.Object
- org.osbot.core.AbstractBot
- - org.osbot.rs07.Bot

public class Bot
extends org.osbot.core.AbstractBot

Field Summary

Fields
Modifier and Type Field and Description

org.osbot.core.debug.ShapeDebugger shapeDebug

Fields
Modifier and Type	Field and Description
`org.osbot.core.debug.ShapeDebugger`	`shapeDebug`

Constructor Summary

Constructors
Constructor and Description

Bot(int id, java.lang.String world, int revision, org.osbot.core.account.RSAccount account)

Constructors
Constructor and Description
`Bot(int id, java.lang.String world, int revision, org.osbot.core.account.RSAccount account)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAudioListener(AudioListener listener)` Adds an audio event listener.
`void`	`addConfigListener(ConfigListener listener)` Adds a config event listener.
`void`	`addGameTickListener(GameTickListener listener)` Adds a game tick listener.
`void`	`addKeyListener(BotKeyListener listener)` Adds a key event listener.
`void`	`addLoginListener(LoginResponseCodeListener listener)` Adds a login event listener.
`void`	`addMessageListener(MessageListener listener)` Adds a message event listener.
`void`	`addMouseListener(BotMouseListener listener)` Adds a mouse event listener.
`void`	`addPainter(Painter painter)` Adds a painter to the bot canvas.
`void`	`cleanup()` Deprecated.
`void`	`clearEventQueue()`
`void`	`closeSelf()`
`void`	`dispatchAudioEvent(int cacheIndex)`
`void`	`dispatchConfigEvent(int id)`
`void`	`dispatchGameTick()`
`void`	`dispatchLoginEvent(int id)`
`void`	`dispatchMessageEvent(Message message)`
`void`	`executeListenerEvents()` Deprecated.
`java.util.Set<AudioListener>`	`getAudioListeners()` Gets a set of registered audio event listeners.
`org.osbot.rs07.canvas.BotPanel`	`getBotPanel()`
`java.util.concurrent.Callable<java.lang.Boolean>`	`getBreakCondition()`
`org.osbot.rs07.canvas.WrappedCanvas`	`getCanvas()` Gets the canvas wrapper associated with this bot.
`Client`	`getClient()` Gets the client wrapper associated with this bot.
`java.util.Set<ConfigListener>`	`getConfigListeners()` Gets a set of registered config event listeners.
`java.lang.String`	`getDisplayName()`
`EventExecutor`	`getEventExecutor()` Gets the event executor for dispatching and controlling events.
`ClientFocusEventHandler`	`getFocusEventHandler()` Gets the focus event handler for directly dispatching focus events to the client.
`java.util.Set<GameTickListener>`	`getGameTickListeners()` Gets a set of registered game tick listeners.
`int`	`getId()` Gets the unique ID number representing this bot.
`java.lang.String`	`getIdentifierFileName()` Gets the file name that's used to track this RuneScape account by Jagex.
`ClientKeyEventHandler`	`getKeyEventHandler()` Gets the key event handler for directly dispatching key events to the client.
`java.util.Set<BotKeyListener>`	`getKeyListeners()` Gets a set of registered mouse event listeners.
`long`	`getLastGainedXPTimeThreshold()` See `setLastGainedXPTimeThreshold(TimeUnit, int)`
`java.lang.String`	`getLoadingStage()`
`int`	`getLoadingStageErrorCode()`
`java.util.Set<LoginResponseCodeListener>`	`getLoginResponseCodeListeners()` Gets a set of registered login event listeners.
`java.util.Set<MessageListener>`	`getMessageListeners()` Gets a set of registered message event listeners.
`MethodProvider`	`getMethods()` Gets the `MethodProvider` context associated with this bot.
`ClientMouseEventHandler`	`getMouseEventHandler()` Gets the mouse event handler for directly dispatching mouse events to the client.
`java.util.Set<BotMouseListener>`	`getMouseListeners()` Gets a set of registered mouse event listeners.
`MouseMoveProfile`	`getMouseMoveProfile()`
`java.util.Set<Painter>`	`getPainters()` Gets the set of painters currently registered.
`RandomExecutor`	`getRandomExecutor()` Gets the random executor for controlling random solvers.
`ScriptExecutor`	`getScriptExecutor()` Gets the script executor for controlling scripts.
`org.osbot.core.debug.ShapeDebugger`	`getShapeDebugger()` A debugger tool which can cache Shapes to debug them.
`org.osbot.core.gui.side.TabPanel`	`getTabPanel()`
`int`	`getTimeUntilNextBreak()` Gets the time (in seconds) until the next break will occur.
`void`	`initialize()` Deprecated.
`boolean`	`isBreakSettingEnabled()` Checks if the breaks setting is enabled
`boolean`	`isDefaultUser()` Checks whether or not this bot is assigned to the default user
`boolean`	`isLoaded()`
`boolean`	`isMirrorMode()` Checks if the bot is using mirror mode
`boolean`	`isStopped()`
`boolean`	`lowCpu()`
`void`	`removeAudioListener(AudioListener listener)` Removes an audio event listener.
`void`	`removeConfigListener(ConfigListener listener)` Removes a config event listener.
`void`	`removeGameTickListener(GameTickListener listener)` Removes a game tick listener.
`void`	`removeKeyListener(BotKeyListener listener)` Removes a key event listener.
`void`	`removeLoginListener(LoginResponseCodeListener listener)` Removes a config event listener.
`void`	`removeMessageListener(MessageListener listener)` Removes a mouse event listener.
`void`	`removeMouseListener(BotMouseListener listener)` Removes a mouse event listener.
`void`	`removePainter(Painter painter)` Removes a painter from the bot canvas.
`void`	`resetExtensions()`
`void`	`sendAppletEvent(java.awt.AWTEvent event)`
`void`	`sendWebhookMessageToManager(org.osbot.rs07.utility.webhooks.WebhookMessage message)`
`void`	`setBreakCondition(java.util.concurrent.Callable<java.lang.Boolean> breakCondition)`
`void`	`setCanvas(org.osbot.rs07.canvas.WrappedCanvas canvas)` Deprecated.
`void`	`setLastGainedXPTimeThreshold(java.util.concurrent.TimeUnit timeUnit, int lastGainedXPTimeThreshold)` MUST BE SET IN `Script.onStart()` to above 0.
`void`	`setLoadingStage(java.lang.String loadingStage)`
`void`	`setMouseMoveProfile(MouseMoveProfile mouseMoveProfile)`
`void`	`stop()` Deprecated.
`boolean`	`switchAccount(java.lang.String username, java.lang.String password, int pin)`
`boolean`	`tryFinishLoading()` Deprecated.

Methods inherited from class org.osbot.core.AbstractBot
getLogger, getRevision, getType, getUsername, getWorld

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - shapeDebug
```
public final org.osbot.core.debug.ShapeDebugger shapeDebug
```
- Constructor Detail
  - Bot
```
public Bot(int id,
           java.lang.String world,
           int revision,
           org.osbot.core.account.RSAccount account)
```
- Method Detail
  - isDefaultUser
```
public boolean isDefaultUser()
```
    Checks whether or not this bot is assigned to the default user
    
    Returns:
    
    True if this bot is assigned to the default user, otherwise false
  - getDisplayName
```
public java.lang.String getDisplayName()
```
  - getTabPanel
```
public org.osbot.core.gui.side.TabPanel getTabPanel()
```
  - getShapeDebugger
```
public org.osbot.core.debug.ShapeDebugger getShapeDebugger()
```
    A debugger tool which can cache Shapes to debug them.
    
    Returns:
    
    The shape debugger
  - getLoadingStageErrorCode
```
public int getLoadingStageErrorCode()
```
  - getBreakCondition
```
public java.util.concurrent.Callable<java.lang.Boolean> getBreakCondition()
```
  - setBreakCondition
```
public void setBreakCondition(java.util.concurrent.Callable<java.lang.Boolean> breakCondition)
```
  - switchAccount
```
public boolean switchAccount(java.lang.String username,
                             java.lang.String password,
                             int pin)
```
  - getBotPanel
```
public org.osbot.rs07.canvas.BotPanel getBotPanel()
```
  - getLoadingStage
```
public java.lang.String getLoadingStage()
```
  - setLoadingStage
```
public void setLoadingStage(java.lang.String loadingStage)
```
  - getIdentifierFileName
```
public java.lang.String getIdentifierFileName()
```
    Gets the file name that's used to track this RuneScape account by Jagex.
    
    Returns:
    
    The file name that's used to track this RuneScape account by Jagex.
  - isLoaded
```
public boolean isLoaded()
```
  - isStopped
```
public boolean isStopped()
```
  - getId
```
public int getId()
```
    Description copied from class: org.osbot.core.AbstractBot
    
    Gets the unique ID number representing this bot.
    
    Overrides:
    
    getId in class org.osbot.core.AbstractBot
    
    Returns:
    
    The ID.
  - isMirrorMode
```
public boolean isMirrorMode()
```
    Checks if the bot is using mirror mode
    
    Returns:
    
    True if the bot is using mirror mode
  - isBreakSettingEnabled
```
public boolean isBreakSettingEnabled()
```
    Checks if the breaks setting is enabled
    
    Returns:
    
    True if the breaks setting is enabled
  - getClient
```
public Client getClient()
```
    Gets the client wrapper associated with this bot.
    
    Returns:
    
    The client instance
  - getCanvas
```
public org.osbot.rs07.canvas.WrappedCanvas getCanvas()
```
    Gets the canvas wrapper associated with this bot.
    
    Returns:
    
    The canvas instance
  - setCanvas
```
@Deprecated
public void setCanvas(org.osbot.rs07.canvas.WrappedCanvas canvas)
```
    Deprecated.
  - getScriptExecutor
```
public ScriptExecutor getScriptExecutor()
```
    Gets the script executor for controlling scripts.
    
    Returns:
    
    The script executor instance
  - getRandomExecutor
```
public RandomExecutor getRandomExecutor()
```
    Gets the random executor for controlling random solvers.
    
    Returns:
    
    The random executor instance
  - getEventExecutor
```
public EventExecutor getEventExecutor()
```
    Gets the event executor for dispatching and controlling events.
    
    Returns:
    
    The event executor instance3
  - getMethods
```
public MethodProvider getMethods()
```
    Gets the MethodProvider context associated with this bot.
    
    Specified by:
    
    getMethods in class org.osbot.core.AbstractBot
    
    Returns:
    
    The method provider instance
  - getMouseEventHandler
```
public ClientMouseEventHandler getMouseEventHandler()
```
    Gets the mouse event handler for directly dispatching mouse events to the client.
    
    Returns:
    
    The mouse event handler instance
  - getKeyEventHandler
```
public ClientKeyEventHandler getKeyEventHandler()
```
    Gets the key event handler for directly dispatching key events to the client.
    
    Returns:
    
    The key event handler instance
  - getFocusEventHandler
```
public ClientFocusEventHandler getFocusEventHandler()
```
    Gets the focus event handler for directly dispatching focus events to the client.
    
    Returns:
    
    The focus event handler instance
  - getPainters
```
public java.util.Set<Painter> getPainters()
```
    Gets the set of painters currently registered.
    
    Returns:
    
    The currently registered painters
  - addPainter
```
public void addPainter(Painter painter)
```
    Adds a painter to the bot canvas.
    
    Parameters:
    
    painter - The painter to add
  - removePainter
```
public void removePainter(Painter painter)
```
    Removes a painter from the bot canvas.
    
    Parameters:
    
    painter - The painter to remove
  - getMouseListeners
```
public java.util.Set<BotMouseListener> getMouseListeners()
```
    Gets a set of registered mouse event listeners.
    
    Returns:
    
    The mouse listeners
  - getKeyListeners
```
public java.util.Set<BotKeyListener> getKeyListeners()
```
    Gets a set of registered mouse event listeners.
    
    Returns:
    
    The key listeners
  - addMouseListener
```
public void addMouseListener(BotMouseListener listener)
```
    Adds a mouse event listener.
    
    Parameters:
    
    listener - The listener to add
  - addKeyListener
```
public void addKeyListener(BotKeyListener listener)
```
    Adds a key event listener.
    
    Parameters:
    
    listener - The listener to add
  - removeMouseListener
```
public void removeMouseListener(BotMouseListener listener)
```
    Removes a mouse event listener.
    
    Parameters:
    
    listener - The listener to remove
  - removeKeyListener
```
public void removeKeyListener(BotKeyListener listener)
```
    Removes a key event listener.
    
    Parameters:
    
    listener - The listener to remove
  - getConfigListeners
```
public java.util.Set<ConfigListener> getConfigListeners()
```
    Gets a set of registered config event listeners.
    
    Returns:
    
    The set of registered config event listeners.
  - addConfigListener
```
public void addConfigListener(ConfigListener listener)
```
    Adds a config event listener.
    
    Parameters:
    
    listener - The listener.
  - removeConfigListener
```
public void removeConfigListener(ConfigListener listener)
```
    Removes a config event listener.
    
    Parameters:
    
    listener - The listener.
  - getLoginResponseCodeListeners
```
public java.util.Set<LoginResponseCodeListener> getLoginResponseCodeListeners()
```
    Gets a set of registered login event listeners.
    
    Returns:
    
    The set of registered login event listeners.
  - addLoginListener
```
public void addLoginListener(LoginResponseCodeListener listener)
```
    Adds a login event listener.
    
    Parameters:
    
    listener - The listener.
  - removeLoginListener
```
public void removeLoginListener(LoginResponseCodeListener listener)
```
    Removes a config event listener.
    
    Parameters:
    
    listener - The listener.
  - getMessageListeners
```
public java.util.Set<MessageListener> getMessageListeners()
```
    Gets a set of registered message event listeners.
    
    Returns:
    
    The set of registered message event listeners.
  - addMessageListener
```
public void addMessageListener(MessageListener listener)
```
    Adds a message event listener.
    
    Parameters:
    
    listener - The listener.
  - removeMessageListener
```
public void removeMessageListener(MessageListener listener)
```
    Removes a mouse event listener.
    
    Parameters:
    
    listener - The listener.
  - getAudioListeners
```
public java.util.Set<AudioListener> getAudioListeners()
```
    Gets a set of registered audio event listeners.
    
    Returns:
    
    The set of registered audio event listeners.
  - addAudioListener
```
public void addAudioListener(AudioListener listener)
```
    Adds an audio event listener.
    
    Parameters:
    
    listener - The listener.
  - removeAudioListener
```
public void removeAudioListener(AudioListener listener)
```
    Removes an audio event listener.
    
    Parameters:
    
    listener - The listener.
  - getGameTickListeners
```
public java.util.Set<GameTickListener> getGameTickListeners()
```
    Gets a set of registered game tick listeners.
    
    Returns:
    
    The set of registered game tick listeners.
  - addGameTickListener
```
public void addGameTickListener(GameTickListener listener)
```
    Adds a game tick listener.
    
    Parameters:
    
    listener - The listener.
  - removeGameTickListener
```
public void removeGameTickListener(GameTickListener listener)
```
    Removes a game tick listener.
    
    Parameters:
    
    listener - The listener.
  - dispatchMessageEvent
```
public void dispatchMessageEvent(Message message)
```
  - dispatchConfigEvent
```
public void dispatchConfigEvent(int id)
```
  - dispatchLoginEvent
```
public void dispatchLoginEvent(int id)
```
  - dispatchAudioEvent
```
public void dispatchAudioEvent(int cacheIndex)
```
  - dispatchGameTick
```
public void dispatchGameTick()
```
  - clearEventQueue
```
public void clearEventQueue()
```
  - executeListenerEvents
```
@Deprecated
public void executeListenerEvents()
                                        throws java.lang.InterruptedException
```
    Deprecated.
    
    Throws:
    
    java.lang.InterruptedException
  - tryFinishLoading
```
@Deprecated
public boolean tryFinishLoading()
```
    Deprecated.
  - initialize
```
@Deprecated
public void initialize()
                             throws java.lang.ClassNotFoundException,
                                    java.lang.IllegalAccessException,
                                    java.lang.InstantiationException
```
    Deprecated.
    
    Throws:
    
    java.lang.ClassNotFoundException
    
    java.lang.IllegalAccessException
    
    java.lang.InstantiationException
  - sendWebhookMessageToManager
```
public void sendWebhookMessageToManager(org.osbot.rs07.utility.webhooks.WebhookMessage message)
```
  - getMouseMoveProfile
```
public MouseMoveProfile getMouseMoveProfile()
```
  - setMouseMoveProfile
```
public void setMouseMoveProfile(MouseMoveProfile mouseMoveProfile)
```
  - resetExtensions
```
public void resetExtensions()
```
  - closeSelf
```
public void closeSelf()
```
  - lowCpu
```
public boolean lowCpu()
```
  - sendAppletEvent
```
public void sendAppletEvent(java.awt.AWTEvent event)
```
  - stop
```
@Deprecated
public void stop()
```
    Deprecated.
  - cleanup
```
@Deprecated
public void cleanup()
```
    Deprecated.
  - getLastGainedXPTimeThreshold
```
public long getLastGainedXPTimeThreshold()
```
    See setLastGainedXPTimeThreshold(TimeUnit, int)
    
    Returns:
    
    The last gained xp time threshold
  - setLastGainedXPTimeThreshold
```
public void setLastGainedXPTimeThreshold(java.util.concurrent.TimeUnit timeUnit,
                                         int lastGainedXPTimeThreshold)
```
    MUST BE SET IN Script.onStart() to above 0. OTHERWISE IT WILL NOT BE ACTIVATED. It can be adjusted afterwards from anywhere. If set to something above 0, this will enable automatic stopping of script if no XP gained after the specified amount of time. In other words, if the specified time passes and the player has not gained XP, the script will be stopped. Disabled by default. Set to -1 to disable (or anything equal to or below 0). This is checked approximately every 5 seconds.
    
    Parameters:
    
    timeUnit - The unit of the time
    
    lastGainedXPTimeThreshold - The time threshold
  - getTimeUntilNextBreak
```
public int getTimeUntilNextBreak()
```
    Gets the time (in seconds) until the next break will occur. When no breaks are enabled, this will return -1.
    
    Returns:
    
    The time (in seconds) until the next break will occur.

Class Bot

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.osbot.core.AbstractBot

Methods inherited from class java.lang.Object

Field Detail

shapeDebug

Constructor Detail

Bot

Method Detail

isDefaultUser

getDisplayName

getTabPanel

getShapeDebugger

getLoadingStageErrorCode

getBreakCondition

setBreakCondition

switchAccount

getBotPanel

getLoadingStage

setLoadingStage

getIdentifierFileName

isLoaded

isStopped

getId

isMirrorMode

isBreakSettingEnabled

getClient

getCanvas

setCanvas

getScriptExecutor

getRandomExecutor

getEventExecutor

getMethods

getMouseEventHandler

getKeyEventHandler

getFocusEventHandler

getPainters

addPainter

removePainter

getMouseListeners

getKeyListeners

addMouseListener

addKeyListener

removeMouseListener

removeKeyListener

getConfigListeners

addConfigListener

removeConfigListener

getLoginResponseCodeListeners

addLoginListener

removeLoginListener

getMessageListeners

addMessageListener

removeMessageListener

getAudioListeners

addAudioListener

removeAudioListener

getGameTickListeners

addGameTickListener

removeGameTickListener

dispatchMessageEvent

dispatchConfigEvent

dispatchLoginEvent

dispatchAudioEvent

dispatchGameTick

clearEventQueue

executeListenerEvents

tryFinishLoading

initialize

sendWebhookMessageToManager

getMouseMoveProfile

setMouseMoveProfile

resetExtensions

closeSelf

lowCpu

sendAppletEvent

stop

cleanup