fix(DepositBox): read notes

- removed ESlots from DepositBox, didn't serve any purpose
- renamed ISlots to Slots in DepositBox
- Gave types to the `TRSSlotInterface` and `TRSItemInterface` functions
- Inventory.Slots now has a "PreConditionFunction"
- Made Hover and Open functions for TRSDepositBox

Author: Torwent

examples/script_template.simba

@@ -56,7 +56,7 @@ begin
 
   Map.Setup([ERSChunk.VARROCK]);
 
-  Antiban.Zoom.Max := 0;
+  Antiban.Zoom.Min := 0;
   Antiban.Zoom.Max := 50;
   Antiban.Skills := [ERSSkill.TOTAL];
 
@@ -157,6 +157,7 @@ begin
     FormCheckbox.SetChecked(True);
 
   Self.CreateAntibanTab();
+  Self.CreateMiscTab();
   Self.Run();
 end;
 

osrs/antiban/antibantasks.simba

@@ -395,7 +395,7 @@ var
 begin
   if not DepositBox.IsOpen() then Exit;
   WriteLn GetDebugLn('Antiban', 'Hovering a random deposit box item');
-  boxes := DepositBox.ISlots.Boxes();
+  boxes := DepositBox.Slots.Boxes();
   if boxes = [] then Exit;
   Mouse.Move(boxes.Random());
   Biometrics.Sleep(500, 2000, ERandomDir.LEFT);

osrs/interfaces/gametabs/inventory.simba

@@ -51,7 +51,7 @@ function TRSInventory.Open(): Boolean; forward;
 
 procedure TRSInventory.SetupGameTab();
 begin
-  Self.Slots.Setup('Inventory.Slots', TBoxArray.Create(GameTab.TopLeft.Offset(13,9), 4, 7, 31, 31, [11, 5]));
+  Self.Slots.Setup('Inventory.Slots', TBoxArray.Create(GameTab.TopLeft.Offset(13,9), 4, 7, 31, 31, [11, 5]), nil, @Self.Open);
   Self.Items.Setup('Inventory.Items', @Self.Slots, [0, 0], @Self.Open);
   Self.ShiftEnabled := True;
 end;

osrs/interfaces/iteminterface.simba

@@ -49,7 +49,7 @@ unless specified otherwise.
     Name: String;
     Slots: ^TRSSlotInterface;
     DiscoverOffset: TPoint;
-    CheckFunction: function (): Boolean of object;
+    PreConditionFunction: TInterfacePreConditionFunction;
   end;
 
 (*
@@ -82,12 +82,17 @@ Bank.Slots.Setup('Bank.Slots', Bank.SlotBoxes, @Bank.FindItemBoundaries);
 Bank.Items.Setup('Bank.Items', @Bank.Slots, [0, 1], @Bank.IsOpen);
 ```
 *)
-procedure TRSItemInterface.Setup(name: String; slots: ^TRSSlotInterface; discoverOffset: TPoint; checkFunc: function (): Boolean of object = nil);
+procedure TRSItemInterface.Setup(
+  name: String;
+  slots: ^TRSSlotInterface;
+  discoverOffset: TPoint;
+  checkFunc: TInterfacePreConditionFunction = nil
+);
 begin
   Self.Name := name;
   Self.Slots := slots;
   Self.DiscoverOffset := discoverOffset;
-  Self.CheckFunction := @checkFunc;
+  Self.PreConditionFunction := @checkFunc;
 end;
 
 
@@ -110,7 +115,7 @@ function TRSItemInterface.IndexOf(items: TRSItemArray): Integer;
 var
   match: TImageMatch;
 begin
-  if (@Self.CheckFunction <> nil) and not Self.CheckFunction() then
+  if (@Self.PreConditionFunction <> nil) and not Self.PreConditionFunction() then
     Exit(-1);
   if ItemFinder.Find(items, Self.Slots^.Boxes(), match) then
     Exit(match.Index);
@@ -137,7 +142,7 @@ function TRSItemInterface.IndicesOf(items: TRSItemArray): TIntegerArray;
 var
   match: TImageMatch;
 begin
-  if (@Self.CheckFunction <> nil) and not Self.CheckFunction() then
+  if (@Self.PreConditionFunction <> nil) and not Self.PreConditionFunction() then
     Exit;
 
   for match in ItemFinder.FindAll(items, Self.Slots^.Boxes()) do
@@ -170,7 +175,7 @@ function TRSItemInterface.FindAny(items: TRSItemArray; out slot: TBox): Boolean;
 var
   match: TImageMatch;
 begin
-  if (@Self.CheckFunction <> nil) and not Self.CheckFunction() then
+  if (@Self.PreConditionFunction <> nil) and not Self.PreConditionFunction() then
     Exit;
 
   Result := ItemFinder.Find(items, Self.Slots^.Boxes(), match);
@@ -210,7 +215,7 @@ function TRSItemInterface.Find(items: TRSItemArray; out slot: Integer): Boolean;
 var
   match: TImageMatch;
 begin
-  if (@Self.CheckFunction <> nil) and not Self.CheckFunction() then
+  if (@Self.PreConditionFunction <> nil) and not Self.PreConditionFunction() then
     Exit;
 
   Result := ItemFinder.Find(items, Self.Slots^.Boxes(), match);
@@ -254,7 +259,7 @@ function TRSItemInterface.FindAll(items: TRSItemArray): TBoxArray;
 var
   match: TImageMatch;
 begin
-  if (@Self.CheckFunction <> nil) and not Self.CheckFunction() then
+  if (@Self.PreConditionFunction <> nil) and not Self.PreConditionFunction() then
     Exit;
 
   for match in ItemFinder.FindAll(items, Self.Slots^.Boxes()) do
@@ -267,7 +272,7 @@ var
   i: Integer;
 begin
   slots := [];
-  if (@Self.CheckFunction <> nil) and not Self.CheckFunction() then
+  if (@Self.PreConditionFunction <> nil) and not Self.PreConditionFunction() then
     Exit;
 
   Result := ItemFinder.FindAll(items, Self.Slots^.Boxes(), matches);
@@ -282,7 +287,7 @@ var
   i: Integer;
 begin
   boxes := [];
-  if (@Self.CheckFunction <> nil) and not Self.CheckFunction() then
+  if (@Self.PreConditionFunction <> nil) and not Self.PreConditionFunction() then
     Exit;
 
   Result := ItemFinder.FindAll(items, Self.Slots^.Boxes(), matches);
@@ -361,7 +366,7 @@ function TRSItemInterface.ContainsAll(items: TRSItemArray): Boolean;
 var
   matches: TImageMatchArray;
 begin
-  if (@Self.CheckFunction <> nil) and not Self.CheckFunction() then
+  if (@Self.PreConditionFunction <> nil) and not Self.PreConditionFunction() then
     Exit;
   Result := ItemFinder.FindAll(items, Self.Slots^.Boxes(), matches);
 end;
@@ -409,7 +414,7 @@ end;
 
 function TRSItemInterface.Discover(slot: Integer): TRSItemArray;
 begin
-  if (@Self.CheckFunction <> nil) and not Self.CheckFunction() then
+  if (@Self.PreConditionFunction <> nil) and not Self.PreConditionFunction() then
     Exit;
 
   Result := Self._Discover(slot);
@@ -419,7 +424,7 @@ function TRSItemInterface.DiscoverAllEx(): array of TRSItemArray;
 var
   slot: Integer;
 begin
-  if (@Self.CheckFunction <> nil) and not Self.CheckFunction() then
+  if (@Self.PreConditionFunction <> nil) and not Self.PreConditionFunction() then
     Exit;
 
   for slot := Low(Self.Slots^.Boxes()) to High(Self.Slots^.Boxes()) do
@@ -431,7 +436,7 @@ var
   slot: Integer;
   items: TRSItemArray;
 begin
-  if (@Self.CheckFunction <> nil) and not Self.CheckFunction() then
+  if (@Self.PreConditionFunction <> nil) and not Self.PreConditionFunction() then
     Exit;
 
   for slot := Low(Self.Slots^.Boxes()) to High(Self.Slots^.Boxes()) do
@@ -693,7 +698,7 @@ var
   center: TPoint;
   dist, closest: Double;
 begin
-  if (@Self.CheckFunction <> nil) and not Self.CheckFunction() then
+  if (@Self.PreConditionFunction <> nil) and not Self.PreConditionFunction() then
     Exit;
   slots := Self.Slots^.Boxes();
   if not ItemFinder.FindAll([item], slots, matches) then Exit;
@@ -753,7 +758,7 @@ function TRSItemInterface.Interact(slot: Integer; option: String = ''): Boolean;
 var
   box: TBox;
 begin
-  if (@Self.CheckFunction <> nil) and not Self.CheckFunction() then
+  if (@Self.PreConditionFunction <> nil) and not Self.PreConditionFunction() then
     Exit;
 
   if not Self.Slots^.IsUsed(slot) then Exit;

osrs/interfaces/mainscreen/bank.simba

@@ -1394,8 +1394,8 @@ end;
 (*
 ## Bank.Hover
 ```pascal
-function TRSBank.Hover(constref obj: TRSObject; walk: Boolean = True): Boolean;
-function TRSBank.Hover(constref npc: TRSEntity; walk: Boolean = True): Boolean; overload;
+function TRSBank.Hover(const obj: TRSObject; walk: Boolean = True): Boolean;
+function TRSBank.Hover(const npc: TRSEntity; walk: Boolean = True): Boolean; overload;
 function TRSBank.Hover(walk: Boolean = True): Boolean; overload;
 ```
 Hovers the closest bank that WaspLib is aware of.
@@ -1409,14 +1409,14 @@ loaded map.
 
 If you are too far, it will attempt to walk closer to it.
 *)
-function TRSBank.Hover(constref obj: TRSObject; walk: Boolean = True): Boolean;
+function TRSBank.Hover(const obj: TRSObject; walk: Boolean = True): Boolean;
 begin
   if walk then
     Exit(obj.WalkHover());
   Result := obj.Hover();
 end;
 
-function TRSBank.Hover(constref npc: TRSEntity; walk: Boolean = True): Boolean; overload;
+function TRSBank.Hover(const npc: TRSEntity; walk: Boolean = True): Boolean; overload;
 begin
   if walk then
     Exit(npc.WalkHover());
@@ -1425,27 +1425,27 @@ end;
 
 function TRSBank.Hover(walk: Boolean = True): Boolean; overload;
 var
-  obj: TRSObject;
-  npc: TRSEntity;
+  obj: PRSObject;
+  npc: PRSEntity;
   me: TPoint;
 begin
   if (Self.Banks = []) or (Self.Bankers = []) then
     Self._SetupMapObjects();
 
   me := Map.Position();
-  obj := Self.Banks[Self.Banks.ClosestIndex(me)];
-  npc := Self.Bankers[Self.Bankers.ClosestIndex(me)];
+  obj := @Self.Banks[Self.Banks.ClosestIndex(me)];
+  npc := @Self.Bankers[Self.Bankers.ClosestIndex(me)];
 
-  if obj.DistanceTo(me) < npc.DistanceTo(me) then
-    Exit(Self.Hover(obj, walk));
-  Result := Self.Hover(npc, walk);
+  if obj^.DistanceTo(me) < npc^.DistanceTo(me) then
+    Exit(Self.Hover(obj^, walk));
+  Result := Self.Hover(npc^, walk);
 end;
 
 (*
 ## Bank.Open
 ```pascal
-function TRSBank.Open(constref obj: TRSObject; walk: Boolean = True): Boolean;
-function TRSBank.Open(constref npc: TRSEntity; walk: Boolean = True): Boolean; overload;
+function TRSBank.Open(const obj: TRSObject; walk: Boolean = True): Boolean;
+function TRSBank.Open(const npc: TRSEntity; walk: Boolean = True): Boolean; overload;
 function TRSBank.Open(walk: Boolean = True): Boolean; overload;
 ```
 Opens the bank for you.
@@ -1471,7 +1471,7 @@ end.
 ```{figure} ../../images/bankopen.gif
 ```
 *)
-function TRSBank.Open(constref obj: TRSObject; walk: Boolean = True): Boolean;
+function TRSBank.Open(const obj: TRSObject; walk: Boolean = True): Boolean;
 begin
   if walk then
     Result := obj.WalkInteract(['Bank B', 'Bank E', 'Bank G', 'Use B'])
@@ -1486,7 +1486,7 @@ begin
   Result := Self.WaitOpen(3000);
 end;
 
-function TRSBank.Open(constref npc: TRSEntity; walk: Boolean = True): Boolean; overload;
+function TRSBank.Open(const npc: TRSEntity; walk: Boolean = True): Boolean; overload;
 begin
   if walk then
     Result := npc.WalkInteract(['Bank B', 'Bank E'])
@@ -1502,8 +1502,8 @@ end;
 
 function TRSBank.Open(walk: Boolean = True): Boolean; overload;
 var
-  obj: TRSObject;
-  npc: TRSEntity;
+  obj: PRSObject;
+  npc: PRSEntity;
   me: TPoint;
 begin
   if MSInterface.IsOpen() then
@@ -1517,12 +1517,12 @@ begin
     Self._SetupMapObjects();
 
   me := Map.Position();
-  obj := Self.Banks[Self.Banks.ClosestIndex(me)];
-  npc := Self.Bankers[Self.Bankers.ClosestIndex(me)];
+  obj := @Self.Banks[Self.Banks.ClosestIndex(me)];
+  npc := @Self.Bankers[Self.Bankers.ClosestIndex(me)];
 
-  if obj.DistanceTo(me) < npc.DistanceTo(me) then
-    Exit(Self.Open(obj, walk));
-  Result := Self.Open(npc, walk);
+  if obj^.DistanceTo(me) < npc^.DistanceTo(me) then
+    Exit(Self.Open(obj^, walk));
+  Result := Self.Open(npc^, walk);
 end;
 
 (*

osrs/interfaces/mainscreen/collectionbox.simba

@@ -272,31 +272,31 @@ end;
 
 function TRSCollectionBox.Hover(walk: Boolean = True): Boolean;
 var
-  obj: TRSObject;
-  npc: TRSEntity;
+  obj: PRSObject;
+  npc: PRSEntity;
   me: TPoint;
 begin
   if (Bank.Banks = []) or (Bank.Bankers = []) then
     Bank._SetupMapObjects();
 
   me := Map.Position();
-  obj := Bank.Banks[Bank.Banks.ClosestIndex(me)];
-  npc := Bank.Bankers[Bank.Bankers.ClosestIndex(me)];
+  obj := @Bank.Banks[Bank.Banks.ClosestIndex(me)];
+  npc := @Bank.Bankers[Bank.Bankers.ClosestIndex(me)];
 
-  if obj.DistanceTo(me) < npc.DistanceTo(me) then
+  if obj^.DistanceTo(me) < npc^.DistanceTo(me) then
   begin
-    if walk then Exit(obj.WalkHover());
-    Exit(obj.Hover());
+    if walk then Exit(obj^.WalkHover());
+    Exit(obj^.Hover());
   end;
 
-  if walk then Exit(npc.WalkHover());
-  Result := npc.Hover();
+  if walk then Exit(npc^.WalkHover());
+  Result := npc^.Hover();
 end;
 
 function TRSCollectionBox.Open(walk: Boolean = True): Boolean;
 var
-  obj: TRSObject;
-  npc: TRSEntity;
+  obj: PRSObject;
+  npc: PRSEntity;
   me: TPoint;
 begin
   if MSInterface.IsOpen() then
@@ -309,35 +309,35 @@ begin
     Bank._SetupMapObjects();
 
   me := Map.Position();
-  obj := Bank.Banks[Bank.Banks.ClosestIndex(me)];
-  npc := Bank.Bankers[Bank.Bankers.ClosestIndex(me)];
+  obj := @Bank.Banks[Bank.Banks.ClosestIndex(me)];
+  npc := @Bank.Bankers[Bank.Bankers.ClosestIndex(me)];
 
-  if obj.DistanceTo(me) < npc.DistanceTo(me) then
+  if obj^.DistanceTo(me) < npc^.DistanceTo(me) then
   begin
-    if walk then Result := obj.WalkInteract(['Collect'])
-    else Result := obj.Interact(['Collect']);
+    if walk then Result := obj^.WalkInteract(['Collect'])
+    else Result := obj^.Interact(['Collect']);
 
     if not Result then
     begin
       Result := MainScreen.IsUpText('Bank') and ChooseOption.Select(['Collect']);
       if not Result then Exit;
     end;
 
-    obj.Walker^.WaitMoving();
+    obj^.Walker^.WaitMoving();
     Result := Self.WaitOpen(3000);
     Exit;
   end;
 
-  if walk then Result := npc.WalkInteract(['Collect'])
-  else Result := npc.Interact(['Collect']);
+  if walk then Result := npc^.WalkInteract(['Collect'])
+  else Result := npc^.Interact(['Collect']);
 
   if not Result then
   begin
     Result := MainScreen.IsUpText('Bank') and ChooseOption.Select(['Collect']);
     if not Result then Exit;
   end;
 
-  npc.Walker^.WaitMoving();
+  npc^.Walker^.WaitMoving();
   Result := Self.WaitOpen(3000);
 end;