org.osbot.rs07.api

Class Settings

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.Settings

public class Settings
extends API

Represents the API for client settings functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Settings.AllSettingsTab
static class	Settings.BasicSettingsTab
static class	Settings.Warning

Field Summary

Fields

Modifier and Type	Field and Description
static int	ORBS_WIDGET_ROOT_ID

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

Method Summary

Modifier and Type	Method and Description
boolean	areRoofsEnabled() Checks whether roof-removal is enabled or not.
boolean	escClosesCurrentInterface()
RS2Widget	getAllSettingsTabWidget(Settings.AllSettingsTab allSettingsTab) Gets the tab widget for an all settings tab
RS2Widget	getAllSettingsWidget() Gets the all settings widget container
RS2Widget	getBasicSettingsTabWidget(Settings.BasicSettingsTab basicSettingsTab) Gets the tab widget for a basic settings tab
Settings.AllSettingsTab	getCurrentAllSettingsTab() Gets the current open all settings tab
Settings.BasicSettingsTab	getCurrentBasicSettingsTab() Gets the current open basic settings tab
int	getPlayerWeight() Gets your player's run energy.
int	getRunEnergy() Gets your player's run energy.
void	initializeModule()
boolean	isAcceptAidActive() Checks to see if your player is accepting aid.
boolean	isAllSettingsWidgetVisible() Checks if the all settings widget is visible
boolean	isDataOrbsActive() Checks to see if your data orbs are being displayed (active).
boolean	isRunning() Checks to see if running is toggled.
boolean	isShiftDropActive()
boolean	isStaminaActive() Checks if the effect of a stamina potion is active
boolean	isWarningActive(Settings.Warning warning)
boolean	open() Opens the settings tab.
boolean	open(Settings.AllSettingsTab allSettingsTab) Opens the all settings tab.
boolean	open(Settings.BasicSettingsTab basicSettingsTab) Opens the basic settings tab.
boolean	openAllSettingsWidget() Opens the all settings widget
boolean	setRunning(boolean run) Turns running on or off, checks if data orbs are activated.
boolean	setSetting(Settings.AllSettingsTab tab, java.lang.String setting, boolean checked) Sets a setting in the all settings interface
boolean	setSetting(Settings.AllSettingsTab tab, java.lang.String setting, java.lang.String option) Sets a setting in the all settings interface

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

Field Detail

ORBS_WIDGET_ROOT_ID

public static final int ORBS_WIDGET_ROOT_ID

See Also:

Constant Field Values

Constructor Detail

Settings

public Settings()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

escClosesCurrentInterface

public boolean escClosesCurrentInterface()

isWarningActive

public boolean isWarningActive(Settings.Warning warning)

isShiftDropActive

public boolean isShiftDropActive()

getAllSettingsWidget

public RS2Widget getAllSettingsWidget()

Gets the all settings widget container

Returns:

The all settings widget container

isAllSettingsWidgetVisible

public boolean isAllSettingsWidgetVisible()

Checks if the all settings widget is visible

Returns:

True if the all settings widget is visible

openAllSettingsWidget

public boolean openAllSettingsWidget()

Opens the all settings widget

Returns:

True if the all settings widget is open

getCurrentAllSettingsTab

public Settings.AllSettingsTab getCurrentAllSettingsTab()

Gets the current open all settings tab

Returns:

The current open all settings tab

getCurrentBasicSettingsTab

public Settings.BasicSettingsTab getCurrentBasicSettingsTab()

Gets the current open basic settings tab

Returns:

The current open basic settings tab

open

public boolean open()

Opens the settings tab.

Returns:

True if succeeded.

getAllSettingsTabWidget

public RS2Widget getAllSettingsTabWidget(Settings.AllSettingsTab allSettingsTab)

Gets the tab widget for an all settings tab

Parameters:

allSettingsTab - The all settings tab to get the tab widget for

Returns:

The tab widget for an all settings tab

getBasicSettingsTabWidget

public RS2Widget getBasicSettingsTabWidget(Settings.BasicSettingsTab basicSettingsTab)

Gets the tab widget for a basic settings tab

Parameters:

basicSettingsTab - The basic settings tab to get the tab widget for

Returns:

The tab widget for a basic settings tab

open

public boolean open(Settings.BasicSettingsTab basicSettingsTab)

Opens the basic settings tab.

Returns:

True if succeeded.

open

public boolean open(Settings.AllSettingsTab allSettingsTab)

Opens the all settings tab.

Returns:

True if succeeded.

getRunEnergy

public int getRunEnergy()

Gets your player's run energy.

Returns:

Your player's run energy.

getPlayerWeight

public int getPlayerWeight()

Gets your player's run energy.

Returns:

Your player's run energy.

isRunning

public boolean isRunning()

Checks to see if running is toggled.

Returns:

True if running is toggled on.

isStaminaActive

public boolean isStaminaActive()

Checks if the effect of a stamina potion is active

Returns:

True if the effect of a stamina potion is active

isAcceptAidActive

public boolean isAcceptAidActive()

Checks to see if your player is accepting aid.

Returns:

True if your player is accepting aid.

isDataOrbsActive

public boolean isDataOrbsActive()

Checks to see if your data orbs are being displayed (active).

Returns:

True if your data orbs are active.

areRoofsEnabled

public boolean areRoofsEnabled()

Checks whether roof-removal is enabled or not.

Returns:

True if roofs are being removed.

setRunning

public boolean setRunning(boolean run)

Turns running on or off, checks if data orbs are activated.

Parameters:

run - True to turn it on, false to turn it off.

Returns:

True if the desired run state was successfully set or already set.

setSetting

public boolean setSetting(Settings.AllSettingsTab tab,
                          java.lang.String setting,
                          java.lang.String option)

Sets a setting in the all settings interface

Parameters:

tab - The tab containing the setting

setting - The setting name

option - The option to select

Returns:

True if the setting has been set to the provided option

setSetting

public boolean setSetting(Settings.AllSettingsTab tab,
                          java.lang.String setting,
                          boolean checked)

Sets a setting in the all settings interface

Parameters:

tab - The tab containing the setting

setting - The setting name

checked - True to check the setting, false to uncheck it

Returns:

True if the setting has been set to the checked value