org.osbot.rs07.api

Class Keyboard

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.Keyboard

public class Keyboard
extends API

Represents the API regarding keyboard functionality.

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

Method Summary

Modifier and Type	Method and Description
java.awt.event.KeyListener	getKeyListener() Gets the client's key listener.
void	initializeModule()
boolean	isKeyDown(int keyCode) Returns whether or not the key is currently being pressed
void	pressKey(int keyCode) Sends a KEY_PRESSED event to the key event handler.
void	releaseKey(int keyCode) Sends a KEY_RELEASED event to the key event handler.
boolean	typeContinualKey(char key, Condition condition) Types in one character as long as the specified condition evaluates to false with the specified modifiers.
boolean	typeContinualKey(char key, int mods, boolean enter, Condition condition) Types in one character as long as the specified condition evaluates to false with the specified modifiers finishing up with enter as specified.
boolean	typeContinualKey(char key, int mods, Condition condition) Types in one character as long as the specified condition evaluates to false with the specified modifiers.
void	typeEnter()
void	typeEscape()
boolean	typeFKey(int key)
boolean	typeKey(char key) Types in one character.
boolean	typeKey(char key, int mods) Types in one character with the specified modifiers.
boolean	typeKey(char key, int mods, boolean enter) Types in one character with the specified modifiers finishing up with enter as specified.
boolean	typeKey(char key, int mods, int time, boolean enter) Types in one character for the specified amount of time in milliseconds with the specified modifiers finishing up with enter as specified.
boolean	typeString(java.lang.String string) Types a string and finishes up with enter.
boolean	typeString(java.lang.String string, boolean enter) Types a string and finishes up with enter as specified.

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

exchangeContext, 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

Keyboard

public Keyboard()

Method Detail

typeString

public final boolean typeString(java.lang.String string)

Types a string and finishes up with enter.

Parameters:

string - The string to type.

Returns:

True if executed successfully.

typeString

public final boolean typeString(java.lang.String string,
                                boolean enter)

Types a string and finishes up with enter as specified.

Parameters:

string - The string to type.

enter - Whether to finish up with enter.

Returns:

True if executed successfully.

typeKey

public final boolean typeKey(char key)

Types in one character.

Parameters:

key - The character to type.

Returns:

True if executed successfully.

typeKey

public final boolean typeKey(char key,
                             int mods)

Types in one character with the specified modifiers.

Parameters:

key - The character to type.

mods - The modifiers to send the character with.

Returns:

True if executed successfully.

typeKey

public final boolean typeKey(char key,
                             int mods,
                             boolean enter)

Types in one character with the specified modifiers finishing up with enter as specified.

Parameters:

key - The character to type.

mods - The modifiers to send the character with.

enter - Whether to finish up with enter.

Returns:

True if executed successfully.

typeKey

public final boolean typeKey(char key,
                             int mods,
                             int time,
                             boolean enter)

Types in one character for the specified amount of time in milliseconds with the specified modifiers finishing up with enter as specified.

Parameters:

key - The character to type.

mods - The modifiers to send the characters with.

time - The time in milliseconds to hold down the character key.

enter - Whether to finish up with enter.

Returns:

True if executed successfully.

typeContinualKey

public final boolean typeContinualKey(char key,
                                      Condition condition)

Types in one character as long as the specified condition evaluates to false with the specified modifiers.

Parameters:

key - The character to type.

condition - The condition for which as long as it evaluates to false the key event will continue to hold down the specified character.

Returns:

True if executed successfully.

typeContinualKey

public final boolean typeContinualKey(char key,
                                      int mods,
                                      Condition condition)

Types in one character as long as the specified condition evaluates to false with the specified modifiers.

Parameters:

key - The character to type.

mods - The modifiers to send the character with.

condition - The condition for which as long as it evaluates to false the key event will continue to hold down the specified character.

Returns:

True if executed successfully.

typeContinualKey

public final boolean typeContinualKey(char key,
                                      int mods,
                                      boolean enter,
                                      Condition condition)

Types in one character as long as the specified condition evaluates to false with the specified modifiers finishing up with enter as specified.

Parameters:

key - The character to type.

mods - The modifiers to send the characters with.

enter - Whether to finish up with enter.

condition - The condition for which as long as it evaluates to false the key event will continue to hold down the specified character.

Returns:

True if executed successfully.

isKeyDown

public boolean isKeyDown(int keyCode)

Returns whether or not the key is currently being pressed

Parameters:

keyCode - The id code of the key to check

Returns:

True if the key is currently being pressed, otherwise false

typeEnter

public void typeEnter()

typeEscape

public void typeEscape()

typeFKey

public boolean typeFKey(int key)

pressKey

public void pressKey(int keyCode)

Sends a KEY_PRESSED event to the key event handler. Note: only for keys that have no 'character'. Do NOT use for Esc key (and probably a couple of other keys).

Parameters:

keyCode - The KeyCode for the key to type.

releaseKey

public void releaseKey(int keyCode)

Sends a KEY_RELEASED event to the key event handler. Note: only for keys that have no 'character'. Do NOT use for Esc key (and probably a couple of other keys).

Parameters:

keyCode - The KeyCode for the key to type.

getKeyListener

public java.awt.event.KeyListener getKeyListener()

Gets the client's key listener.

Returns:

The key listener.

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API