feat(MainScreen): MainScreen.Interact read notes

- Added `MainScreen.Interact()` that interacts with the mainscreen with the "option" you specify, using left click or `ChooseOption` as needed.
- Renamed `TRSObject.Select`, `TRSObject.WalkSelect`, `TRSEntity.Select` and `TRSEntity.WalkSelect` to `Interact`
- fixed a typo on fairy ring that wouldn't let WL compile,
- added some TODO placeholders
- made some old code use the new `MainScreen.Interact` methods.
- `TRSWalker.CrossDoor` is not finished but almost working now

Author: Torwent

osrs/interfaces/mainscreen/anvil.simba

@@ -325,13 +325,12 @@ begin
   obj := Self.Anvils[Self.Anvils.ClosestIndex(Map.Position())];
 
   if walk then
-    Result := obj.WalkSelect(['nvil'])
+    Result := obj.WalkInteract(['nvil'])
   else
-    Result := obj.Select(['nvil']);
+    Result := obj.Interact(['nvil']);
 
-  if not Result then
-    if not MainScreen.IsUpText('Smith') or not ChooseOption.Select(['Smith']) then
-      Exit;
+  if not Result and not MainScreen.Interact(['Smith']) then
+    Exit;
 
   obj.Walker^.WaitMoving();
   Result := Self.WaitOpen(3000);

osrs/interfaces/mainscreen/bank.simba

@@ -1322,9 +1322,9 @@ end.
 function TRSBank.Open(constref obj: TRSObject; walk: Boolean = True): Boolean;
 begin
   if walk then
-    Result := obj.WalkSelect(['Bank B', 'Bank E', 'Bank G', 'Use B'])
+    Result := obj.WalkInteract(['Bank B', 'Bank E', 'Bank G', 'Use B'])
   else
-    Result := obj.Select(['Bank B', 'Bank E', 'Bank G', 'Use B']);
+    Result := obj.Interact(['Bank B', 'Bank E', 'Bank G', 'Use B']);
 
   if not Result then
     if not MainScreen.IsUpText('Bank') or not ChooseOption.Select(['Bank B', 'Bank E']) then
@@ -1337,13 +1337,12 @@ end;
 function TRSBank.Open(constref npc: TRSEntity; walk: Boolean = True): Boolean; overload;
 begin
   if walk then
-    Result := npc.WalkSelect(['Bank B', 'Bank E'])
+    Result := npc.WalkInteract(['Bank B', 'Bank E'])
   else
-    Result := npc.Select(['Bank B', 'Bank E']);
+    Result := npc.Interact(['Bank B', 'Bank E']);
 
-  if not Result then
-    if not MainScreen.IsUpText('Bank') or not ChooseOption.Select(['Bank B', 'Bank E']) then
-      Exit;
+  if not Result and not MainScreen.Interact(['Bank B', 'Bank E']) then
+    Exit;
 
   npc.Walker^.WaitMoving();
   Result := Self.WaitOpen(3000);

osrs/interfaces/mainscreen/collectionbox.simba

@@ -318,8 +318,8 @@ begin
 
   if obj.DistanceTo(me) < npc.DistanceTo(me) then
   begin
-    if walk then Result := obj.WalkSelect(['Collect'])
-    else Result := obj.Select(['Collect']);
+    if walk then Result := obj.WalkInteract(['Collect'])
+    else Result := obj.Interact(['Collect']);
 
     if not Result then
     begin
@@ -332,8 +332,8 @@ begin
     Exit;
   end;
 
-  if walk then Result := npc.WalkSelect(['Collect'])
-  else Result := npc.Select(['Collect']);
+  if walk then Result := npc.WalkInteract(['Collect'])
+  else Result := npc.Interact(['Collect']);
 
   if not Result then
   begin

osrs/interfaces/mainscreen/fairyring.simba

@@ -172,6 +172,7 @@ WriteLn FairyRing.Item;
 *)
 function TRSFairyRing.HandleItem(attempts: Int32 = 2): Boolean;
 begin
+  Result := attempts = 2; //Todo...
 end;
 
 
@@ -199,13 +200,7 @@ begin
   if not Self.HandleItem() then
     Exit;
 
-  Mouse.Move(cuboid.ShapeFill().RandomMean());
-  if not MainScreen.IsUpText('Fairy ring') then
-    Exit;
-
-  if MainScreen.IsUpText('onfigure') then
-    Mouse.Click(EMouseButton.LEFT)
-  else if not ChooseOption.Select('onfigure') then
+  if not MainScreen.Interact(cuboid.ShapeFill().RandomMean(), ['onfigure']) then
     Exit;
 
   Minimap.WaitMoving();
@@ -639,7 +634,7 @@ function TRSFairyRing.ClickLogCode(fairyCode: String): Boolean;
 var
   b: TBox;
 begin
-  code := code.Replace(' ', '').ToUpper();
+  fairyCode := fairyCode.Replace(' ', '').ToUpper();
   if Self.Code = fairyCode then
     Exit(True);
 

osrs/interfaces/mainscreen/mainscreen.simba

@@ -361,12 +361,10 @@ begin
 end;
 
 
-{%codetools off}
 function TRSMainScreen._RedClicked(area: TBox): Boolean;
 begin
   Result := Target.HasColor($0000FF, 0, 1, area) or Target.HasColor($0401C8, 0, 1, area);
 end;
-{%codetools on}
 
 (*
 ## MainScreen.RedClicked
@@ -410,13 +408,10 @@ begin
   Result := SleepUntil(Self._RedClicked(area), 50, time);
 end;
 
-
-{%codetools off}
 function TRSMainScreen._YellowClicked(area: TBox): Boolean;
 begin
   Result := Target.HasColor(65535, 0, 1, area);
 end;
-{%codetools on}
 
 (*
 ## MainScreen.YellowClicked
@@ -460,6 +455,38 @@ begin
   Result := SleepUntil(Self._YellowClicked(area), 50, time);
 end;
 
+(*
+## MainScreen.Interact
+```pascal
+function TRSMainScreen.Interact(strings: TStringArray): Boolean;
+function TRSMainScreen.Interact(pt: TPoint; strings: TStringArray): Boolean; overload;
+```
+Attempts to interact with something on the mainscreen.
+If the uptext matches `strings` wasplib will left click, otherwise it will use
+{ref}`ChooseOption`.
+
+Example:
+```pascal
+WriteLn MainScreen.Interact('Pick-up');
+```
+*)
+function TRSMainScreen.Interact(strings: TStringArray): Boolean;
+begin
+  if Self.IsUpText(strings) then
+  begin
+    Mouse.Click(EMouseButton.LEFT);
+    Exit(Self.RedClicked());
+  end;
+
+  if ChooseOption.Select(strings) then
+    Exit(Self.RedClicked());
+end;
+
+function TRSMainScreen.Interact(pt: TPoint; strings: TStringArray): Boolean; overload;
+begin
+  Mouse.Move(pt);
+  Result := Self.Interact(strings);
+end;
 
 var
 (*

osrs/position/house/house.simba

@@ -379,7 +379,7 @@ begin
 
   if Map.Position().AnyInRange(Self.Entrance.Coordinates, 60) then
   begin
-    if not Self.Entrance.WalkSelect(['Home']) then Exit;
+    if not Self.Entrance.WalkInteract(['Home']) then Exit;
     Exit(SleepUntil(Self.Inside(), 300, 10000));
   end;
 
@@ -432,7 +432,7 @@ begin
   begin
     if Map.Position().AnyInRange(Self.Entrance.Coordinates, 60) then
     begin
-      if not Self.Entrance.WalkSelect(['Home']) then Exit;
+      if not Self.Entrance.WalkInteract(['Home']) then Exit;
       Exit(SleepUntil(Self.Inside(), 300, 4000));
     end;
   end;
@@ -444,7 +444,7 @@ begin
 
   case Biometrics.RandomBoolean(0.95) of
     True:  if not HouseOptions.LeaveHouse() then Exit;
-    False: if not Self.Objects[EHouseObject.EXIT].WalkSelect(['Enter']) then Exit;
+    False: if not Self.Objects[EHouseObject.EXIT].WalkInteract(['Enter']) then Exit;
   end;
 
   Result := SleepUntil(not Self.Inside(), 300, 3000);

osrs/position/map/entities.simba

@@ -625,19 +625,13 @@ begin
 end;
 
 (*
-## TRSEntity.SelectOption
+## TRSEntity.Interact
 ```pascal
-function TRSEntity.SelectOption(action: TStringArray; attempts: Integer = 2): Boolean;
+function TRSEntity.Interact(action: TStringArray; attempts: Integer = 2): Boolean;
 ```
 Method used to select an option on a TRSEntity target if it's found on the mainscreen.
-
-Example:
-```pascal
-//Be in ge with a ge map loaded.
-WriteLn RSObjects.GEBank.SelectOption(['Collect']);
-```
 *)
-function TRSEntity.Select(action: TStringArray; attempts: Integer = 2): Boolean;
+function TRSEntity.Interact(action: TStringArray; attempts: Integer = 2): Boolean;
 begin
   Self.Walker^.ActionUpText := action;
   Result := Self.Hover(attempts) and Self._SelectHelper(action);
@@ -669,19 +663,13 @@ begin
 end;
 
 (*
-## TRSEntity.WalkSelectOption
+## TRSEntity.WalkInteract
 ```pascal
-function TRSEntity.WalkSelectOption(action: TStringArray; attempts: Integer = 2): Boolean;
+function TRSEntity.WalkInteract(action: TStringArray; attempts: Integer = 2): Boolean;
 ```
 Method used to walk and select an option on a TRSEntity target if it's found on the mainscreen.
-
-Example:
-```pascal
-//Be in ge with a ge map loaded, preferably far away so it has to walk.
-WriteLn RSObjects.GEBank.WalkSelectOption(['Collect']);
-```
 *)
-function TRSEntity.WalkSelect(action: TStringArray; attempts: Integer = 2): Boolean;
+function TRSEntity.WalkInteract(action: TStringArray; attempts: Integer = 2): Boolean;
 begin
   if Self.Walker = nil then
     raise GetDebugLn('TRSEntity', 'Missing the walker pointer.');

osrs/position/map/objects.simba

@@ -748,9 +748,9 @@ begin
 end;
 
 (*
-## RSObject.Select
+## RSObject.Interact
 ```pascal
-function TRSObject.Select(action: TStringArray; attempts: Integer = 2): Boolean;
+function TRSObject.Interact(action: TStringArray; attempts: Integer = 2): Boolean;
 ```
 Method used to select an option on a `TRSObject` target if it's found on the
 mainscreen.
@@ -769,14 +769,14 @@ var
 begin
   Map.Setup([ERSChunk.VARROCK]);
   objs := TRSObjectArray.Create(ObjectsJSON.GetByAction('Bank'));
-  objs[1].Select(['Collect']);
+  objs[1].Interact(['Collect']);
 end.
 ```
 
 ```{figure} ../../images/obj_select.gif
 ```
 *)
-function TRSObject.Select(action: TStringArray; attempts: Integer = 2): Boolean;
+function TRSObject.Interact(action: TStringArray; attempts: Integer = 2): Boolean;
 begin
   Self.Walker^.ActionUpText := action;
   Result := Self.Hover(action, attempts) and Self._SelectHelper(action);
@@ -824,9 +824,9 @@ begin
 end;
 
 (*
-## RSObject.WalkSelect
+## RSObject.WalkInteract
 ```pascal
-function TRSObject.WalkSelect(action: TStringArray; attempts: Integer = 2): Boolean;
+function TRSObject.WalkInteract(action: TStringArray; attempts: Integer = 2): Boolean;
 ```
 Method used to walk towards and select an option on a `TRSObject` target if it's
 found on the mainscreen.
@@ -845,14 +845,14 @@ var
 begin
   Map.Setup([ERSChunk.VARROCK]);
   objs := TRSObjectArray.Create(ObjectsJSON.GetByAction('Bank'));
-  objs[1].WalkSelect(['Collect']);
+  objs[1].WalkInteract(['Collect']);
 end.
 ```
 
 ```{figure} ../../images/obj_walkselect.gif
 ```
 *)
-function TRSObject.WalkSelect(action: TStringArray; attempts: Integer = 2): Boolean;
+function TRSObject.WalkInteract(action: TStringArray; attempts: Integer = 2): Boolean;
 begin
   if Self.Walker = nil then
     raise GetDebugLn('TRSObject', 'Walker pointer missing.');

osrs/walker.simba

@@ -700,7 +700,7 @@ end;
 function TRSWalker.CrossDoor(me: TPoint; index: Integer; attempts: Integer = 3): Boolean;
 var
   tmp: TPoint;
-  furthest: Integer;
+  furthest, doorAttempts: Integer;
   radians: Double;
   mapPt, minimapPt, flag: TPoint;
   shouldExit, handleDoor: Boolean;
@@ -743,14 +743,17 @@ begin
 
   if handleDoor then
   begin
-    WriteLn GetDebugLn(Self.Name, 'Attempting to open door');
-    cuboid := Self.GetCuboidMS(me, Self._Path[index].Node, [0.6,0.6,4], radians);
-    ShowOnTarget(cuboid);
-    Mouse.Move(cuboid.ShapeFill().RandomMean());
-    if MainScreen.IsUpText('Open') then
-      Mouse.Click(EMouseButton.LEFT)
-    else if not ChooseOption.Select('Open') then
-      Exit;
+    for doorAttempts := 0 to 2 do
+    begin
+      WriteLn GetDebugLn(Self.Name, 'Attempt to open door number: ' + ToStr(doorAttempts+1));
+      cuboid := Self.GetCuboidMS(me, Self._Path[index].Node, [0.6,0.6,4], radians);
+      ShowOnTarget(cuboid);
+      if MainScreen.Interact(cuboid.ShapeFill().RandomMean(), ['Open']) then
+        Break;
+    end;
+    Self.WaitMoving(mapPt, 4);
+    Biometrics.Sleep(600, 800);
+    WriteLn GetDebugLn(Self.Name, 'Door should now be open.');
   end;
 
   Result := Self.CrossDoor(me, index, Dec(attempts));
@@ -764,7 +767,9 @@ begin
     raise GetDebugLn(Self.Name, 'Paths should not end at a stairs node.');
 
   if Abs(Self._Path[index].Node.X - Self._Path[index+1].Node.X) < RSTranslator.MapWidth then
-  'Down';
+    direction := 'Down';
+
+  Result := me = me; //todo...
 end;
 
 function TRSWalker.UseShortcut(me: TPoint; index: Integer): Boolean;