fix: world switcher finished

removed all `const` parameters, it didn't work as I thought it did.

Author: Torwent

osrs/antiban/antiban.simba

@@ -67,7 +67,7 @@ type
     OnFinishTask: procedure(task: PAntibanTask) of object;
   end;
 
-function TAntiban.TimeRunningAtClock(const time: String; const randomness: Double = 0.10): Int64;
+function TAntiban.TimeRunningAtClock(time: String; randomness: Double = 0.10): Int64;
 var
   current, res: TDateTime;
 begin
@@ -94,7 +94,7 @@ end;
 (*
 ## Antiban.AddTask
 ```pascal
-procedure TAntiban.AddTask(const interval: Double; const method: TAntibanMethod; const randomness: Double = 0.2);
+procedure TAntiban.AddTask(interval: Double; method: TAntibanMethod; randomness: Double = 0.2);
 ```
 Schedule a antiban task.
 An antiban task can be any procedure but they should be short actions that won't
@@ -113,7 +113,7 @@ Example:
 Antiban.AddTask(15 * ONE_MINUTE, @Antiban.HoverSkills); //Every 15 minutes the script will hover the skills.
 ```
 *)
-procedure TAntiban.AddTask(const interval: Double; const method: TAntibanMethod; const randomness: Double = 0.2);
+procedure TAntiban.AddTask(interval: Double; method: TAntibanMethod; randomness: Double = 0.2);
 var
   task: TAntibanTask;
 begin
@@ -128,7 +128,7 @@ end;
 (*
 ## Antiban.AddBreak
 ```pascal
-procedure TAntiban.AddBreak(const interval, length: Double; const randomness: Double = 0.2; const logoutChance: Double = 0.33);
+procedure TAntiban.AddBreak(interval, length: Double; randomness: Double = 0.2; logoutChance: Double = 0.33);
 ```
 Schedule a break. Breaks can be of short or medium length and should be shorter than any sleep breaks.
 
@@ -144,7 +144,7 @@ Example:
 Antiban.AddBreak(30 * ONE_MINUTE, 5 * ONE_MINUTE); //Every 30 minutes the script will take a 5 minute break, subject to variance from the randomness variable.
 ```
 *)
-procedure TAntiban.AddBreak(const interval, length: Double; const randomness: Double = 0.2; const logoutChance: Double = 0.33);
+procedure TAntiban.AddBreak(interval, length: Double; randomness: Double = 0.2; logoutChance: Double = 0.33);
 var
   task: TBreakTask;
 begin
@@ -160,7 +160,7 @@ end;
 (*
 ## Antiban.AddSleep
 ```pascal
-procedure TAntiban.AddSleep(const time: String; const length: Double; const randomness: Double = 0.10; const logoutChance: Double = 0.5);
+procedure TAntiban.AddSleep(time: String; length: Double; randomness: Double = 0.10; logoutChance: Double = 0.5);
 ```
 Schedule a sleep break. A sleep break is a large break, it can be any length but
 it's usually the several hours and also the largest one/ones.
@@ -183,7 +183,7 @@ Example:
 Antiban.AddSleep('01:30:45', 8 * ONE_HOUR, 0.1, 0.8); //At 01:30:45 on our computer time the script will take a break for 8 hours, subject to variance from the randomness variable.
 ```
 *)
-procedure TAntiban.AddSleep(const time: String; const length: Double; const randomness: Double = 0.10; const logoutChance: Double = 0.5);
+procedure TAntiban.AddSleep(time: String; length: Double; randomness: Double = 0.10; logoutChance: Double = 0.5);
 var
   task: TSleepTask;
 begin
@@ -451,7 +451,7 @@ while True do        //Infinite loop
   Antiban.DoAntiban(); //Antiban.HoverSkills will be called every time 15 minutes passed when this is called.
 ```
 *)
-function TAntiban.DoAntiban(const checkTasks, checkBreaks, checkSleeps: Boolean = True): Boolean;
+function TAntiban.DoAntiban(checkTasks, checkBreaks, checkSleeps: Boolean = True): Boolean;
 begin
   if Self.DoingAntiban then Exit;
   Self.DoingAntiban := True;
@@ -469,31 +469,31 @@ end;
 (*
 ## Antiban.TimeUntilBreak
 ```pascal
-function TAntiban.TimeUntilBreak(const task: TBreakTask): String;
+function TAntiban.TimeUntilBreak(task: TBreakTask): String;
 ```
 Check how much time is left until the specified break `task` should be taken.
 *)
-function TAntiban.TimeUntilBreak(const task: TBreakTask): String;
+function TAntiban.TimeUntilBreak(task: TBreakTask): String;
 begin
   Result := FormatMilliseconds(Max(0, Round(task.Next - GetTimeRunning())), True);
 end;
 
 (*
 ## Antiban.TimeUntilSleep
 ```pascal
-function TAntiban.TimeUntilSleep(const task: TSleepTask): String;
+function TAntiban.TimeUntilSleep(task: TSleepTask): String;
 ```
 Check how much time is left until the specified sleep break `task` should be taken.
 *)
-function TAntiban.TimeUntilSleep(const task: TSleepTask): String;
+function TAntiban.TimeUntilSleep(task: TSleepTask): String;
 begin
   Result := FormatMilliseconds(Max(0, Round(task.Next - GetTimeRunning())), True);
 end;
 
 (*
 ## Antiban.SimulateBreaks
 ```pascal
-procedure TAntiban.SimulateBreaks(const bottingDays: UInt64 = 1000);
+procedure TAntiban.SimulateBreaks(bottingDays: UInt64 = 1000);
 ```
 Performs a simulation of `bottingDays` amount of days with the currently setup
 breaks and prints the results.
@@ -504,7 +504,7 @@ Antiban.AddBreak(30 * ONE_MINUTE, 5 * ONE_MINUTE);
 Antiban.SimulateBreaks();
 ```
 *)
-procedure TAntiban.SimulateBreaks(const bottingDays: UInt64 = 1000);
+procedure TAntiban.SimulateBreaks(bottingDays: UInt64 = 1000);
 var
   active, inactive, len, prev: Double;
   i: Int32;

osrs/antiban/antibantasks.simba

@@ -93,33 +93,8 @@ begin
 end;
 
 
-function TAntiban.RandomScroll(scroll: TRSScrollBar; down: Boolean = True): Boolean;
-var
-  i: Integer;
-begin
-  if not scroll.IsVisible() or not scroll.CanScroll() then Exit;
-
-  Result := True;
-
-  case down of
-    True:  if scroll.GetLevel() = 100 then Exit;
-    False: if scroll.GetLevel() = 0   then Exit;
-  end;
-
-  Mouse.Move(scroll.GetScrollArea());
-
-  for i := 1 to Biometrics.RandomModeInteger(5, 3, 8) do
-  begin
-    if down then
-      Target.MouseScroll(-Random(1,3))
-    else
-      Target.MouseScroll(Random(1,3));
-  end;
-end;
-
-
 //Stats antiban
-procedure TAntiban.HoverSkill(const skill: ERSSkill; const time: UInt32; const returnToCurrentTab: Boolean);
+procedure TAntiban.HoverSkill(skill: ERSSkill; time: UInt32; returnToCurrentTab: Boolean);
 var
   tab: ERSGameTab;
 begin
@@ -147,7 +122,7 @@ begin
   Self.HoverSkill(Self.Skills.Random(), Trunc(GaussRand(1000, 10000)), RandomBoolean(0.5));
 end;
 
-procedure TAntiban.OpenSkill(const skill: ERSSkill; const time: Integer; const returnToCurrentTab: Boolean);
+procedure TAntiban.OpenSkill(skill: ERSSkill; time: Integer; returnToCurrentTab: Boolean);
 var
   tab: ERSGameTab;
 begin
@@ -185,7 +160,7 @@ end;
 procedure TAntiban.ChatScrolling();
 begin
   WriteLn GetDebugLn('Antiban', 'Random scrolling on chat');
-  Self.RandomScroll(Chat.Scroll, False);
+  Chat.Scroll.Scroll(Biometrics.RandomModeInteger(5, 3, 8), False);
   Biometrics.Sleep(5000, 8000);
   Chat.Scroll.SetLevel(100);
 end;
@@ -270,7 +245,7 @@ procedure TAntiban.BankScrolling();
 begin
   if not Bank.IsOpen() then Exit;
   WriteLn GetDebugLn('Antiban', 'Random scrolling on bank');
-  Antiban.RandomScroll(Bank.Scroll, RandomBoolean(0.5));
+  Chat.Scroll.Scroll(Biometrics.RandomModeInteger(5, 3, 8), RandomBoolean(0.5));
 end;
 
 procedure TAntiban.RandomBankTab();

osrs/interfaces/chooseoption.simba

@@ -70,7 +70,7 @@ end;
 (*
 ## ChooseOption.WaitOpen
 ```pascal
-function TRSChooseOption.WaitOpen(const time: Integer; interval: Integer = -1): Boolean;
+function TRSChooseOption.WaitOpen(time: Integer; interval: Integer = -1): Boolean;
 ```
 Returns True/False if the choose option menu is becomes visible/open within the specified `time`.
 
@@ -79,7 +79,7 @@ Example:
 WriteLn ChooseOption.WaitOpen();
 ```
 *)
-function TRSChooseOption.WaitOpen(const time: Integer; interval: Integer = -1): Boolean;
+function TRSChooseOption.WaitOpen(time: Integer; interval: Integer = -1): Boolean;
 begin
   if interval < 0 then interval := RandomMode(100, 50, 1500);
   Result := SleepUntil(Self.IsOpen(), interval, time);

osrs/interfaces/gametabs/gametabs.simba

@@ -22,13 +22,7 @@ ERSGameTab = enum(NONE, COMBAT, STATS, ACHIEVEMENTS, INVENTORY, EQUIPMENT, PRAYE
 (*
 (TRSGameTabs)=
 ## type TRSGameTabs
-```pascal
-TRSGameTabs = record
-  Bounds: TBox;
-  Tabs: TBoxArray; //Hidden, you are meant to use the Get() method.
-  const ActiveColor: TColorTolerance = [$14194A, 1.235, EColorSpace.HSL, [1.631, 1.084, 0.286]];
-end;
-```
+Main record responsible for handling the gametabs.
 *)
   TRSGameTabs = record
     Bounds: TBox;
@@ -115,7 +109,7 @@ end;
 (*
 ## GameTabs.Get
 ```pascal
-function TRSGameTabs.Get(const tab: ERSGameTab): TBox;
+function TRSGameTabs.Get(tab: ERSGameTab): TBox;
 ```
 Get a GameTab button bounds.
 
@@ -124,7 +118,7 @@ Example:
 ShowOnClient(GameTabs.Get(ERSGameTab.INVENTORY));
 ```
 *)
-function TRSGameTabs.Get(const tab: ERSGameTab): TBox;
+function TRSGameTabs.Get(tab: ERSGameTab): TBox;
 begin
   Result := Self.Tabs[tab-1];
 end;
@@ -157,7 +151,7 @@ end;
 (*
 ## GameTabs.IsOpen
 ```pascal
-function TRSGameTabs.IsOpen(const tab: ERSGameTab): Boolean;
+function TRSGameTabs.IsOpen(tab: ERSGameTab): Boolean;
 ```
 Returns true/false if the specified `tab` is currently open.
 
@@ -166,15 +160,15 @@ Example:
 WriteLn GameTabs.IsOpen(ERSGameTab.INVENTORY);
 ```
 *)
-function TRSGameTabs.IsOpen(const tab: ERSGameTab): Boolean;
+function TRSGameTabs.IsOpen(tab: ERSGameTab): Boolean;
 begin
   Result := Self.GetCurrent() = tab;
 end;
 
 (*
 ## GameTabs.WaitOpen
 ```pascal
-function TRSGameTabs.WaitOpen(const tab: ERSGameTab; const time: Integer = 600; interval: Integer = -1): Boolean;
+function TRSGameTabs.WaitOpen(tab: ERSGameTab; time: Integer = 600; interval: Integer = -1): Boolean;
 ```
 Returns true/false if the specified `tab` opens within the specified `time`.
 
@@ -184,7 +178,7 @@ Mouse.Click(GameTabs.Get(ERSGameTab.INVENTORY), EMouseButton.LEFT);
 WriteLn GameTabs.WaitOpen(ERSGameTab.INVENTORY);
 ```
 *)
-function TRSGameTabs.WaitOpen(const tab: ERSGameTab; const time: Integer = 600; interval: Integer = -1): Boolean;
+function TRSGameTabs.WaitOpen(tab: ERSGameTab; time: Integer = 600; interval: Integer = -1): Boolean;
 begin
   if interval < 0 then interval := RandomMode(100, 50, 1500);
   Result := SleepUntil(Self.IsOpen(tab), interval, time);
@@ -193,7 +187,7 @@ end;
 (*
 ## GameTabs.Open
 ```pascal
-function TRSGameTabs.Open(const tab: ERSGameTab): Boolean;
+function TRSGameTabs.Open(tab: ERSGameTab): Boolean;
 ```
 Attempts to open the specified `tab` gametab.
 
@@ -202,7 +196,7 @@ Example:
 WriteLn GameTabs.Open(ERSGameTab.INVENTORY);
 ```
 *)
-function TRSGameTabs.Open(const tab: ERSGameTab): Boolean;
+function TRSGameTabs.Open(tab: ERSGameTab): Boolean;
 begin
   if Self.IsOpen(tab) then Exit(True);
 

osrs/interfaces/gametabs/logout.simba

@@ -8,13 +8,35 @@ Methods to interact with the logout tab.
 {$ENDIF}
 
 type
+(*
+## Logout Enums
+```pascal
+ERSRating = (ONE, TWO, THREE, FOUR, FIVE);
+ERSLogoutButton = (WORLD_SWITCHER, CLICK_HERE);
+```
+Enums representing the buttons available in the logout gametab.
+*)
   ERSRating = (ONE, TWO, THREE, FOUR, FIVE);
   ERSLogoutButton = (WORLD_SWITCHER, CLICK_HERE);
+
+(*
+(TRSLogout)=
+## type TRSLogout
+Main record that holds and the methods to interact with the logout gametab.
+*)
   TRSLogout = record
     Buttons: array [ERSLoginButton] of TRSButton;
     Ratings: array [ERSRating] of TRSButton;
   end;
 
+(*
+## Logout.SetupInterface
+```pascal
+procedure TRSLogout.SetupInterface();
+```
+Internal method used to setup {ref}`TRSLogout` coordinates.
+This is called automatically for you on the {ref}`Logout` variable.
+*)
 procedure TRSLogout.SetupInterface();
 var
   btns: TBoxArray;
@@ -94,7 +116,7 @@ end;
 (*
 ## Logout.Rate
 ```pascal
-function TRSLogout.Rate(const star: ERSRating): Boolean;
+function TRSLogout.Rate(star: ERSRating): Boolean;
 ```
 Click a star button to rate the game.
 
@@ -103,7 +125,7 @@ Example:
 WriteLn Logout.Rate(ERSRating.FOUR);
 ```
 *)
-function TRSLogout.Rate(const star: ERSRating): Boolean;
+function TRSLogout.Rate(star: ERSRating): Boolean;
 begin
    if Self.Ratings[star].Enabled() and
       ((star = ERSRating.FIVE) or not Self.Ratings[star+1].Enabled()) then
@@ -116,7 +138,7 @@ end;
 (*
 ## Logout.Logout
 ```pascal
-function TRSLogout.Logout(const attempts: UInt32 = 5; const time: UInt32 = 20000): Boolean;
+function TRSLogout.Logout(attempts: UInt32 = 5; time: UInt32 = 20000): Boolean;
 ```
 Attempts to logout of the game. Returns true if we succesfully logout of the game.
 If the {ref}`WorldSwitcher` is open, we will use {ref}`WorldSwitcher.Logout` instead.
@@ -126,7 +148,7 @@ Example:
 WriteLn Logout.Logout();
 ```
 *)
-function TRSLogout.Logout(const attempts: UInt32 = 5; const time: UInt32 = 20000): Boolean;
+function TRSLogout.Logout(attempts: UInt32 = 5; time: UInt32 = 20000): Boolean;
 var
   i: Integer;
   interval: UInt32;
@@ -162,3 +184,11 @@ end;
 
 var
   Logout: TRSLogout;
+
+function TRSWorldSwitcher.Open(waitLoad: Boolean = True): Boolean; override;
+begin
+  if not Logout.Open() then Exit;
+  if WorldSwitcher._IsOpen() then Exit(True);
+  Logout.Buttons[ERSLogoutButton.WORLD_SWITCHER].Click();
+  Result := inherited;
+end;