Collection Box¶

Methods to interact with the collection box interface.

ECollectButton enum¶

ECollectButton = enum(INVENTORY, BANK);

Enum representing the Collection Box buttons.

ECollectSlots enum¶

ECollectSlots = enum(STATUS, OPERATION, THUMBNAIL, ITEM, CHANGE);

Enum representing the Collection Box slot slots. The Collection Box, like the Grand Exchange has 8 slots available, Each of those slots, has it’s own 5 small slots which is what this represents:

TCollectionBox type¶

Main record to interact with the Collection Box interface.

CollectionBox.SetupInterface¶

procedure TCollectionBox.SetupInterface();

Internal method used to setup the TCollectionBox type coordinates. This is automatically called for you on the CollectionBox variable.

CollectionBox.IsOpen¶

function TCollectionBox.IsOpen(): Boolean;

Returns true if the collection box is open.

Example:

WriteLn CollectionBox.IsOpen();

CollectionBox.WaitOpen¶

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

Returns true if the collection box opens within time milliseconds..

Example:

WriteLn CollectionBox.WaitOpen();

CollectionBox.HasChange¶

function TCollectionBox.HasChange(slot: Integer): Boolean;

Returns true if the specified collection box slot has change.

Example:

WriteLn CollectionBox.HasChange(0);

CollectionBox.CollectSlot¶

function TCollectionBox.CollectSlot(
  slot: Integer; button: ECollectButton = ECollectButton.INVENTORY
): Boolean;

Attempts to collect the item and change of the specified collection box slot. By default it attempts to collect things to your inventory, you can change it to the bank with the button parameter.

Example:

WriteLn CollectionBox.CollectSlot(0);

CollectionBox.CollectToInventory¶

function TCollectionBox.CollectToInventory(): Boolean;

Attempts to collect the items to the user Inventory.

Example:

WriteLn CollectionBox.CollectToInventory();

CollectionBox.CollectToBank¶

function TCollectionBox.CollectToBank(): Boolean;

Attempts to collect the items to the user Bank.

Example:

WriteLn CollectionBox.CollectToBank();

CollectionBox.Collect¶

function TCollectionBox.Collect(
  items: TItemArray; buttonProbability: Single = -1
): Boolean;

Attempts to collect the specified items to the user Bank.

For antiban purposes there’s a small chance we just collect all items to the bank.

Example:

WriteLn CollectionBox.Collect(['Molten glass']);

CollectionBox.Hover¶

function TCollectionBox.Hover(const obj: TGObject; walk: Boolean = True): Boolean;
function TCollectionBox.Hover(
  const npc: TEntity; walk: Boolean = True
): Boolean; overload;
function TCollectionBox.Hover(walk: Boolean = True): Boolean; overload;

Same as Bank.Hover.

CollectionBox.Open¶

function TCollectionBox.Open(const obj: TGObject; walk: Boolean = True): Boolean;
function TCollectionBox.Open(
  const npc: TEntity; walk: Boolean = True
): Boolean; overload;
function TCollectionBox.Open(walk: Boolean = True): Boolean; overload;

Almost identical to Bank.Open.

Example:

{$I WaspLib/main.simba}
begin
  Map.Setup([EChunk.VARROCK]);
  Bank.Open();
end.

CollectionBox variable¶

Global TCollectionBox type variable.