org.osbot.rs07.api

Class LogoutTab

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.LogoutTab

public class LogoutTab
extends API

Represents the API for logout tab 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
LogoutTab()

Method Summary

Modifier and Type	Method and Description
void	initializeModule()
boolean	isOpen()
boolean	logOut() Tries to open the logout tab and logout.
boolean	open() Opens the logout 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

LogoutTab

public LogoutTab()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

isOpen

public boolean isOpen()

logOut

public boolean logOut()

Tries to open the logout tab and logout. If it opened the tab successfully, it will conditionally sleep for approximately one second or return true if you are logged out before the second expires. Recalling this method if it failed while actually experiencing lag will check for the login state, so if lag was experienced and the client logged out in between the expiration of the second and your next call to this method this method will not retry to logout but return true.

Returns:

True if logged out within one second or if you are already logged out.

open

public boolean open()

Opens the logout tab.

Returns:

True if the logout tab was opened successfully.