Options

public class Options

Utilities for getting information related to what's in the Options Tab and Minimap HUD. Also provides ways to change and toggle settings.

Types

AttackOption

public enum AttackOption

ChatboxScrollPosition

public enum ChatboxScrollPosition

HouseDoor

public enum HouseDoor

ResizableType

public enum ResizableType

Tab

public enum Tab

Functions

closeAllSettings

static boolean closeAllSettings()

closeHouseOptionsTab

static boolean closeHouseOptionsTab()

Closes House Options Tab

getHouseDoorState

static Options.HouseDoor getHouseDoorState()

getResizableModeType

static Options.ResizableType getResizableModeType()

Gets the resizable game mode type (fixed, resizable classic, resizable modern)

getRunEnergy

@Deprecated()

static int getRunEnergy()

Gets the current run energy of the player character.

getScrollbarRightPosition

static Options.ChatboxScrollPosition getScrollbarRightPosition()

Determines whether the option to set scroll-bars as right-aligned is enabled.

isAcceptAidEnabled

static boolean isAcceptAidEnabled()

isAcceptTradeDelayEnabled

static boolean isAcceptTradeDelayEnabled()

Determine if accept trade delay is enabled

isAllSettingsOpen

static boolean isAllSettingsOpen()

isAnySoundOn

static boolean isAnySoundOn()

Determines if any sounds is on or off

isAreaSoundOn

static boolean isAreaSoundOn()

Determines if Area sound is on or off.

isClickThroughChatboxEnabled

static boolean isClickThroughChatboxEnabled()

Determines whether the option to set the chat-box as click-through is enabled.

isDataOrbsEnabled

static boolean isDataOrbsEnabled()

Determines whether the option to display data-orbs (the UIs on the side of the mini-map) is enabled.

isDisableLevelUpInterfaceEnabled

static boolean isDisableLevelUpInterfaceEnabled()

Determine if disable level up interface is enabled

isEscapeClosingEnabled

static boolean isEscapeClosingEnabled()

isFollowerOptionsLowerDownEnabled

static boolean isFollowerOptionsLowerDownEnabled()

Determines whether the option to show follower (summoning) options lower down is enabled.

isGrandExchangeBuyWarningEnabled

static boolean isGrandExchangeBuyWarningEnabled()

Determine if grand exchange buy warning is enabled

isGrandExchangeSellWarningEnabled

static boolean isGrandExchangeSellWarningEnabled()

Determine if grand exchange sell warning is enabled

isHouseOptionsTabOpen

static boolean isHouseOptionsTabOpen()

Determine if house options tab is open

isHouseTeleportInsideEnabled

static boolean isHouseTeleportInsideEnabled()

Determine if house teleport inside is on or off

isMouseCameraEnabled

static boolean isMouseCameraEnabled()

Determines whether the option to use the middle mouse button to adjust the camera is enabled.

isMouseScrollZoomEnabled

static boolean isMouseScrollZoomEnabled()

Determines whether the option to allow viewport zooming via mouse wheel scrolling is enabled.

isMusicSoundOn

static boolean isMusicSoundOn()

Determines if Music is on or off.

isMusicUnlockMessageEnabled

static boolean isMusicUnlockMessageEnabled()

Determine if music unlock message is on or off

isPrayerTooltipEnabled

static boolean isPrayerTooltipEnabled()

Determines whether the option to use prayer tool-tips is enabled.

isResizableModeEnabled

static boolean isResizableModeEnabled()

Determines if the resizable mode setting is enabled.

isRoofsEnabled

static boolean isRoofsEnabled()

Checks if roofs are currently enabled (roofs are being drawn)

isRunEnabled

static boolean isRunEnabled()

Determines if the run setting is enabled.

isShiftClickDropEnabled

static boolean isShiftClickDropEnabled()

Determines if the shift-click drop setting is enabled.

isShowActivityAdviserEnabled

static boolean isShowActivityAdviserEnabled()

Determine if activity adviser is enabled

isSidePanelsEnabled

static boolean isSidePanelsEnabled()

Determines whether the option to set side panels on is enabled.

isSidePanelsHotkeyOpeningEnabled

static boolean isSidePanelsHotkeyOpeningEnabled()

Determines whether the option to use hot-keys to open side panels is enabled.

isSoundEffectsOn

static boolean isSoundEffectsOn()

Determines if Sound effect is on or off.

isSpecialAttackTooltipEnabled

static boolean isSpecialAttackTooltipEnabled()

Determines whether the option to use special attack tool-tips is enabled.

isStatsPanelXpEnabled

static boolean isStatsPanelXpEnabled()

Determines whether the option to set the stats panel XP til next level is enabled.

isTransparentChatboxEnabled

static boolean isTransparentChatboxEnabled()

Determines whether the option to set the chat-box transparent is enabled.

isTransparentSidePanelsEnabled

static boolean isTransparentSidePanelsEnabled()

Determines whether the option to set side panels as transparent is enabled.

isWorldSwitcherConfirmationEnabled

static boolean isWorldSwitcherConfirmationEnabled()

Determine if world switch confirmations are enabled

isXpDropsEnabled

static boolean isXpDropsEnabled()

Determines whether the option to show XP drops is enabled.

isZoomWithScrollEnabled

static boolean isZoomWithScrollEnabled()

Determine if zoom with mouse scroll is on or off

openHouseOptionsTab

static boolean openHouseOptionsTab()

Opens House Options Tab

setAcceptAid

static boolean setAcceptAid(boolean acceptAid)

setClickThroughChatboxEnabled

static boolean setClickThroughChatboxEnabled(boolean enable)

Sets the option for clicking through the chat-box.

setDataOrbsEnabled

static boolean setDataOrbsEnabled(boolean enable)

Sets the option for showing data-orbs.

setFollowerOptionsLowerDownEnabled

static boolean setFollowerOptionsLowerDownEnabled(boolean enable)

Sets the option controlling whether follower (summoning) options are first/last.

setHouseDoorState

static boolean setHouseDoorState(Options.HouseDoor houseDoor)

setHouseTeleportInsideEnabled

static boolean setHouseTeleportInsideEnabled(boolean enable)

Set house teleport inside on or off

setMouseCameraEnabled

static boolean setMouseCameraEnabled(boolean enable)

Sets the option for using the middle mouse button to adjust the camera.

setMouseScrollZoomEnabled

static boolean setMouseScrollZoomEnabled(boolean enable)

Sets the option for allowing viewport zooming using the mouse wheel.

setMusicUnlockMessageEnabled

static boolean setMusicUnlockMessageEnabled(boolean enable)

Turns music unlock message on or off.

setPrayerTooltipEnabled

static boolean setPrayerTooltipEnabled(boolean enable)

Sets the option for prayer tool-tips.

setRemoveRoofsEnabled

static boolean setRemoveRoofsEnabled(boolean enable)

Configures the setting to remove roofs

setResizableModeType

static boolean setResizableModeType(Options.ResizableType resizableType)

Sets the resizable display type

setRunEnabled

static boolean setRunEnabled(boolean runEnabled)

Turns run on or off.

setScrollbarPosition

static boolean setScrollbarPosition(Options.ChatboxScrollPosition position)

Sets the option for scroll-bar alignment.

setShiftClickDrop

static boolean setShiftClickDrop(boolean enabled)

Turns the shift-click drop setting on or off.

setSidePanelsEnabled

static boolean setSidePanelsEnabled(boolean enable)

Sets the option for use of side panels.

setSidePanelsHotkeyOpeningEnabled

static boolean setSidePanelsHotkeyOpeningEnabled(boolean enable)

Sets the option for using hot-keys to open side panels.

setSpecialAttackTooltipEnabled

static boolean setSpecialAttackTooltipEnabled(boolean enable)

Sets the option for special attack tool-tips.

setStatsPanelXpEnabled

static boolean setStatsPanelXpEnabled(boolean enable)

Sets the option for showing XP til next level in the stats panel.

setTransparentChatboxEnabled

static boolean setTransparentChatboxEnabled(boolean enable)

Sets the option for chat-box transparency.

setTransparentSidePanelsEnabled

static boolean setTransparentSidePanelsEnabled(boolean enable)

Sets the option for side panel transparency.

setXpDropsEnabled

static boolean setXpDropsEnabled(boolean enable)

Sets the option for showing XP drops.

setZoomWithScrollEnabled

static boolean setZoomWithScrollEnabled(boolean enable)

Turns zoom with mouse scroll on or off.

turnAllSoundsOff

static boolean turnAllSoundsOff()

Turn all sounds off

turnAreaSoundOff

static boolean turnAreaSoundOff()

Turn area sound off

turnMusicOff

static boolean turnMusicOff()

Turn music off

turnSoundEffectsOff

static boolean turnSoundEffectsOff()

Turn sound effect off