feat: core of TAntiban

and a lot of docs

Author: Torwent

osrs/antiban.simba

@@ -34,14 +34,6 @@ Bank enums used to interact with the bank interface.
     Slot: TBox;
   end;
 
-  TRSBankItem = record
-    Item: TRSItem;
-    Quantity: Integer;
-    Noted: Boolean;
-  end;
-
-  TRSBankItemArray = array of TRSBankItem;
-
 (*
 (TRSBank)=
 ## type TRSBank
@@ -127,7 +119,7 @@ procedure Bank.SetupInterface;
 Initializes Bank interface coordinates.
 
 ```{note}
-This is automatically called on the **Bank** variable.
+This is automatically called on the {ref}`Bank` variable.
 ```
 *)
 procedure TRSBank.SetupInterface();
@@ -218,6 +210,19 @@ begin
   end;
 end;
 
+(*
+## Bank.UpdateButtons
+```pascal
+procedure TRSBank.UpdateButtons(offset: Integer);
+```
+Internal helper method used to update the buttons coordinates.
+
+All the bank's bottom buttons shift slightly on the X axis depending on how many dynamic buttons are visible.
+
+```{note}
+This is automatically called for you with {ref}`Bank.IsOpen()`.
+```
+*)
 procedure TRSBank.UpdateButtons(offset: Integer);
 var
   i: Integer;
@@ -591,20 +596,61 @@ begin
 end;
 
 
+(*
+## Bank.HasIncinerator
+```pascal
+function TRSBank.HasIncinerator(): Boolean;
+```
+Returns true if the bank screen has the incenerator visible.
 
+Example:
+```pascal
+if Bank.HasIncenerator() then
+  ShowOnClient(Self.Incenerator);
+```
+*)
 function TRSBank.HasIncinerator(): Boolean;
 begin
   with Self.Incenerator do
     Result := Target.HasColor(ColorTolerance($517F9E, 2.132, EColorSpace.HSV, [2.437, 0.309, 0.256]), 1, [X1, Y1+55, X2, Y2]);
 end;
 
+(*
+## Bank.InceneratorTooltipVisible
+```pascal
+function TRSBank.InceneratorTooltipVisible(): Boolean;
+```
+Returns true if the incenerator tooltip is visible.
+This is important to check when you want to interact with the bottom buttons of
+the bank as the tooltip will cover them.
+
+Example:
+```pascal
+WriteLn Bank.InceneratorTooltipVisible();
+```
+*)
 function TRSBank.InceneratorTooltipVisible(): Boolean;
 begin
   with Self.Incenerator do
     Result := Target.HasColor($A0FFFF, 0, 1, [X1+6, Y1+76, X2, Y2+35]);
 end;
 
-function TRSBank.UnHoverIncinerator(): Boolean;
+(*
+## Bank.CloseInceneratorTooltip
+```pascal
+function TRSBank.CloseInceneratorTooltip(): Boolean;
+```
+Attempts to close the incenerator tooltip.
+This is important to do when you want to interact with the bottom buttons of
+the bank as the tooltip will cover them.
+
+Example:
+```pascal
+if Bank.InceneratorTooltipVisible() then
+  WriteLn Bank.CloseInceneratorTooltip();
+```
+*)
+function TRSBank.CloseInceneratorTooltip(): Boolean;
 var
   boxes: TBoxArray;
 begin
@@ -618,17 +664,42 @@ begin
 end;
 
 
+(*
+## Bank.HasPotionStorage
+```pascal
+function TRSBank.HasPotionStorage(): Boolean;
+```
+Returns True/False if the bank has the potion storage menu available.
+
+Example:
+```pascal
+WriteLn Bank.HasPotionStorage();
+```
+*)
 function TRSBank.HasPotionStorage(): Boolean;
 begin
   Result := Target.HasColor(ColorTolerance($517F9E, 2.132, EColorSpace.HSV, [2.437, 0.309, 0.256]), 1, Self.PotionStorage);
 end;
 
+(*
+## Bank.PotionStorageIsOpen
+```pascal
+function TRSBank.PotionStorageIsOpen(): Boolean;
+```
+Returns True if the potion storage is currently open.
+
+Example:
+```pascal
+WriteLn Bank.PotionStorageIsOpen();
+```
+*)
 function TRSBank.PotionStorageIsOpen(): Boolean;
 begin
   Result := Target.HasColor($1F98FF, 0,  3000, Self.SlotsArea);
 end;
 
 
+{%codetools off}
 (*
 ## Bank._FindTabText
 ```pascal
@@ -643,7 +714,6 @@ if Bank.Search('logs') then
     ShowOnClient(bounds);
 ```
 *)
-{%codetools off}
 function TRSBank._FindTabText(const tpa: TPointArray; out bounds: TBox): Boolean;
 var
   atpa: T2DPointArray;
@@ -854,7 +924,20 @@ begin
 end;
 
 
-function TRSBank.Withdraw(const item: TRSBankItem;const useQuantityButton: Boolean = True; const useCache: Boolean = True): Boolean;
+(*
+## Bank.Withdraw
+```pascal
+function TRSBank.Withdraw(const item: TRSBankItem; const useQuantityButton: Boolean = True; const useCache: Boolean = True): Boolean;
+function TRSBank.Withdraw(const item: TRSItem; const useQuantityButton: Boolean = True; const useCache: Boolean = True): Boolean; overload;
+```
+Attempts to withdraw `item` from the bank.
+
+Example:
+```pascal
+WriteLn Bank.Withdraw(item);
+```
+*)
+function TRSBank.Withdraw(const item: TRSBankItem; const useQuantityButton: Boolean = True; const useCache: Boolean = True): Boolean;
 var
   data: TBankPosition;
 begin
@@ -869,6 +952,41 @@ begin
   Result := Self._InteractionHelper(ERSBankInteraction.WITHDRAW, data.Slot, item.Quantity, useQuantityButton);
 end;
 
+function TRSBank.Withdraw(const item: TRSItem; const useQuantityButton: Boolean = True; const useCache: Boolean = True): Boolean; overload;
+begin
+  Result := Self.Withdraw(item.ToBankItem(), useQuantityButton, useCache);
+end;
+
+(*
+## Bank.Deposit
+```pascal
+function TRSBank.Deposit(const item: TRSBankItem; const useQuantityButton: Boolean = True): Boolean;
+function TRSBank.Deposit(const item: TRSItem; const useQuantityButton: Boolean = True): Boolean; overload;
+```
+Attempts to deposit `item` into the bank.
+
+Example:
+```pascal
+WriteLn Bank.Deposit(item);
+```
+*)
+function TRSBank.Deposit(const item: TRSBankItem; const useQuantityButton: Boolean = True): Boolean;
+var
+  slot: TBox;
+begin
+  if Inventory.Items.Find(item.ToItem(), slot) then
+    Result := Self._InteractionHelper(ERSBankInteraction.DEPOSIT, slot, item.Quantity, useQuantityButton);
+end;
+
+function TRSBank.Deposit(const item: TRSItem; const useQuantityButton: Boolean = True): Boolean; overload;
+var
+  slot: TBox;
+begin
+  if Inventory.Items.Find(item, slot) then
+    Result := Self._InteractionHelper(ERSBankInteraction.DEPOSIT, slot, 1, useQuantityButton);
+end;
+
+
 procedure TRSBank.Draw(img: TImage);
 var
   i: Integer;

osrs/interfaces/mainscreen/bank.simba

@@ -12,35 +12,46 @@ iterations made by Olly.
 
 type
 (*
-## PRSWalker
+(PRSWalker)=
+## type PRSWalker
 TRSWalker pointer.
 *)
   PRSWalker = ^TRSWalker;
 
 (*
-## TRSWalker_OnWalkEvent
+(TRSWalkerEvent)=
+## type TRSWalkerEvent
 Callback object method to use while walking. This can be used to perform custom tasks while walking.
 
 Example:
 ```pascal
-procedure TRSWalker.WalkerTasks(Walker: PRSWalker; Position: TPoint; Destination: TPoint);
+procedure TRSWalker.WalkerTasks(walker: PRSWalker; position, destination: TPoint);
 begin
   Antiban.RandomTab();
 end;
 
-var
-  rsw: TRSWalker;
 begin
-  rsw.Setup('world');
-  rsw.OnWaitMoving := @rsw.WalkerTasks;
+  //this assumes walker is already setup.
+  walker.OnWaitMoving := @walker.WalkerTasks;
 end;
 ```
 *)
-  TRSWalkerEvent            = procedure(walker: PRSWalker; position: TPoint; destination: TPoint) of object;
+  TRSWalkerEvent            = procedure(walker: PRSWalker; position, destination: TPoint) of object;
   TRSWalkerPositionFunction = function (): TPoint of object;
   TRSWalkerHeightFunction   = function (pt: TPoint = [0,0]): Single of object;
   TRWalkerGetLocalFunction  = function (pt: TPoint; offset: TPoint = [0,0]): TPoint of object;
 
+(*
+(TRSWalker)=
+## type TRSWalker
+TRSWalker is the record responsible for walking.
+To work you need to set it up with something that gives it a position function
+as by itself it doesn't really do anything.
+
+Once you have a function that gives you an accurate position, you can pass it to
+into a `TRSWalker` variable or into the {ref}`Walker` one, either directly or
+via the {ref}`Walker.Setup()` method.
+*)
   TRSWalker = record
     Name: String;
 
@@ -108,18 +119,56 @@ function TRSWalker.DummyHeight(pt: TPoint = [0,0]): Single; begin Result := pt.X
 function TRSWalker.DummyGetLocal(pt: TPoint; offset: TPoint = [0,0]): TPoint; begin Result := pt+offset; end;
 {%codetools on}
 
+(*
+## Walker.Setup
+```pascal
+procedure TRSWalker.Setup(position: TRSWalkerPositionFunction; height: TRSWalkerHeightFunction; getLocal: TRWalkerGetLocalFunction; graph: ^TWebGraph; mapImage: TImage);
+```
+Method responsible for setting up the {ref}`TRSWalker` variable.
+All parameters of this function can be `nil` except for `position`.
+Without a `position` callback you cannot use `TRSWalker`.
+
+The following example is purely an example, you never have to do this since
+`Map.Setup` already does this for you anyway.
+
+Example:
+```pascal
+Map.Setup(ERSChunk.CATACOMBS_OF_KOUREND);
+Walker.Setup(@Map.Position, @Map.Height, @Map.Loader.GetLocal, @Map.Loader.Graph, @Map.Loader.Map);
+```
+*)
 procedure TRSWalker.Setup(position: TRSWalkerPositionFunction; height: TRSWalkerHeightFunction; getLocal: TRWalkerGetLocalFunction; graph: ^TWebGraph; mapImage: TImage);
 begin
   Self.Position := @position;
   if @height <> nil then Self.Height := @height else Self.Height := @Self.DummyHeight;
   if @getLocal <> nil then Self.GetLocal := @getLocal else Self.GetLocal := @Self.DummyGetLocal;
-  Self.WebGraph := graph;
+
   Self.WalkUpText := ['Walk here', 'alk her'];
   Self.AdaptiveWalk := True;
+  Self.WebGraph := graph;
   Self.MapImage := mapImage;
 end;
 
 
+(*
+## Walker Conversions
+```pascal
+function TRSWalker.Point2MM(const playerPoint, pt: TPoint; const radians: Double): TPoint;
+function TRSWalker.Point2MMVec(const playerPoint, pt: TPoint; const radians: Double): Vector2;
+function TRSWalker.Points2MM(const playerPoint: TPoint; const tpa: TPointArray; const radians: Double): TPointArray;
+function TRSWalker.GetLocalEx(const tpa: TPointArray; const offset: TPoint = [0,0]): TPointArray;
+function TRSWalker.GetQuadMS(const playerPoint, mapPoint: TPoint; const height: Double = 0; const offset: Vector3 = [0,0,0]; radians: Single = $FFFF): TQuad;
+function TRSWalker.MM2Map(const playerPoint, minimapPoint: TPoint; radians: Single = $FFFF): TPoint;
+```
+Used to convert coordinates from `TRSWalker` to the minimap or the mainscreen.
+
+Example:
+```pascal
+//assuming walker is already setup...
+me := Walker.Position();
+ShowOnClient(Walker.GetQuadMS(me, me + [4,0])); //should show you the tile to your right.
+```
+*)
 function TRSWalker.Point2MM(const playerPoint, pt: TPoint; const radians: Double): TPoint;
 begin
   Result := pt - playerPoint + Minimap.Center;

osrs/walker.simba

@@ -1,3 +1,16 @@
-//compile test
+(*
+# Tests
+Automated tests to ensure the library is working as expected.
+All the test files run whenever there's a commit to the library and only if
+they all pass without crashing a release is created.
+
+There's limitations to what can be tested but anything that doesn't require direct
+interaction with the game can be tested through this process.
+*)
+
+(*
+## Compile Test
+Simple compile test.
+*)
 {$I SRLT/osrs.simba}
 

tests/000.simba

@@ -1,4 +1,7 @@
-//gametabs and inventory tests
+(*
+## Inventory Tests
+Tests the integrety of several inventory methods.
+*)
 {$I SRLT/osrs.simba}
 {$ASSERTIONS ON}
 

tests/001.simba

@@ -7,6 +7,14 @@ type
   TRSItem = String;
   TRSItemArray = array of TRSItem;
 
+  TRSBankItem = record
+    Item: TRSItem;
+    Quantity: Integer;
+    Noted: Boolean;
+  end;
+
+  TRSBankItemArray = array of TRSBankItem;
+
 function TRSItem.HasAmount(): Boolean;
 begin
   Result := Self.EndsWith(')', True);
@@ -37,3 +45,19 @@ begin
   short := Min(0, long - Ceil(long/3));
   Result := Result.CopyRange(0, Random(short, long));
 end;
+
+function TRSItem.ToBankItem(): TRSBankItem;
+begin
+  Result.Quantity := 1;
+  Result.Noted := Self.StartsWith('Noted ', False);
+  if Result.Noted then Result.Item := Self.After('Noted ')
+  else Result.Item := Self;
+end;
+
+function TRSBankItem.ToItem(): TRSItem;
+begin
+  Result := Self.Item;
+  if Self.Noted then
+    Result := 'Noted ' + Result.ToLower();
+end;
+