org.osbot.rs07.api

Class Chatbox

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.Chatbox

public class Chatbox
extends API

Represents the API regarding chatbox functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Chatbox.MessageType
static class	Chatbox.Tab

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

Method Summary

Modifier and Type	Method and Description
boolean	contains(Chatbox.MessageType messageType, java.lang.String... strings) Returns if the chatbox contains a message from the defined MessageType
int	getInterfaceId() Gets the widget root id of the chatbox
java.util.List<java.lang.String>	getMessages(Chatbox.MessageType messageType) Returns messages from the org.osbot.rs07.api.Chatbox
void	initializeModule()
boolean	isOpen() Checks if the chatbox is open
boolean	isOpen(Chatbox.Tab tab) Checks if a tab is open
boolean	isVisible()
boolean	open(Chatbox.Tab tab) Opens a tab

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

Chatbox

public Chatbox()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

getInterfaceId

public int getInterfaceId()

Gets the widget root id of the chatbox

Returns:

The widget root id of the chatbox

isOpen

public boolean isOpen()

Checks if the chatbox is open

Returns:

True if the chatbox is open

isOpen

public boolean isOpen(Chatbox.Tab tab)

Checks if a tab is open

Parameters:

tab - The tab to check

Returns:

True if a tab is open

open

public boolean open(Chatbox.Tab tab)

Opens a tab

Parameters:

tab - The tab to open

Returns:

True if the tab is open

getMessages

public java.util.List<java.lang.String> getMessages(Chatbox.MessageType messageType)

Returns messages from the org.osbot.rs07.api.Chatbox

Parameters:

messageType - The type of chatbox messages you want to return

Returns:

A list of messages from the chatbox

contains

public boolean contains(Chatbox.MessageType messageType,
                        java.lang.String... strings)

Returns if the chatbox contains a message from the defined MessageType

Parameters:

messageType - The type of messages you would like to filter

strings - The strings you would like to check for

Returns:

True if at least one of the strings defined is found in the chatbox from the defined MessageType

isVisible

public boolean isVisible()

Returns:

True if the chatbox is visible