org.osbot.rs07.event

Class Event

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.event.Event

Direct Known Subclasses:

CameraPitchEvent, CameraYawEvent, EventQueue, InteractionEvent, MouseEvent, TypeStringEvent, WaitEvent, WalkingEvent, WebWalkEvent, XKeyEvent

public abstract class Event
extends MethodProvider

Represents an event executing a task that is executed by the bot engine.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Event.EventMode The event mode determines the execution environment under which the event gets executed under.
static class	Event.EventStatus The event status determines what the event is doing.

Field Summary

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, bot, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
Event()

Method Summary

Modifier and Type	Method and Description
void	addChild(Event event) Adds a child to this event.
MethodProvider	exchangeContext(Bot bot) This class and method can be used to create extensions to the API with full direct access to the OSBot 2 API within your extensions.
abstract int	execute() This is the execution method.
java.util.LinkedList<Event>	getChildren() Gets the children events of this event.
Event.EventMode	getMode() Gets the Event.EventMode of this event.
Event	getParent() Gets the parent event of this event.
Event.EventStatus	getStatus() Gets the Event.EventStatus of this event.
boolean	hasFailed() Determines if the event has the status Event.EventStatus.FAILED.
boolean	hasFinished() Determines if the event has the status Event.EventStatus.FINISHED.
void	interrupt() Interrupts the event's executing thread.
boolean	isQueued() Determines if the event has the status Event.EventStatus.QUEUED.
boolean	isWorking() Determines if the event has the status Event.EventStatus.WORKING.
void	onEnd() Called after this event is executed.
void	onStart() Called before this event is executed.
void	removeChild(Event event) Removes a child from this event.
Event	setAsync() Sets the event mode to Event.EventMode.ASYNC.
Event	setBlocking() Sets the event mode to Event.EventMode.BLOCKING.
Event	setFailed() Sets the status of this event to Event.EventStatus.FAILED.
Event	setFinished() Sets the status of this event to (@link Event.EventStatus#FINISHED}.
void	setParent(Event parent) Sets the parant event of this event.

Methods inherited from class org.osbot.rs07.script.MethodProvider

execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Method Detail

getParent

public Event getParent()

Gets the parent event of this event. This event will be executed before this event.

Returns:

The parent event of this event.

setParent

public void setParent(Event parent)

Sets the parant event of this event.

Parameters:

parent - The parent event

getChildren

public java.util.LinkedList<Event> getChildren()

Gets the children events of this event. These will be executed after this event.

Returns:

The children events of this event.

addChild

public void addChild(Event event)

Adds a child to this event.

Parameters:

event - The event to add.

removeChild

public void removeChild(Event event)

Removes a child from this event.

Parameters:

event - The event to remove.

getStatus

public Event.EventStatus getStatus()

Gets the Event.EventStatus of this event.

Returns:

The Event.EventStatus of this event.

getMode

public Event.EventMode getMode()

Gets the Event.EventMode of this event.

Returns:

The Event.EventMode of this event.

setBlocking

public Event setBlocking()

Sets the event mode to Event.EventMode.BLOCKING.

Returns:

This event instance.

setAsync

public Event setAsync()

Sets the event mode to Event.EventMode.ASYNC.

Returns:

This event instance.

onStart

public void onStart()
             throws java.lang.InterruptedException

Called before this event is executed.

Throws:

java.lang.InterruptedException - Thrown when execution is interrupted

onEnd

public void onEnd()
           throws java.lang.InterruptedException

Called after this event is executed.

Throws:

java.lang.InterruptedException - Thrown when execution is interrupted

execute

public abstract int execute()
                     throws java.lang.InterruptedException

This is the execution method. Works like onLoop() in OSBot v1.

Returns:

A positive number to wait between calls in milliseconds, or a negative number to stop the event.

Throws:

java.lang.InterruptedException - Thrown when execution is interrupted

hasFinished

public boolean hasFinished()

Determines if the event has the status Event.EventStatus.FINISHED.

Returns:

True if the event has the status Event.EventStatus.FINISHED.

hasFailed

public boolean hasFailed()

Determines if the event has the status Event.EventStatus.FAILED.

Returns:

True if the event has the status Event.EventStatus.FAILED.

isWorking

public boolean isWorking()

Determines if the event has the status Event.EventStatus.WORKING.

Returns:

True if the event has the status Event.EventStatus.WORKING.

isQueued

public boolean isQueued()

Determines if the event has the status Event.EventStatus.QUEUED.

Returns:

True if the event has the status Event.EventStatus.QUEUED.

setFailed

public Event setFailed()

Sets the status of this event to Event.EventStatus.FAILED.

Returns:

This event instance.

setFinished

public Event setFinished()

Sets the status of this event to (@link Event.EventStatus#FINISHED}.

Returns:

This event instance.

interrupt

public void interrupt()

Interrupts the event's executing thread. Note: This is experimental! Most programmers won't need this.

exchangeContext

public MethodProvider exchangeContext(Bot bot)

This class and method can be used to create extensions to the API with full direct access to the OSBot 2 API within your extensions. If you create your own extensions you extend the API class or MethodProvider and if you want to provide the existing API components to your own extensions you override this method with a call to this method first by calling super.exchangeContext(bot) followed by the initialization of your own components on which you call this method on.

Overrides:

exchangeContext in class MethodProvider

Parameters:

bot - The Bot instance.

Returns:

The instance of this API extension.