Sync release with main and strip comments

Author: Wasp Bot

osrs.simba

@@ -1,52 +1,6 @@
-(*
-# WaspLib
-WaspLib is a library used to bot OldSchool RuneScape with Simba 2.0.
-WaspLib is heavily inspired in previous work done by the SRL Community.
-
-This library is meant to do the job of both [SRL-T](https://github.com/Torwent/SRL-T)
-and the original [WaspLib](https://github.com/Torwent/WaspLib) in Simba 1.4 in a lighter,
-less confusing way.
-*)
-
-(*
-## Compile Directives
-```pascal
-{$DEFINE WL_DEBUG_MOUSE}
-{$DEFINE WL_DISABLE_FAKE_INPUT}
-{$DEFINE WL_KEYBINDS_DEBUG}
-{$DEFINE WL_DEBUG_UPTEXT}
-{$DEFINE WL_DEBUG_INTERFACES}
-{$DEFINE WL_GENERATE_GRAPH_ALWAYS}
-{$DEFINE WL_TRANSPORTER_DEBUG}
-```
-These are the main compiler directives available in the library.
-
-They should be self-explanatory.
-
-You also have the following to override versions, for more information read {ref}`Version`
-```pascal
-{$DEFINE SCRIPT_SIMBA_VERSION := 'version_hash'}
-{$DEFINE SCRIPT_WASPLIB_VERSION := 'version_hash'}
-```
-
-For the {ref}`WaspClient` you also have the following:
-```pascal
-{$DEFINE WASP_LOCAL_DEVELOPMENT}
-{$DEFINE WASP_REFRESH_TOKEN := 'refresh_token'}
-{$DEFINE SCRIPT_ID := 'script_UUID'}
-{$DEFINE SCRIPT_REVISION := 'script_revision'}
-```
-They also should be self-explanatory but you can read more about them in
-{ref}`WaspClient`.
-
-All of the directives above must be added **before** including the library to
-use them, for example:
-```pascal
-{$DEFINE WL_DISABLE_FAKE_INPUT}
-{$I WaspLib/osrs.simba}
-```
-Otherwise WaspLib won't be aware of them.
-*)
+
+
+
 
 {$INCLUDE_ONCE version.simba}
 {$INCLUDE_ONCE utils.simba}

osrs/antiban/antiban.simba

@@ -1,7 +1,4 @@
-(*
-# Antiban
-Methods to handle antiban.
-*)
+
 
 {$DEFINE WL_ANTIBAN_INCLUDED}
 {$IFNDEF WL_OSR}
@@ -41,10 +38,7 @@ type
     Next: Double;
   end;
 
-(*
-## TAntiban
-Main record to handle the built-in WaspLib antiban.
-*)
+
   TAntiban = record
     DoingAntiban: Boolean;
     Debugging: Boolean;
@@ -122,28 +116,7 @@ begin
 end;
 
 
-(*
-## Antiban.AddTask
-```pascal
-procedure TAntiban.AddTask(method: TAntibanMethod; interval: Double; randomness: Double = 0.2);
-```
-Schedule a antiban task.
-An antiban task can be any procedure but they should be short actions that won't
-break your main script.
-
-`method` is a pointer to the task you want to perform. WaspLib includes a couple of them but you may make your own if you want.
-
-`interval` is the aproximate interval of time that has to pass for the antiban
-task to occur and it will be repeated everytime that the interval has passed
-and the antiban is checked with {ref}`Antiban.DoAntiban`.
 
-This task will only occur when **TAntiban.DoAntiban** is called.
-
-Example:
-```pascal
-Antiban.AddTask(@Antiban.HoverSkills, 15 * ONE_MINUTE); //Every 15 minutes the script will run Antiban.HoverSkills().
-```
-*)
 procedure TAntiban.AddTask(method: TAntibanMethod; interval: Double; randomness: Double = 0.2);
 var
   len: Integer;
@@ -153,26 +126,7 @@ begin
   Self._UpdateTask(len, @method, interval, randomness);
 end;
 
-(*
-## Antiban.AddBreak
-```pascal
-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.
-
-`interval` is the aproximate interval of time that has to pass for the break to
-occur and it will be repeated everytime that interval passes and the antiban is
-checked either with {ref}`Antiban.DoBreak` or {ref}`Antiban.DoAntiban`.
-
-`length`, `randomness` and `logoutChance` are the same as {ref}`Antiban.AddSleep`.
-
-This break will only occur when {ref}`Antiban.DoAntiban` is called.
 
-Example:
-```pascal
-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(interval, length: Double; randomness: Double = 0.2; logoutChance: Double = 0.33);
 var
   len: Integer;
@@ -182,34 +136,7 @@ begin
   Self._UpdateBreak(len, interval, length, randomness, logoutChance);
 end;
 
-(*
-## Antiban.AddSleep
-```pascal
-procedure TAntiban.AddSleep(time: String; length: Double; randomness: Double = 0.1; 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.
-
-`time` is the aproximate time you want the break to occur and should be written
-in a "bare" time format (00:00:00).
-
-`length` is how long we will sleep for in milliseconds.
-
-`randomness` is self explanatory, gives variance to the time our script will
-sleep at and it's length too.
-One thing to keep in mind is that randomness only affects time past `time`.
-In other words, you will never sleep before `time`.
-
-`logoutChance` is the probability of logging out for the sleep break or to
-simply afk and logout from inactivity.
 
-This sleep break will only occur when {ref}`Antiban.DoAntiban` is called and our sleep break is due.
-
-Example:
-```pascal
-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(time: String; length: Double; randomness: Double = 0.1; logoutChance: Double = 0.5);
 var
   len: Integer;
@@ -220,15 +147,7 @@ begin
 end;
 
 
-(*
-## Antiban.TakeBreak
-```pascal
-procedure TAntiban.TakeBreak(var task: TBreakTask);
-```
-Internal function used by {ref}`Antiban.DoAntiban` and is responsible for
-performing the specified break `task`.
-In other words, this is what makes the script take the break.
-*)
+
 procedure TAntiban.TakeBreak(var task: TBreakTask);
 var
   countdown: TCountDown;
@@ -281,15 +200,7 @@ begin
   task.Next := GetTimeRunning() + Abs(GaussRand(task.Interval, task.Interval * task.StdVar));
 end;
 
-(*
-## Antiban.TakeSleep
-```pascal
-procedure TAntiban.TakeSleep(var task: TSleepTask);
-```
-Internal function used by {ref}`Antiban.DoAntiban` and is responsible for
-performing the specified sleep `task`.
-In other words, this is what makes the script take the sleep break.
-*)
+
 procedure TAntiban.TakeSleep(var task: TSleepTask);
 var
   countdown: TCountDown;
@@ -344,22 +255,7 @@ begin
 end;
 
 
-(*
-## Antiban.DoTask
-```pascal
-function TAntiban.DoTask(): Boolean;
-```
-Checks for scheduled antiban tasks, if any is due it will do it.
-
-You should only call this when taking doing an antiban task won't break your script.
 
-Returns true if a task was performed.
-
-Example:
-```pascal
-Antiban.DoTask();
-```
-*)
 function TAntiban.DoTask(): Boolean;
 var
   i: Int32;
@@ -394,22 +290,7 @@ begin
     activeTasks[i]^.Countdown.Resume();
 end;
 
-(*
-## Antiban.DoBreak
-```pascal
-function TAntiban.DoBreak(): Boolean;
-```
-Checks for scheduled breaks, if any is due it will take it.
-
-You should only call this when taking a break won't break your script.
-
-Returns true if a break was taken.
 
-Example:
-```pascal
-Antiban.DoBreak();
-```
-*)
 function TAntiban.DoBreak(): Boolean;
 var
   i: Integer;
@@ -427,22 +308,7 @@ begin
     end;
 end;
 
-(*
-## Antiban.DoSleep
-```pascal
-function TAntiban.DoSleep(): Boolean;
-```
-Checks for scheduled sleep breaks, if any is due it will take it.
-
-You should only call this when taking a sleep break won't break your script.
-
-Returns true if a sleep break was taken.
 
-Example:
-```pascal
-Antiban.DoSleep();
-```
-*)
 function TAntiban.DoSleep(): Boolean;
 var
   i: Integer;
@@ -461,27 +327,7 @@ begin
 end;
 
 
-(*
-## Antiban.DoAntiban
-```pascal
-function TAntiban.DoAntiban(checkTasks, checkBreaks, checkSleeps: Boolean = True): Boolean;
-```
-This should be called in your script when antiban sleeps, breaks or tasks won't
-break your script.
-
-When this is called, the setup sleep breaks, breaks and tasks will be checked,
-if enough time has passed to perform any of them
-(subject to the parameters you pass in too), they will be performed, otherwise,
-nothing will happen.
-
-Example:
-```pascal
-Antiban.AddTask(15 * ONE_MINUTE, @Antiban.HoverSkills);
-
-while True do        //Infinite loop
-  Antiban.DoAntiban(); //Antiban.HoverSkills will be called every time 15 minutes passed when this is called.
-```
-*)
+
 function TAntiban.DoAntiban(checkTasks, checkBreaks, checkSleeps: Boolean = True): Boolean;
 begin
   if Self.DoingAntiban then
@@ -512,44 +358,19 @@ begin
 end;
 
 
-(*
-## Antiban.TimeUntilBreak
-```pascal
-function TAntiban.TimeUntilBreak(constref task: TBreakTask; fmt: String = TIME_FORMAL): String;
-```
-Check how much time is left until the specified break `task` should be taken.
-*)
+
 function TAntiban.TimeUntilBreak(constref task: TBreakTask; fmt: String = TIME_FORMAL): String;
 begin
   Result := FormatMilliseconds(Max(0, Round(task.Next - GetTimeRunning())), fmt);
 end;
 
-(*
-## Antiban.TimeUntilSleep
-```pascal
-function TAntiban.TimeUntilSleep(constref task: TSleepTask; fmt: String = TIME_FORMAL): String;
-```
-Check how much time is left until the specified sleep break `task` should be taken.
-*)
+
 function TAntiban.TimeUntilSleep(constref task: TSleepTask; fmt: String = TIME_FORMAL): String;
 begin
   Result := FormatMilliseconds(Max(0, Round(task.Next - GetTimeRunning())), fmt);
 end;
 
-(*
-## Antiban.SimulateBreaks
-```pascal
-procedure TAntiban.SimulateBreaks(bottingDays: UInt64 = 1000);
-```
-Performs a simulation of `bottingDays` amount of days with the currently setup
-breaks and prints the results.
-
-Example
-```pascal
-Antiban.AddBreak(30 * ONE_MINUTE, 5 * ONE_MINUTE);
-Antiban.SimulateBreaks();
-```
-*)
+
 procedure TAntiban.SimulateBreaks(bottingDays: UInt64 = 1000);
 var
   active, inactive, len, prev: Double;
@@ -586,8 +407,5 @@ begin
 end;
 
 var
-(*
-## Antiban variable
-Global {ref}`TAntiban` variable.
-*)
+
   Antiban: TAntiban;