script-sdk/org.tribot.script.sdk/Options

Options

open 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.

Constructors

Options

constructor()

Types

AttackOption

enum AttackOption

ChatboxScrollPosition

enum ChatboxScrollPosition

HouseDoor

enum HouseDoor

ResizableType

enum ResizableType

Tab

enum Tab

Functions

closeAllSettings

open fun closeAllSettings(): Boolean

closeHouseOptionsTab

open fun closeHouseOptionsTab(): Boolean

Closes House Options Tab

getHouseDoorState

open fun getHouseDoorState(): Options.HouseDoor

getResizableModeType

open fun getResizableModeType(): Options.ResizableType

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

getRunEnergy

open fun ~~getRunEnergy~~(): Int

Gets the current run energy of the player character.

getScrollbarRightPosition

open fun getScrollbarRightPosition(): Options.ChatboxScrollPosition

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

isAcceptAidEnabled

open fun isAcceptAidEnabled(): Boolean

isAcceptTradeDelayEnabled

open fun isAcceptTradeDelayEnabled(): Boolean

Determine if accept trade delay is enabled

isAllSettingsOpen

open fun isAllSettingsOpen(): Boolean

isAnySoundOn

open fun isAnySoundOn(): Boolean

Determines if any sounds is on or off

isAreaSoundOn

open fun isAreaSoundOn(): Boolean

Determines if Area sound is on or off.

isClickThroughChatboxEnabled

open fun isClickThroughChatboxEnabled(): Boolean

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

isDataOrbsEnabled

open fun isDataOrbsEnabled(): Boolean

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

isDisableLevelUpInterfaceEnabled

open fun isDisableLevelUpInterfaceEnabled(): Boolean

Determine if disable level up interface is enabled

isEscapeClosingEnabled

open fun isEscapeClosingEnabled(): Boolean

isFollowerOptionsLowerDownEnabled

open fun isFollowerOptionsLowerDownEnabled(): Boolean

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

isGrandExchangeBuyWarningEnabled

open fun isGrandExchangeBuyWarningEnabled(): Boolean

Determine if grand exchange buy warning is enabled

isGrandExchangeSellWarningEnabled

open fun isGrandExchangeSellWarningEnabled(): Boolean

Determine if grand exchange sell warning is enabled

isHouseOptionsTabOpen

open fun isHouseOptionsTabOpen(): Boolean

Determine if house options tab is open

isHouseTeleportInsideEnabled

open fun isHouseTeleportInsideEnabled(): Boolean

Determine if house teleport inside is on or off

isMouseCameraEnabled

open fun isMouseCameraEnabled(): Boolean

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

isMouseScrollZoomEnabled

open fun isMouseScrollZoomEnabled(): Boolean

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

isMusicSoundOn

open fun isMusicSoundOn(): Boolean

Determines if Music is on or off.

isMusicUnlockMessageEnabled

open fun isMusicUnlockMessageEnabled(): Boolean

Determine if music unlock message is on or off

isPrayerTooltipEnabled

open fun isPrayerTooltipEnabled(): Boolean

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

isResizableModeEnabled

open fun isResizableModeEnabled(): Boolean

Determines if the resizable mode setting is enabled.

isRoofsEnabled

open fun isRoofsEnabled(): Boolean

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

isRunEnabled

open fun isRunEnabled(): Boolean

Determines if the run setting is enabled.

isShiftClickDropEnabled

open fun isShiftClickDropEnabled(): Boolean

Determines if the shift-click drop setting is enabled.

isShowActivityAdviserEnabled

open fun isShowActivityAdviserEnabled(): Boolean

Determine if activity adviser is enabled

isSidePanelsEnabled

open fun isSidePanelsEnabled(): Boolean

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

isSidePanelsHotkeyOpeningEnabled

open fun isSidePanelsHotkeyOpeningEnabled(): Boolean

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

isSoundEffectsOn

open fun isSoundEffectsOn(): Boolean

Determines if Sound effect is on or off.

isSpecialAttackTooltipEnabled

open fun isSpecialAttackTooltipEnabled(): Boolean

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

isStatsPanelXpEnabled

open fun isStatsPanelXpEnabled(): Boolean

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

isTransparentChatboxEnabled

open fun isTransparentChatboxEnabled(): Boolean

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

isTransparentSidePanelsEnabled

open fun isTransparentSidePanelsEnabled(): Boolean

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

isWorldSwitcherConfirmationEnabled

open fun isWorldSwitcherConfirmationEnabled(): Boolean

Determine if world switch confirmations are enabled

isXpDropsEnabled

open fun isXpDropsEnabled(): Boolean

Determines whether the option to show XP drops is enabled.

isZoomWithScrollEnabled

open fun isZoomWithScrollEnabled(): Boolean

Determine if zoom with mouse scroll is on or off

openHouseOptionsTab

open fun openHouseOptionsTab(): Boolean

Opens House Options Tab

setAcceptAid

open fun setAcceptAid(acceptAid: Boolean): Boolean

setClickThroughChatboxEnabled

open fun setClickThroughChatboxEnabled(enable: Boolean): Boolean

Sets the option for clicking through the chat-box.

setDataOrbsEnabled

open fun setDataOrbsEnabled(enable: Boolean): Boolean

Sets the option for showing data-orbs.

setFollowerOptionsLowerDownEnabled

open fun setFollowerOptionsLowerDownEnabled(enable: Boolean): Boolean

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

setHouseDoorState

open fun setHouseDoorState(houseDoor: Options.HouseDoor): Boolean

setHouseTeleportInsideEnabled

open fun setHouseTeleportInsideEnabled(enable: Boolean): Boolean

Set house teleport inside on or off

setMouseCameraEnabled

open fun setMouseCameraEnabled(enable: Boolean): Boolean

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

setMouseScrollZoomEnabled

open fun setMouseScrollZoomEnabled(enable: Boolean): Boolean

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

setMusicUnlockMessageEnabled

open fun setMusicUnlockMessageEnabled(enable: Boolean): Boolean

Turns music unlock message on or off.

setPrayerTooltipEnabled

open fun setPrayerTooltipEnabled(enable: Boolean): Boolean

Sets the option for prayer tool-tips.

setRemoveRoofsEnabled

open fun setRemoveRoofsEnabled(enable: Boolean): Boolean

Configures the setting to remove roofs

setResizableModeType

open fun setResizableModeType(resizableType: Options.ResizableType): Boolean

Sets the resizable display type

setRunEnabled

open fun setRunEnabled(runEnabled: Boolean): Boolean

Turns run on or off.

setScrollbarPosition

open fun setScrollbarPosition(position: Options.ChatboxScrollPosition): Boolean

Sets the option for scroll-bar alignment.

setShiftClickDrop

open fun setShiftClickDrop(enabled: Boolean): Boolean

Turns the shift-click drop setting on or off.

setSidePanelsEnabled

open fun setSidePanelsEnabled(enable: Boolean): Boolean

Sets the option for use of side panels.

setSidePanelsHotkeyOpeningEnabled

open fun setSidePanelsHotkeyOpeningEnabled(enable: Boolean): Boolean

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

setSpecialAttackTooltipEnabled

open fun setSpecialAttackTooltipEnabled(enable: Boolean): Boolean

Sets the option for special attack tool-tips.

setStatsPanelXpEnabled

open fun setStatsPanelXpEnabled(enable: Boolean): Boolean

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

setTransparentChatboxEnabled

open fun setTransparentChatboxEnabled(enable: Boolean): Boolean

Sets the option for chat-box transparency.

setTransparentSidePanelsEnabled

open fun setTransparentSidePanelsEnabled(enable: Boolean): Boolean

Sets the option for side panel transparency.

setXpDropsEnabled

open fun setXpDropsEnabled(enable: Boolean): Boolean

Sets the option for showing XP drops.

setZoomWithScrollEnabled

open fun setZoomWithScrollEnabled(enable: Boolean): Boolean

Turns zoom with mouse scroll on or off.

turnAllSoundsOff

open fun turnAllSoundsOff(): Boolean

Turn all sounds off

turnAreaSoundOff

open fun turnAreaSoundOff(): Boolean

Turn area sound off

turnMusicOff

open fun turnMusicOff(): Boolean

Turn music off

turnSoundEffectsOff

open fun turnSoundEffectsOff(): Boolean

Turn sound effect off