ChooseOption¶

Methods to interact with the runescape context menu.

TRSOption¶

Helper record to interact with ChooseOption.

TRSChooseOption¶

Core record responsible with interacting with the ChooseOption context menu.

ChooseOption.IsOpen¶

function TRSChooseOption.IsOpen(): Boolean;

Returns True/False if the ChooseOption menu is currently visible/open.

Example:

WriteLn ChooseOption.IsOpen();

ChooseOption.WaitOpen¶

function TRSChooseOption.WaitOpen(time: Integer; interval: Integer = -1): Boolean;

Returns True/False if the ChooseOption menu is becomes visible/open within the specified time.

Example:

WriteLn ChooseOption.WaitOpen();

ChooseOption.Open¶

function TRSChooseOption.Open(): Boolean;

Opens the ChooseOption context menu if it’s not currently open.

Example:

WriteLn ChooseOption.Open();

ChooseOption.GetOptions¶

function TRSChooseOption.GetOptions(): TRSChooseOption_OptionArray;

Returns a TRSOptionArray of all available options in the ChooseOption context menu. This is a internal method, you probably don’t need to call it.

ChooseOption.FindSubmenu¶

function TRSChooseOption.FindSubmenu(): TBox;

Returns the bounds of the submenu if it exists, otherwise returns an empty TBox.

ChooseOption.Close¶

function TRSChooseOption.Close(): Boolean;

Closes the ChooseOption context menu if it’s open. Returns True on success.

Example:

WriteLn ChooseOption.Close();

ChooseOption.HasOption¶

function TRSChooseOption.Find(text: TStringArray; out option: TRSOption; caseSensitive: Boolean = True; closeIfNotFound: Boolean = True): Boolean;
function TRSChooseOption.Find(text: TStringArray; caseSensitive: Boolean = True; closeIfNotFound: Boolean = True): Boolean; overload;

Methods to check if an option is available in the ChooseOption context menu. Returns true if the option specified is available.

Example:

WriteLn ChooseOption.Find('Take');

ChooseOption.Hover¶

procedure TRSChooseOption.Hover(option: TRSOption);
function TRSChooseOption.Hover(text: TStringArray; caseSensitive, closeOnFalse: Boolean = True): Boolean; overload;
function TRSChooseOption.Hover(text: String; caseSensitive, closeOnFalse: Boolean = True): Boolean; overload;

Hovers the specified option if it exists on the ChooseOption context menu.

Example:

WriteLn ChooseOption.Select('Take Bones');

ChooseOption.Select¶

procedure TRSChooseOption.Select(option: TRSOption; mouseAction: Int32 = MOUSE_LEFT);
function TRSChooseOption.Select(text: TStringArray; mouseAction: Int32 = MOUSE_LEFT; caseSensitive: Boolean = True; closeIfNotFound: Boolean = True): Boolean; overload;
function TRSChooseOption.Select(text: String; mouseAction: Int32 = MOUSE_LEFT; caseSensitive: Boolean = True; closeIfNotFound: Boolean = True): Boolean; overload;

Selects the specified option if it exists on the ChooseOption context menu.

Example:

WriteLn ChooseOption.Select('Take Bones');

ChooseOption.HasSubmenu¶

function TRSChooseOption.HasSubmenu(): Boolean;

Returns True if the ChooseOption context menu has a submenu (indicated by ‘ >’ in the option text).

ChooseOption.IsSubmenuOpen¶

function TRSChooseOption.IsSubmenuOpen(): Boolean;

Returns True if a submenu is currently open and visible.

ChooseOption.OpenSubmenu¶

function TRSChooseOption.OpenSubmenu(closeIfNotFound: Boolean = True): Boolean;

Opens a submenu if it exists. Returns True if successful. If closeIfNotFound is True, closes the context menu if no submenu is found.

ChooseOption.GetSubmenuOptions¶

function TRSChooseOption.GetSubmenuOptions(): TRSOptionArray;

Returns a TRSOptionArray of all available options in the submenu. This is a internal method, you probably don’t need to call it.

ChooseOption.FindSubmenuOption¶

function TRSChooseOption.FindSubmenuOption(text: TStringArray; out option: TRSOption; caseSensitive, closeIfNotFound: Boolean = True): Boolean;

Searches for a specific option in the submenu. Returns True if found. The found option is returned through the ‘option’ parameter.

ChooseOption.HoverSubmenuOption¶

function TRSChooseOption.HoverSubmenuOption(option: TRSOption): Boolean;
function TRSChooseOption.HoverSubmenuOption(text: TStringArray; caseSensitive, closeIfNotFound: Boolean = True): Boolean; overload;

Hovers over a specific option in the submenu. Returns True if successful.

ChooseOption.SelectSubmenuOption¶

function TRSChooseOption.SelectSubmenuOption(option: TRSOption): Boolean;
function TRSChooseOption.SelectSubmenuOption(text: TStringArray; caseSensitive, closeIfNotFound: Boolean = True): Boolean;

Selects a specific option in the submenu by clicking on it. Returns True if successful.

ChooseOption variable¶

Global TRSChooseOption variable.