org.osbot.rs07.input.keyboard

Class TypeStringEvent

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.event.Event

org.osbot.rs07.input.keyboard.TypeStringEvent

public class TypeStringEvent
extends Event

Represents an event which executes the task of sending a string by sending the separate key events to the client.

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
TypeStringEvent(java.lang.String string) Creates an instance of this event that sends a string and finishes up with the enter key event.
TypeStringEvent(java.lang.String string, boolean pressEnter) Creates an instance of this event that send a string and finished up with the enter key event as specified.

Method Summary

Modifier and Type	Method and Description
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

TypeStringEvent

public TypeStringEvent(java.lang.String string)

Creates an instance of this event that sends a string and finishes up with the enter key event.

Parameters:

string - The string to send.

TypeStringEvent

public TypeStringEvent(java.lang.String string,
                       boolean pressEnter)

Creates an instance of this event that send a string and finished up with the enter key event as specified.

Parameters:

string - The string to send.

pressEnter - Whether to finish up with the enter key event.

Method Detail

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