Package org.dreambot.api
Class ClientSettings
- java.lang.Object
-
- org.dreambot.api.ClientSettings
-
public class ClientSettings extends java.lang.Object
Created by Nezz on 10/25/2015.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ClientSettings.SettingsTab
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static void
addStoredAuth(java.lang.String username, int auth)
static boolean
areChatEffectsEnabled()
Checks if chat effects are enabledstatic boolean
areCollectionLogNotificationsEnabled()
static boolean
areCollectionLogPopupsEnabled()
static boolean
areDataOrbsEnabled()
Checks if data orbs are enabledstatic boolean
areItemPilesOnDeathEnabled()
Checks if item piles on death are enabledstatic boolean
areLootNotificationsEnabled()
Checks whether loot notifications are enabled or notstatic boolean
areRoofsHidden()
Checks if roofs are currently set to hiddenstatic boolean
areRunesAutoPouching()
static boolean
canUseMiddleMouseForCamera()
Checks to see if RS's middle mouse button controls the camera setting is enabledstatic void
clearLayoutPreferences()
static boolean
closeSettingsInterface()
This will close the "All Settings" interfacestatic int
getAreaVolume()
Gets the area volumestatic double
getBrightness()
Gets the brightness levelstatic int
getClientBrightness()
Gets the in game brightness settingstatic ClientLayout
getClientLayout()
Gets the current client layoutstatic java.util.Map<java.lang.Integer,java.lang.Integer>
getClientParameters()
Returns the client parametersstatic int
getEnergyThresholdToEnableRunning()
static int
getLootDropMinimumValue()
Gets the minimum value set for loot drop notificationsstatic int
getMinimumAlchWarningValue()
static int
getMinimumDropWarningValue()
static int
getMusicVolume()
Gets the music volumestatic ActionMode
getNPCAttackOptionsMode()
Returns the current ActionMode for NPC attack optionsstatic ActionMode
getPlayerAttackOptionsMode()
Returns the current ActionMode for player attack optionsstatic int
getResizableValue()
Gets an int value of if resizable mode is enabled 1 is disabled, 2 is enabledstatic java.lang.String
getSavedUsername()
Gets the currently saved login username, null if none savedstatic int
getSoundEffectVolume()
Gets the sound effect volumestatic boolean
isAcceptAidEnabled()
Checks if accept aid is enabledstatic boolean
isAmmoAutoEquipping()
static boolean
isBuyPriceWarningEnabled()
Checks if the buy price warning is enabledstatic boolean
isClickThroughChatboxEnabled()
Checks if click through chatbox is enabledstatic boolean
isDisplayFps()
Gets whether the client is displaying the current FPS or notstatic boolean
isEscInterfaceClosingEnabled()
Checks if escape to close interfaces is enabledstatic boolean
isFeroxExitWarningEnabled()
Checks if the exit warning is enabled for Feroxstatic boolean
isFeroxExitWarningOnHighRiskWorldEnabled()
Checks if the exit warning is enabled for Ferox while on a high risk worldstatic boolean
isGameAudioOn()
Gets the current game audio settingsstatic boolean
isHideUsername()
Checks if the "hide username" setting is enabledstatic boolean
isLevelUpInterfaceEnabled()
Checks if data orbs are enabledstatic boolean
isLoginMusicDisabled()
Checks whether the login screen music is disabled or notstatic boolean
isLoginMusicEnabled()
Deprecated.static boolean
isMakeXDartsEnabled()
static boolean
isMoveFollowerOptionsLowerEnabled()
Checks if the move follower options lower setting is enabledstatic boolean
isOpen()
static boolean
isRememberUsername()
Checks whether the client's remember username setting is enabledstatic boolean
isResizableActive()
Returns whether resizable mode is enabledstatic boolean
isScrollToZoomEnabled()
Checks if scroll to zoom is enabledstatic boolean
isSellPriceWarningEnabled()
Checks if the sell price warning is enabledstatic boolean
isShiftClickDroppingEnabled()
Checks if shift click dropping is enabledstatic boolean
isShiftInteractionEnabled()
Deprecated.static boolean
isSkullPreventionActive()
Checks whether skull prevention is active or notstatic boolean
isTradeDelayEnabled()
static boolean
isTransparentChatboxEnabled()
Checks if the transparent chatbox is enabledstatic boolean
isTransparentSidePanelEnabled()
Checks if the transparent chatbox is enabledstatic boolean
isWorldHopConfirmationEnabled()
static boolean
isZoomingEnabled()
Checks if scroll to zoom is enabled on the accountstatic boolean
restoreDefaultKeybinds()
static boolean
roofsEnabled()
Deprecated.seeareRoofsHidden()
static boolean
setClientBrightness(int brightness)
Sets the in game brightness settingstatic boolean
setClientLayout(ClientLayout layout)
static boolean
setDefaultZoom()
Sets the zoom to the default zoom valuestatic void
setDisplayFps(boolean display)
Calls a direct set on if FPS should be displayedstatic boolean
setEnergyThresholdToEnableRunning(int value)
static void
setHideUsername(boolean hide)
Calls a direct set on the hide username setting, this setting should be persistedstatic void
setLoginMusicDisabled(boolean disabled)
Calls a direct set on whether login music is disabled, these settings should be persistedstatic boolean
setMinimumAlchWarningValue(int value)
static boolean
setMinimumDropWarningValue(int value)
static boolean
setNPCAttackOptionsMode(ActionMode mode)
Sets the NPC attack options modestatic boolean
setPlayerAttackOptionsMode(ActionMode mode)
Sets the player attack options modestatic void
setSavedUsername(java.lang.String username)
Calls a direct set on saved username, this setting should be persistedstatic boolean
toggleAcceptAid(boolean on)
Toggles whether accept aid is on or offstatic boolean
toggleAmmoAutoEquipping(boolean on)
static boolean
toggleBuyPriceWarning(boolean on)
Toggles whether the buy price warning is on or offstatic boolean
toggleChatEffects(boolean on)
Toggles whether chat effects are on or offstatic boolean
toggleClickThroughChatbox(boolean on)
Toggles whether click through chatbox is on or offstatic boolean
toggleCollectionLogNotifications(boolean on)
static boolean
toggleCollectionLogPopups(boolean on)
static boolean
toggleDataOrbs(boolean on)
Toggles whether data orbs are on or offstatic boolean
toggleEscInterfaceClosing(boolean on)
Toggles whether using the escape key to close interfaces is on or offstatic boolean
toggleFeroxExitWarning(boolean on)
Toggles whether the exit warning for Ferox is on or offstatic boolean
toggleFeroxExitWarningOnHighRiskWorld(boolean on)
Toggles whether the exit warning for Ferox while on a high risk world is on or offstatic boolean
toggleGameAudio(boolean on)
Toggles whether all game audio settings are on or offstatic boolean
toggleItemPilesOnDeath(boolean on)
Toggles whether certain items are piled on death is on or offstatic boolean
toggleLevelUpInterface(boolean on)
Toggles whether level-up interfaces are enabledstatic boolean
toggleLootNotifications(boolean on)
Turns the loot notifications on or off Does not do initial setting value for loot drop notificationsstatic boolean
toggleMakeXDarts(boolean enabled)
static boolean
toggleMoveFollowerOptionsLower(boolean on)
Toggles whether follower options are lower is on or offstatic boolean
toggleResizable(boolean on)
Toggles whether resizable mode is enabled or notstatic boolean
toggleRoofs(boolean on)
Toggles roof visibility through the settings screenstatic boolean
toggleRuneAutoPouching(boolean on)
static boolean
toggleScrollToZoom(boolean on)
Toggles whether scroll to zoom the camera is on or offstatic boolean
toggleSellPriceWarning(boolean on)
Toggles whether the sell price warning is on or offstatic boolean
toggleSetting(ClientSettings.SettingsTab tab, java.lang.String settingLabel, Condition completedCondition)
static boolean
toggleShiftClickDropping(boolean on)
Toggles whether shift click dropping is on or offstatic boolean
toggleSkullPrevention(boolean on)
Turns skull prevention on or offstatic boolean
toggleTradeDelay(boolean on)
static boolean
toggleTransparentChatbox(boolean on)
Toggles whether transparent chatbox is on or offstatic boolean
toggleTransparentSidePanel(boolean on)
Toggles whether transparent side panel is on or offstatic boolean
toggleWorldHopConfirmation(boolean enabled)
-
-
-
Method Detail
-
isDisplayFps
public static boolean isDisplayFps()
Gets whether the client is displaying the current FPS or not
-
setDisplayFps
public static void setDisplayFps(boolean display)
Calls a direct set on if FPS should be displayed
-
isLoginMusicEnabled
@Deprecated public static boolean isLoginMusicEnabled()
Deprecated.
-
isLoginMusicDisabled
public static boolean isLoginMusicDisabled()
Checks whether the login screen music is disabled or not
-
setLoginMusicDisabled
public static void setLoginMusicDisabled(boolean disabled)
Calls a direct set on whether login music is disabled, these settings should be persisted
-
getSavedUsername
public static java.lang.String getSavedUsername()
Gets the currently saved login username, null if none saved
-
setSavedUsername
public static void setSavedUsername(java.lang.String username)
Calls a direct set on saved username, this setting should be persisted
-
isHideUsername
public static boolean isHideUsername()
Checks if the "hide username" setting is enabled
-
setHideUsername
public static void setHideUsername(boolean hide)
Calls a direct set on the hide username setting, this setting should be persisted
-
isRememberUsername
public static boolean isRememberUsername()
Checks whether the client's remember username setting is enabled
-
getResizableValue
public static int getResizableValue()
Gets an int value of if resizable mode is enabled 1 is disabled, 2 is enabled- Returns:
- 1 if disabled, 2 if enabled, -1 if reference is null
-
isResizableActive
public static boolean isResizableActive()
Returns whether resizable mode is enabled- Returns:
- True if it's enabled, False if it isn't
-
getClientParameters
public static java.util.Map<java.lang.Integer,java.lang.Integer> getClientParameters()
Returns the client parameters- Returns:
- client parameters
-
addStoredAuth
public static void addStoredAuth(java.lang.String username, int auth)
-
roofsEnabled
@Deprecated public static boolean roofsEnabled()
Deprecated.seeareRoofsHidden()
-
areRoofsHidden
public static boolean areRoofsHidden()
Checks if roofs are currently set to hidden
-
toggleRoofs
public static boolean toggleRoofs(boolean on)
Toggles roof visibility through the settings screen- Parameters:
on
- whether you want roofs visible or not- Returns:
- returns whether roofsEnabled() matches on parameter
-
closeSettingsInterface
public static boolean closeSettingsInterface()
This will close the "All Settings" interface
-
isOpen
public static boolean isOpen()
-
toggleGameAudio
public static boolean toggleGameAudio(boolean on)
Toggles whether all game audio settings are on or off- Returns:
- true if it succeeds, false otherwise
-
toggleResizable
public static boolean toggleResizable(boolean on)
Toggles whether resizable mode is enabled or not- Parameters:
on
- Whether you want resizable active or not- Returns:
- False if on is true, otherwise returns if isResizableActive() matches param
-
getClientBrightness
public static int getClientBrightness()
Gets the in game brightness setting- Returns:
- client's brightness setting, between 0 (dimmest) and 100 (brightest)
-
setClientBrightness
public static boolean setClientBrightness(int brightness)
Sets the in game brightness setting- Parameters:
brightness
- Brightness value between 0 (dimmest) and 100 (brightest)- Returns:
- true if we're able to change the brightness to the provided value, false otherwise
-
clearLayoutPreferences
public static void clearLayoutPreferences()
-
setClientLayout
public static boolean setClientLayout(ClientLayout layout)
-
getClientLayout
public static ClientLayout getClientLayout()
Gets the current client layout- Returns:
- The current ClientLayout
-
isGameAudioOn
public static boolean isGameAudioOn()
Gets the current game audio settings- Returns:
- true if all sound options are unmuted, false otherwise
-
toggleAcceptAid
public static boolean toggleAcceptAid(boolean on)
Toggles whether accept aid is on or off- Returns:
- true if it succeeds, false otherwise
-
isAcceptAidEnabled
public static boolean isAcceptAidEnabled()
Checks if accept aid is enabled- Returns:
- true if it is, false otherwise
-
toggleDataOrbs
public static boolean toggleDataOrbs(boolean on)
Toggles whether data orbs are on or off- Returns:
- true if it succeeds, false otherwise
-
areDataOrbsEnabled
public static boolean areDataOrbsEnabled()
Checks if data orbs are enabled- Returns:
- true if it is, false otherwise
-
toggleLevelUpInterface
public static boolean toggleLevelUpInterface(boolean on)
Toggles whether level-up interfaces are enabled- Returns:
- true if it succeeds, false otherwise
-
isLevelUpInterfaceEnabled
public static boolean isLevelUpInterfaceEnabled()
Checks if data orbs are enabled- Returns:
- true if it is, false otherwise
-
toggleEscInterfaceClosing
public static boolean toggleEscInterfaceClosing(boolean on)
Toggles whether using the escape key to close interfaces is on or off- Returns:
- true if it succeeds, false otherwise
-
isEscInterfaceClosingEnabled
public static boolean isEscInterfaceClosingEnabled()
Checks if escape to close interfaces is enabled- Returns:
- true if it is, false otherwise
-
isShiftClickDroppingEnabled
public static boolean isShiftClickDroppingEnabled()
Checks if shift click dropping is enabled- Returns:
- true if it is, false otherwise
-
toggleShiftClickDropping
public static boolean toggleShiftClickDropping(boolean on)
Toggles whether shift click dropping is on or off- Returns:
- true if it succeeds, false otherwise
-
toggleScrollToZoom
public static boolean toggleScrollToZoom(boolean on)
Toggles whether scroll to zoom the camera is on or off- Returns:
- true if it succeeds, false otherwise
-
isScrollToZoomEnabled
public static boolean isScrollToZoomEnabled()
Checks if scroll to zoom is enabled- Returns:
- true if it is, false otherwise
-
canUseMiddleMouseForCamera
public static boolean canUseMiddleMouseForCamera()
Checks to see if RS's middle mouse button controls the camera setting is enabled- Returns:
- true if enabled, else false
-
toggleChatEffects
public static boolean toggleChatEffects(boolean on)
Toggles whether chat effects are on or off- Returns:
- true if it succeeds, false otherwise
-
areChatEffectsEnabled
public static boolean areChatEffectsEnabled()
Checks if chat effects are enabled- Returns:
- true if it is, false otherwise
-
toggleTransparentChatbox
public static boolean toggleTransparentChatbox(boolean on)
Toggles whether transparent chatbox is on or off- Returns:
- true if it succeeds, false otherwise or if you're not on resizable mode
-
isTransparentSidePanelEnabled
public static boolean isTransparentSidePanelEnabled()
Checks if the transparent chatbox is enabled- Returns:
- true if it is, false otherwise
-
toggleTransparentSidePanel
public static boolean toggleTransparentSidePanel(boolean on)
Toggles whether transparent side panel is on or off- Returns:
- true if it succeeds, false otherwise or if you're not on resizable mode
-
isTransparentChatboxEnabled
public static boolean isTransparentChatboxEnabled()
Checks if the transparent chatbox is enabled- Returns:
- true if it is, false otherwise
-
toggleClickThroughChatbox
public static boolean toggleClickThroughChatbox(boolean on)
Toggles whether click through chatbox is on or off- Returns:
- true if it succeeds, false otherwise or if you're not on resizable mode or if transparent chatbox is disabled
-
isClickThroughChatboxEnabled
public static boolean isClickThroughChatboxEnabled()
Checks if click through chatbox is enabled- Returns:
- true if it is, false otherwise
-
toggleItemPilesOnDeath
public static boolean toggleItemPilesOnDeath(boolean on)
Toggles whether certain items are piled on death is on or off- Returns:
- true if it succeeds, false otherwise
-
areItemPilesOnDeathEnabled
public static boolean areItemPilesOnDeathEnabled()
Checks if item piles on death are enabled- Returns:
- true if it is, false otherwise
-
toggleMoveFollowerOptionsLower
public static boolean toggleMoveFollowerOptionsLower(boolean on)
Toggles whether follower options are lower is on or off- Returns:
- true if it succeeds, false otherwise
-
isMoveFollowerOptionsLowerEnabled
public static boolean isMoveFollowerOptionsLowerEnabled()
Checks if the move follower options lower setting is enabled- Returns:
- true if it is, false otherwise
-
toggleSellPriceWarning
public static boolean toggleSellPriceWarning(boolean on)
Toggles whether the sell price warning is on or off- Parameters:
on
- whether the warning should be enabled- Returns:
- true if it succeeds, false otherwise
-
isSellPriceWarningEnabled
public static boolean isSellPriceWarningEnabled()
Checks if the sell price warning is enabled- Returns:
- true if it is, false otherwise
-
toggleFeroxExitWarning
public static boolean toggleFeroxExitWarning(boolean on)
Toggles whether the exit warning for Ferox is on or off- Parameters:
on
- whether the warning should be enabled- Returns:
- true if it succeeds, false otherwise
-
isFeroxExitWarningEnabled
public static boolean isFeroxExitWarningEnabled()
Checks if the exit warning is enabled for Ferox- Returns:
- true if it is, false otherwise
-
toggleFeroxExitWarningOnHighRiskWorld
public static boolean toggleFeroxExitWarningOnHighRiskWorld(boolean on)
Toggles whether the exit warning for Ferox while on a high risk world is on or off- Parameters:
on
- whether the warning should be enabled- Returns:
- true if it succeeds, false otherwise
-
isFeroxExitWarningOnHighRiskWorldEnabled
public static boolean isFeroxExitWarningOnHighRiskWorldEnabled()
Checks if the exit warning is enabled for Ferox while on a high risk world- Returns:
- true if it is, false otherwise
-
toggleBuyPriceWarning
public static boolean toggleBuyPriceWarning(boolean on)
Toggles whether the buy price warning is on or off- Parameters:
on
- whether the warning should be enabled- Returns:
- true if it succeeds, false otherwise
-
isBuyPriceWarningEnabled
public static boolean isBuyPriceWarningEnabled()
Checks if the buy price warning is enabled- Returns:
- false currently as the option isn't enabled in game yet
-
getPlayerAttackOptionsMode
public static ActionMode getPlayerAttackOptionsMode()
Returns the current ActionMode for player attack options- Returns:
- player attack options ActionMode
-
setPlayerAttackOptionsMode
public static boolean setPlayerAttackOptionsMode(ActionMode mode)
Sets the player attack options mode- Returns:
- true if it succeeds, false otherwise
-
setNPCAttackOptionsMode
public static boolean setNPCAttackOptionsMode(ActionMode mode)
Sets the NPC attack options mode- Returns:
- true if it succeeds, false otherwise
-
getNPCAttackOptionsMode
public static ActionMode getNPCAttackOptionsMode()
Returns the current ActionMode for NPC attack options- Returns:
- NPC attack options ActionMode
-
areLootNotificationsEnabled
public static boolean areLootNotificationsEnabled()
Checks whether loot notifications are enabled or not
-
getLootDropMinimumValue
public static int getLootDropMinimumValue()
Gets the minimum value set for loot drop notifications
-
toggleLootNotifications
public static boolean toggleLootNotifications(boolean on)
Turns the loot notifications on or off Does not do initial setting value for loot drop notifications- Parameters:
on
-- Returns:
-
isSkullPreventionActive
public static boolean isSkullPreventionActive()
Checks whether skull prevention is active or not
-
toggleSkullPrevention
public static boolean toggleSkullPrevention(boolean on)
Turns skull prevention on or off- Parameters:
on
-- Returns:
-
restoreDefaultKeybinds
public static boolean restoreDefaultKeybinds()
-
toggleSetting
public static boolean toggleSetting(ClientSettings.SettingsTab tab, java.lang.String settingLabel, Condition completedCondition)
-
setDefaultZoom
public static boolean setDefaultZoom()
Sets the zoom to the default zoom value- Returns:
- whether zoom matches default value after setting it
-
isZoomingEnabled
public static boolean isZoomingEnabled()
Checks if scroll to zoom is enabled on the account- Returns:
- true if enabled, false otherwise
-
isShiftInteractionEnabled
@Deprecated public static boolean isShiftInteractionEnabled()
Deprecated.
-
isTradeDelayEnabled
public static boolean isTradeDelayEnabled()
-
toggleTradeDelay
public static boolean toggleTradeDelay(boolean on)
-
isAmmoAutoEquipping
public static boolean isAmmoAutoEquipping()
-
toggleAmmoAutoEquipping
public static boolean toggleAmmoAutoEquipping(boolean on)
-
areRunesAutoPouching
public static boolean areRunesAutoPouching()
-
toggleRuneAutoPouching
public static boolean toggleRuneAutoPouching(boolean on)
-
areCollectionLogNotificationsEnabled
public static boolean areCollectionLogNotificationsEnabled()
-
areCollectionLogPopupsEnabled
public static boolean areCollectionLogPopupsEnabled()
-
toggleCollectionLogNotifications
public static boolean toggleCollectionLogNotifications(boolean on)
-
toggleCollectionLogPopups
public static boolean toggleCollectionLogPopups(boolean on)
-
getMusicVolume
public static int getMusicVolume()
Gets the music volume
-
getSoundEffectVolume
public static int getSoundEffectVolume()
Gets the sound effect volume
-
getAreaVolume
public static int getAreaVolume()
Gets the area volume
-
getBrightness
public static double getBrightness()
Gets the brightness level
-
isWorldHopConfirmationEnabled
public static boolean isWorldHopConfirmationEnabled()
-
toggleWorldHopConfirmation
public static boolean toggleWorldHopConfirmation(boolean enabled)
-
isMakeXDartsEnabled
public static boolean isMakeXDartsEnabled()
-
toggleMakeXDarts
public static boolean toggleMakeXDarts(boolean enabled)
-
getMinimumAlchWarningValue
public static int getMinimumAlchWarningValue()
-
setMinimumAlchWarningValue
public static boolean setMinimumAlchWarningValue(int value)
-
getMinimumDropWarningValue
public static int getMinimumDropWarningValue()
-
setMinimumDropWarningValue
public static boolean setMinimumDropWarningValue(int value)
-
getEnergyThresholdToEnableRunning
public static int getEnergyThresholdToEnableRunning()
-
setEnergyThresholdToEnableRunning
public static boolean setEnergyThresholdToEnableRunning(int value)
-
-