feat(bank): more methods and fixes

Author: Torwent

osrs/interfaces/interface.simba

@@ -77,8 +77,11 @@ begin
 end;
 
 function TRSInterfaceTitle.IsTitle(const text: String; const similarity: Single = 0.8): Boolean;
+var
+  match: Single;
 begin
-  Result := OCR.LocateInvert(Self.Bounds, text, [$344049,0], 2, RSFonts.BOLD) >= similarity;
+  match := OCR.LocateInvert(Self.Bounds, text, [$344049,0], 2, RSFonts.BOLD);
+  Result := match >= similarity;
 end;
 
 function TRSInterfaceTitle.WaitTitle(const text: String; const similarity: Single = 0.8; const time: Integer = 600; interval: Integer = -1): Boolean; overload;

osrs/interfaces/interfacecontrols.simba

@@ -26,7 +26,7 @@ begin
       Exit(True);
 end;
 
-function TRSButton.WaitEnabled(const time: Integer; interval: Integer = -1): Boolean;
+function TRSButton.WaitEnabled(const time: Integer = 600; interval: Integer = -1): Boolean;
 begin
   if interval < 0 then interval := RandomMode(100, 50, 1500);
   Result := SleepUntil(Self.Enabled(), interval, time);
@@ -41,7 +41,7 @@ function TRSButton.Enable(): Boolean;
 begin
   if Self.Enabled() then Exit(True);
   Self.Click();
-  Result := Self.WaitEnabled(600);
+  Result := Self.WaitEnabled();
 end;
 
 function TRSButton.Disable(): Boolean;
@@ -233,7 +233,7 @@ end;
 
 function TRSScrollBar.SetLevel(value: Integer): Integer;
 var
-  old, new, scrolls: Integer;
+  old, scrolls: Integer;
   direction: Boolean;
   area: TBox;
 begin
@@ -250,11 +250,11 @@ begin
     scrolls := Random(1, 3);
     if direction then scrolls := -scrolls;
     Target.MouseScroll(scrolls);
-    new := Self.GetLevel();
+    Result := Self.GetLevel();
 
     //user probably hover them while using RI
-    if new = old then Mouse.Move(area, True);
-    old := new;
+    if Result = old then Mouse.Move(area, True);
+    old := Result;
   end;
 end;
 

osrs/interfaces/iteminterface.simba

@@ -49,6 +49,11 @@ begin
     slot := match.Box;
 end;
 
+function TRSItemInterface.Find(item: TRSItem; out slot: TBox): Boolean; overload;
+begin
+  Result := Self.Find([item], slot);
+end;
+
 
 function TRSItemInterface.FindAll(items: TRSItemArray): TBoxArray;
 var

osrs/interfaces/mainscreen/bank.simba

@@ -365,6 +365,51 @@ end;
 
 
 
+function TRSBank.SetArrangement(arrangement: ERSBankArrangement): Boolean;
+begin
+  if Self.ArrangementButtons[arrangement].Enabled() then Exit(True);
+  Result := Self.ArrangementButtons[arrangement].Enable();
+end;
+
+function TRSBank.SetWithdraw(withdraw: ERSBankWithdraw): Boolean;
+begin
+  if Self.WithdrawButtons[withdraw].Enabled() then Exit(True);
+  Result := Self.WithdrawButtons[withdraw].Enable();
+end;
+
+
+(*
+## Bank.Integer2Quantity
+```pascal
+function TRSBank.Integer2Quantity(const quantity: Integer): ERSBankQuantity;
+```
+Internal helper function to convert a integer quantity into a ERSBankQuantity.
+
+Example:
+```pascal
+WriteLn Bank.Integer2Quantity(5);
+WriteLn Bank.Integer2Quantity(7);
+```
+*)
+function TRSBank.Integer2Quantity(const quantity: Integer): ERSBankQuantity;
+begin
+  case quantity of
+    1:  Result := ERSBankQuantity.ONE;
+    5:  Result := ERSBankQuantity.FIVE;
+    10: Result := ERSBankQuantity.TEN;
+    Self.QUANTITY_ALL:  Result := ERSBankQuantity.ALL;
+    else Result := ERSBankQuantity.CUSTOM;
+  end;
+end;
+
+function TRSBank.SetQuantity(quantity: ERSBankQuantity): Boolean;
+begin
+  if Self.QuantityButtons[quantity].Enabled() then Exit(True);
+  Exit(Self.QuantityButtons[quantity].Enable());
+end;
+
+
+
 (*
 ## Bank.IsSearchOpen
 ```pascal
@@ -394,9 +439,9 @@ Example:
 WriteLn Bank.WaitSearchOpen();
 ```
 *)
-function TRSBank.WaitSearchOpen(const time: Integer = 600): Boolean;
+function TRSBank.WaitSearchOpen(const time: Integer = 600; const interval: Integer = -1): Boolean;
 begin
-  Result := Chat.WaitQuery('Show items', True, time);
+  Result := Chat.WaitQuery('Show items', True, time, interval);
 end;
 
 (*
@@ -450,14 +495,16 @@ Bank.Search('logs'); // Search for logs
 ```
 *)
 function TRSBank.Search(item: String): Boolean;
+var
+  query: String;
 begin
-  if Self.Title.IsTitle('Showing items: ' + LowerCase(item)) then
-    Exit(True);
+  query := 'Showing items: ' + item.ToLower();
+  if Self.Title.IsTitle(query) then Exit(True);
+  if not Self.ClearSearch() then Exit;
+  if not Self.OpenSearch(Random(2000, 2500)) then Exit;
 
-  Result := Self.ClearSearch() and
-            Self.OpenSearch(Random(2000, 2500)) and
-            Chat.AnswerQuery('Show items', item, Random(2000, 2500)) and
-            Self.Title.IsTitle('Showing items: ' + LowerCase(item));
+  if Chat.AnswerQuery('Show items', item, Random(2000, 2500)) then
+    Result := Self.Title.WaitTitle(query);
 end;
 
 (*
@@ -520,38 +567,146 @@ begin
 end;
 
 
+(*
+## Bank._FindTabText
+```pascal
+function TRSBank._FindTabText(const tpa: TPointArray; out bounds: TBox): Boolean;
+```
+Internal helper function help process the tabs text when you search.
+
+Example:
+```pascal
+if Bank.Search('logs') then
+  if Bank._FindTabText(Target.FindColor(RSColors.TEXT_LIGHT_YELLOW, 0, bounds), bounds) then
+    ShowOnClient(bounds);
+```
+*)
+function TRSBank._FindTabText(const tpa: TPointArray; out bounds: TBox): Boolean;
+var
+  atpa: T2DPointArray;
+begin
+  if tpa = [] then Exit;
+  atpa := tpa.Cluster(6).ExcludeDimensions(24, 8, 26, 8);
+  if atpa = [] then Exit;
+
+  atpa := atpa.SortByY(False)[0].Cluster(1.5);
+  bounds := atpa.SortByX(False)[0].Bounds();
+
+  bounds.X1 -= 1;
+  bounds.Y1 -= 1;
+  bounds.X2 += 1;
+  bounds.Y2 += 3;
+  Result := True;
+end;
+
+
+(*
+## Bank.FindItemTab
+```pascal
+function TRSBank.FindItemTab(const item: TRSItem; const openTab: Boolean = True): Integer;
+```
+Find the bank tab of `item`.
+
+```{note}
+A known limitation of this is that if several items match the sprite of the item (for example multiple charged jewlry) the tab retrieved will be the first one found. If you have 'Games necklace(1)' in tab 1 and 'Games necklace(8)' in tab 5 and search for the latter, you will get tab 1.
+```
 
-function TRSBank._IsCustomQuantity(quantity: Integer): Boolean;
+Example:
+```pascal
+WriteLn Bank.FindItemTab('Molten glass');
+```
+*)
+function TRSBank.FindItemTab(const item: TRSItem): Integer;
+var
+  bounds: TBox;
 begin
-  Result := not (quantity in [1,5,10, Self.QUANTITY_ALL]);
+  (* TODO: Remove
+  if Self.Items.Contains(item) then
+  begin
+    if not Self.DynamicButtons[ERSBankDynamicButtons.SEARCH].Enabled() then
+      Exit(Self.GetCurrentTab());
+
+    if Self.WaitSearchOpen(600) then
+      if not Self.CloseSearch() then Exit(-1); //unknown state, reset search
+  end;
+  *)
+
+  if not Self.Search(item.SimplifyName()) then Exit(-1);
+  if not Self.Items.Find(item, bounds)  then Exit(-1);
+
+  bounds := [Self.Bounds.X1 + 56, Self.Bounds.Y1 + 77, Self.Bounds.X1 + 84, bounds.Y1];
+  if bounds.Height < 8 then Exit(0);
+
+  if Self._FindTabText(Target.FindColor(RSColors.TEXT_LIGHT_YELLOW, 0, bounds), bounds) then
+    Result := OCR.RecognizeNumber(bounds, RSFonts.PLAIN_11, [RSColors.TEXT_LIGHT_YELLOW], 0);
+  if Self._FindTabText(Target.FindColor(RSColors.TEXT_WHITE, 0, bounds), bounds) then
+    Result := OCR.RecognizeNumber(bounds, RSFonts.PLAIN_11, [RSColors.TEXT_WHITE], 0);
 end;
 
 (*
-## Bank._SimplifyItemName
+## Bank.FindItemScroll
 ```pascal
-function TRSBank._SimplifyItemName(item: TRSItem): String;
+function TRSBank.FindItemScroll(const item: TRSItem): Integer;
+```
+Find the scroll position of the bank where `item` is visible..
+
+```{note}
+A known limitation of this is that if several items match the sprite of the item (for example multiple charged jewlry) the tab retrieved will be the first one found. If you have 'Games necklace(1)' in tab 1 and 'Games necklace(8)' in tab 5 and search for the latter, you will get tab 1.
 ```
-Internal function to get a human like search term for an item as humans
-don't usually type the full item name when searching for something.
 
 Example:
 ```pascal
-WriteLn Bank._SimplifyItemName('Amulet of glory(6)');
+WriteLn Bank.FindItemScroll('Molten glass');
 ```
 *)
-function TRSBank._SimplifyItemName(item: TRSItem): String;
+function TRSBank.FindItemScroll(const item: TRSItem): Integer;
 var
-  str: String;
-  short, long: Integer;
+  next: Integer;
+  down: Boolean;
 begin
-  str := item.Before('(').ToLower();
-  long := Length(str);
-  short := Min(0, long - Ceil(long/3));
+  (* TODO: Remove
+  if Self.Items.Contains(item) then
+  begin
+    if not Self.DynamicButtons[ERSBankDynamicButtons.SEARCH].Enabled() then
+      Exit(Self.Scroll.GetLevel());
+
+    if Self.WaitSearchOpen(600) then
+      if not Self.CloseSearch() then Exit(-1); //unknown state, reset search
+  end;
+  *)
+
+  if not Self.Scroll.CanScroll() then Exit(-1);
+
+  Result := Self.Scroll.GetLevel();
+  down := (Result > 0) or RandomBoolean(0.5);
 
-  Result := str.CopyRange(0, Random(short, long));
+  repeat
+    if down then next := Result - 5
+    else next := Result + 5;
+
+    Result := Self.Scroll.SetLevel(next);
+    if Self.Items.Contains(item) then Exit;
+
+    if not Self.IsOpen() then Exit(-1); //failsafe
+  until not InRange(Result, 1, 99);
+
+  down := not down;
+
+  repeat
+    if down then next := Result - 5
+    else next := Result + 5;
+
+    Result := Self.Scroll.SetLevel(next);
+    if Self.Items.Contains(item) then Exit;
+
+    if not Self.IsOpen() then Exit(-1);
+  until not InRange(Result, 1, 99);
+
+  Result := -1;
 end;
 
 
+
 procedure TRSBank.Draw(img: TImage);
 var
   i: Integer;
@@ -572,17 +727,16 @@ begin
     Self.DynamicButtons[i].Draw(img);
 end;
 
-procedure ShowOnClient(bank: TRSBank); overload;
+procedure TRSBank.ShowOnClient();
 var
   img: TImage;
 begin
   img := TImage.CreateFromTarget();
-  bank.Draw(img);
+  Self.Draw(img);
   img.Show();
   img.Free();
 end;
 
 
-
 var
   Bank: TRSBank;

utils/item.simba

@@ -11,3 +11,29 @@ function TRSItem.HasAmount(): Boolean;
 begin
   Result := Self.EndsWith(')', True);
 end;
+
+(*
+## TRSItem.SimplifyName
+```pascal
+function TRSItem.SimplifyName(): String;
+```
+Internal helper function to get a human like short item name, usually to search.
+
+Example:
+```pascal
+item := 'Amulet of glory(6)';
+WriteLn item.SimplifyName();
+```
+*)
+function TRSItem.SimplifyName(): String;
+var
+  str: String;
+  short, long: Integer;
+begin
+  Result := ToStr(Self).ToLower();
+  if Result.EndsWith(')') then Result := Result.Before('(');
+
+  long := Length(Result);
+  short := Min(0, long - Ceil(long/3));
+  Result := Result.CopyRange(0, Random(short, long));
+end;

utils/misc.simba

@@ -16,8 +16,10 @@ type
     const STACK_GREEN: TColor  = $80FF00;
     const STACK_COLORS: TColorArray = [$00FFFF, $FFFFFF, $80FF00];
 
+    const TEXT_WHITE: TColor = $FFFFFF;
     const TEXT_ORANGE: TColor = $1F98FF;
     const TEXT_GREY: TColor   = $9F9F9F;
+    const TEXT_LIGHT_YELLOW: TColor = $A2D8E4;
   end;
 
 function RSColors.HasItem(const bounds: TBox): Boolean; static;