org.osbot.rs07.event

Class EventQueue<T extends EventQueue>

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.event.Event

org.osbot.rs07.event.EventQueue<T>

Direct Known Subclasses:

InteractionQueue

public class EventQueue<T extends EventQueue>
extends Event

Nested Class Summary

Nested classes/interfaces inherited from class org.osbot.rs07.event.Event

Event.EventMode, Event.EventStatus

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
EventQueue()

Method Summary

Modifier and Type	Method and Description
void	add(Event event) Adds an event to the queue
T	awaitState(int timeout, java.util.concurrent.Callable<java.lang.Boolean> state, java.util.concurrent.Callable<java.lang.Boolean>... breakConditions) Adds a WaitEvent to the queue, to await a specific state
T	awaitState(int timeout, int sleepTime, java.util.concurrent.Callable<java.lang.Boolean> state, java.util.concurrent.Callable<java.lang.Boolean>... breakConditions) Adds a WaitEvent to the queue, to await a specific state
T	endQueueIf(java.util.concurrent.Callable<java.lang.Boolean> condition) Ends the entire event queue if the condition is met, and fails the event
int	execute() This is the execution method.

Methods inherited from class org.osbot.rs07.event.Event

addChild, exchangeContext, getChildren, getMode, getParent, getStatus, hasFailed, hasFinished, interrupt, isQueued, isWorking, onEnd, onStart, removeChild, setAsync, setBlocking, setFailed, setFinished, setParent

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

EventQueue

public EventQueue()

Method Detail

add

public void add(Event event)

Adds an event to the queue

Parameters:

event - The event to add to the queue

endQueueIf

public T endQueueIf(java.util.concurrent.Callable<java.lang.Boolean> condition)

Ends the entire event queue if the condition is met, and fails the event

Parameters:

condition - The condition to check for

Returns:

This event queue

awaitState

public T awaitState(int timeout,
                    java.util.concurrent.Callable<java.lang.Boolean> state,
                    java.util.concurrent.Callable<java.lang.Boolean>... breakConditions)

Adds a WaitEvent to the queue, to await a specific state

Parameters:

timeout - The max time to wait

state - The state to wait for

breakConditions - Optional break conditions

Returns:

This event queue

awaitState

public T awaitState(int timeout,
                    int sleepTime,
                    java.util.concurrent.Callable<java.lang.Boolean> state,
                    java.util.concurrent.Callable<java.lang.Boolean>... breakConditions)

Adds a WaitEvent to the queue, to await a specific state

Parameters:

timeout - The max time to wait

sleepTime - The time to sleep between state checks

state - The state to wait for

breakConditions - Optional break conditions

Returns:

This event queue

execute

public int execute()
            throws java.lang.InterruptedException

Description copied from class: Event

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

Specified by:

execute in class Event

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