DepositBox

DepositBox interface.

_images/deposit_box_interface.png

ERSDepositButtons

ERSDepositButtons = enum(WORN, LOOT, INVENTORY);

Enum representing the 3 main deposit buttons of the DepositBox interface.


TRSDepositBox

Main record to interact with the DepositBox interface.


DepositBox.FindItemBoundaries

function TRSDepositBox.FindItemBoundaries(): TBoxArray;

Finds and returns the bounding boxes of items currently visible in the deposit box slots. Used internally by the slot interface for item detection.

Example:

WriteLn DepositBox.FindItemBoundaries();

DepositBox.SetupInterface

procedure TRSDepositBox.SetupInterface;

Internal method used to setup the TRSDepositBox coordinates. This is automatically called for you on the DepositBox variable.


DepositBox.IsOpen

function TRSDepositBox.IsOpen(): Boolean;

Returns true if the DepositBox interface is open.

Example:

WriteLn DepositBox.IsOpen();

DepositBox.WaitOpen

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

Returns true if the DepositBox is open within time milliseconds.

Example:

WriteLn DepositBox.WaitOpen();

DepositBox.Close

function TRSDepositBox.Close(escape: Boolean): Boolean;
function TRSDepositBox.Close(escapeProbability: Single = 0): Boolean; overload;

Closes the depositbox interface. Depending on escape or `escapeProbability the function will either click the button or press escape key.

Example:

 WriteLn DepositBox.Close();

DepositBox.DepositItem

function TRSDepositBox.DepositItem(item: TRSBankItem; useQuantityButtons: Boolean): Boolean;
function TRSDepositBox.DepositItem(item: TRSItem; useQuantityButtons: Boolean): Boolean; overload;

Deposits the specified item into the deposit box. If useQuantityButton is False it will use ChooseOption

Example:

DepositBox.DepositItem('Lobster', True);

DepositBox.DepositItemArray

function TRSDepositBox.DepositItemArray(items: array of TRSBankItem; useQuantityButtons: Boolean): Boolean;
function TRSDepositBox.DepositItemArray(items: TRSItemArray; useQuantityButtons: Boolean): Boolean; overload;

Deposits an array of items into the deposit box. Returns True if all items were successfully deposited. If useQuantityButton is False it will use ChooseOption

Example:

DepositBox.DepositItemArray(['Lobster', 'Swordfish'], True);

DepositBox.DepositInventory

procedure TRSDepositBox.DepositInventory();

Clicks the deposit inventory button to deposit all inventory items at once.

Example:

DepositBox.DepositInventory();

DepositBox.DepositLootBag

procedure TRSDepositBox.DepositLootBag();

Clicks the deposit loot bag button to deposit all items from the looting bag.

Example:

DepositBox.DepositLootBag();

DepositBox.DepositEquipment

procedure TRSDepositBox.DepositEquipment();

Clicks the deposit worn items button to deposit all currently equipped items.

Example:

DepositBox.DepositEquipment();

DepositBox variable

Global TRSDepositBox variable.