Options

The options file holds functions and procedures that are used for configuring runescape.

Keep in mind that the option-tab changes qute frequently in OSRS, so over time it’s more likely to get outdated.


type TRSOptions

The type that holds functions and properties of the Runescape options interface.


var Options

Variable that stores functions and properties of the Runescape options interface.


type EOptionsTab

A type that covers the internal tabs in TRSOptions: EOptionsTab = (optDisplay, optAudio, optChat, optControls)


Options.Open

function TRSOptions.Open(): Boolean;

Opens the interface


Options.IsOpen

function TRSOptions.IsOpen(maxWait:Int32=0): Boolean;

Checks if the interface is already open.


Options.GetCurrentTab

function TRSOptions.GetCurrentTab(): EOptionsTab;

Returns which tab is currently active.


Options.SetCurrentTab

function TRSOptions.SetCurrentTab(Tab: EOptionsTab; tryTime:Int32=2000): Boolean;

Sets the current tab to the given Tab


Options.GetBrightness

function TRSOptions.GetBrightness(): Int32;

Returns the mainscreen brightness


Options.SetBrightness

function TRSOptions.SetBrightness(level: Int32; tryTime:Int32=2000): Boolean;

Sets the mainscreen brightness


Options.GetZoom

function TRSOptions.GetZoom(): Int32;

Returns the mainscreen zoom


Options.SetZoom

function TRSOptions.SetZoom(APosition: Byte): Boolean;

Sets the zoom of the mainscreen. 0 = Zoomed out, 100 = Zoomed in.


Options.ToggleAcceptAid

function TRSOptions.ToggleAcceptAid(enable:Boolean; tryTime:Int32=2000): Boolean;

Changes the state of the button to the given state.


Options.ToggleRun

function TRSOptions.ToggleRun(enable:Boolean; tryTime:Int32=2000): Boolean;

Changes the state of the button to the given state.


Options.ToggleChatEffects

function TRSOptions.ToggleChatEffects(enable:Boolean; tryTime:Int32=2000): Boolean;

Changes the state of the button to the given state.


Options.ToggleSplitPrivChat

function TRSOptions.ToggleSplitPrivChat(enable:Boolean; tryTime:Int32=2000): Boolean;

Changes the state of the button to the given state.


Options.ToggleProfanityFilter

function TRSOptions.ToggleProfanityFilter(enable:Boolean; tryTime:Int32=2000): Boolean;

Changes the state of the button to the given state.


Options.ToggleTimeoutNotice

function TRSOptions.ToggleTimeoutNotice(enable:Boolean; tryTime:Int32=2000): Boolean;

Changes the state of the button for “Login/Logout notification timeout” to the given state.


Options.ToggleShiftDrop

function TRSOptions.ToggleShiftDrop(enable:Boolean; tryTime:Int32=2000): Boolean;

Changes the state of the button for “Shift Drop” to the given state.