fix: BankPin finished

still need testing and rework .Enter() a little

Author: Torwent

osrs/interfaces/chat/chat.simba

@@ -281,17 +281,23 @@ begin
   option := Self.FindOption(chatOption, caseSensitive, colors);
   if option = [] then Exit;
 
-  Result := True;
-  if Keyboard.UseKeyboard(keyboardProbability) then
+  if keyboardProbability < 0 then
+    keyboardProbability := Biometrics.RandomDouble(0.5);
+
+  if RandomBoolean(keyboardProbability) then
     Keyboard.PressKey(option.Key)
   else
     Mouse.Click(option.Bounds, EMouseButton.LEFT);
+
+  Result := True;
 end;
 
 function TRSChat.ContinueChat(keyboardProbability: Single = -1): Boolean;
 var
   colors: TIntegerArray;
 begin
+  if keyboardProbability < 0 then
+    keyboardProbability := Biometrics.RandomDouble(0.5);
   colors := Self.GetColors([ERSChatColor.BLUE, ERSChatColor.WHITE]);
   if not Self.Select('Click here to continue', True, keyboardProbability, colors) then
     Exit;

osrs/interfaces/mainscreen/bankpin.simba

@@ -10,13 +10,10 @@ Methods to interact with the bank pin interface.
 type
   TRSBankPin = record
     Bounds: TBox;
-    Buttons: TRSButtonArray;
+    Buttons: TBoxArray;
   end;
 
 procedure TRSBankPin.SetupInterface();
-var
-  boxes: TBoxArray;
-  i: Integer;
 begin
   with InterfaceArea do
   begin
@@ -26,21 +23,211 @@ begin
     Self.Bounds.Y2 := Min(Floor(Center.Y+(Height-3)/2), Center.Y+157);
   end;
 
-  boxes := TBoxArray.Create(Self.Bounds.TopLeft.Offset(25,88), 3, 3, 55, 55, [39, 17]);
-  boxes.Insert(boxes[2].Offset([84, 0]), 3);
+  Self.Buttons := TBoxArray.Create(Self.Bounds.TopLeft.Offset(21,84), 3, 3, 63, 63, [31, 9]);
+  Self.Buttons.Insert(Self.Buttons[2].Offset([84, 0]), 3);
+end;
+
+(*
+## BankPin.IsOpen
+```pascal
+function TRSBankPin.IsOpen(): Boolean;
+```
+Returns true if the bank pin is open.
+
+Example:
+```pascal
+WriteLn BankPin.IsOpen();
+```
+*)
+function TRSBankPin.IsOpen(): Boolean;
+begin
+  Result := Target.HasColor($060D56, 10, 3400, Self.Buttons[0]);
+end;
+
+(*
+## BankPin.WaitOpen
+```pascal
+function TRSBankPin.WaitOpen(time: Integer = 600; interval: Integer = -1): Boolean;
+```
+Returns true if the bank pin opens within `time` milliseconds..
+
+Example:
+```pascal
+WriteLn BankPin.WaitOpen();
+```
+*)
+function TRSBankPin.WaitOpen(time: Integer = 600; interval: Integer = -1): Boolean;
+begin
+  if interval < 0 then interval := RandomMode(100, 50, 1500);
+  Result := SleepUntil(Self.IsOpen(), interval, time);
+end;
+
+
+(*
+## BankPin.IsLoading
+```pascal
+function TRSBankPin.IsLoading(): Boolean;
+```
+Returns true if the bank pin is loading.
+The bank pin is loading when the interface is open but the pin numbers are not
+available yet.
+
+Example:
+```pascal
+WriteLn BankPin.IsLoading();
+```
+*)
+function TRSBankPin.IsLoading(): Boolean;
+begin
+  Result := not Target.HasColor($007FFF, 0, 1, Self.Buttons[0]);
+end;
 
-  SetLength(Self.Buttons, 10);
-  for i := 0 to High(boxes) do
+(*
+## BankPin.WaitLoading
+```pascal
+function TRSBankPin.WaitLoading(time: Integer = 600; interval: Integer = -1): Boolean;
+```
+Returns true if the bank pin finishes loading within `time` milliseconds..
+For more information on bank pin loading read {ref}`BankPin.IsLoading`.
+
+Example:
+```pascal
+WriteLn BankPin.WaitLoading();
+```
+*)
+function TRSBankPin.WaitLoading(time: Integer = 600; interval: Integer = -1): Boolean;
+begin
+  if interval < 0 then interval := RandomMode(100, 50, 1500);
+  Result := SleepUntil(not Self.IsLoading(), interval, time);
+end;
+
+
+(*
+## BankPin.ClickDigit
+```pascal
+function TRSBankPin.ClickDigit(digit: Char): Boolean; override;
+```
+Clicks a bank pin digit.
+
+Example:
+```pascal
+WriteLn BankPin.ClickDigit('5');
+```
+*)
+function TRSBankPin.ClickDigit(digit: Char): Boolean;
+var
+  i: Integer;
+  hovering: Boolean;
+begin
+  for i := 0 to High(Self.Buttons) do
   begin
-    Self.Buttons[i].Bounds := boxes[i];
-    Self.Buttons[i].EnabledColors := [];
+    if Self.Buttons[i].Contains(Mouse.Position()) then
+    begin
+      hovering := True;
+      Continue;
+    end;
+
+    if OCR.Locate(Self.Buttons[i], digit, [$007FFF], 0, RSFonts.BOLD) > 0.95 then
+    begin
+      Mouse.Click(Self.Buttons[i], EMouseButton.LEFT);
+      Exit(True);
+    end;
+  end;
+
+  if hovering then
+  begin
+    Mouse.Click(EMouseButton.LEFT);
+    Exit(True);
   end;
 end;
 
-function TRSBankPin.IsOpen(): Boolean;
-begin               //TODO:
-  Result := Target.HasColor($060D56, 10, 30000, Self.Bounds);
+
+(*
+## BankPin.GetDigitIndex
+```pascal
+function TRSBankPin.GetDigitIndex(): Integer;
+```
+Returns the index of the next digit to enter.
+
+Example:
+```pascal
+WriteLn BankPin.GetDigitIndex();
+```
+*)
+function TRSBankPin.GetDigitIndex(): Integer;
+const
+  DIGITS: TStringArray = ['FIRST', 'SECOND', 'THIRD', 'FOURTH'];
+var
+  i: Integer;
+begin
+  for i := 0 to High(DIGITS) do
+    if OCR.Locate(Self.Bounds, DIGITS[i], [$FFFFFF], 0, RSFonts.BOLD) > 0.95 then
+      Exit(i+1);
 end;
 
+(*
+## BankPin.Enter
+```pascal
+function TRSBankPin.Enter(pin: String): Boolean;
+```
+Handles entering the bank pin. Will do 4 attempts before terminating with a fatal error.
+
+Example:
+```pascal
+BankPin.Enter('0000');
+```
+*)
+function TRSBankPin.Enter(pin: String; attempts: Integer = 3): Boolean;
+
+  function _IsUnlocked(): Boolean;
+  begin
+    if Self.IsOpen() then
+      Exit;
+    Result := not Chat.GetChat().ContainsAny(['try again', 'forgotten your PIN', 'PIN incorrectly several']);
+  end;
+
 var
+  i, idx: Integer;
+  digit: Char;
+  chatCache: String;
+begin
+  if attempts <= 0 then Exit;
+
+  for i := 0 to 3 do
+  begin
+    idx := Self.GetDigitIndex();
+    if idx = 0 then Break;
+
+    digit := pin[idx];
+    if not Self.ClickDigit(digit) then Break;
+    Biometrics.Sleep(200, 1500, ERandomDir.LEFT);
+    SleepUntil((idx <> Self.GetDigitIndex()) and not Self.IsLoading(), 100, 5000);
+  end;
+
+  chatCache := Chat.GetChat();
+  if 'try again' in chatCache then
+  begin
+    Chat.ContinueChat();
+    Exit(Self.Enter(pin, Dec(attempts)));
+  end;
+
+  if 'forgotten your PIN' in chatCache then
+  begin
+    SleepUntil(not ('forgotten your PIN' in Chat.GetChat()), 300, 20000);
+    Exit(Self.Enter(pin, Dec(attempts)));
+  end;
+
+  if 'PIN incorrectly several' in chatCache then
+    raise GetDebugLn('BankPin', 'Failed to enter the bank pin several times. Check that the pin is correct.');
+
+  Result := SleepUntil(_IsUnlocked(), 300, 3000) or Self.Enter(pin, Dec(attempts));
+end;
+
+
+var
+(*
+(BankPin variable)=
+## var BankPin
+Global {ref}`TRSBankPin` variable.
+*)
   BankPin: TRSBankPin;

utils/input/keyboard.simba

@@ -17,11 +17,6 @@ begin
   Target.KeyOptions.MaxPressTime := 60;
 end;
 
-function TKeyboard.UseKeyboard(chance: Single): Boolean;
-begin
-  if chance = -1 then Exit(RandomBoolean());
-end;
-
 (*
 ## Keyboard.KeyDown
 ```pascal