Merge branch 'pr/146'

Author: Torwent

osrs/interfaces/mainscreen/shop.simba

@@ -3,6 +3,9 @@
 Methods to interact with the shop interface.
 ```{figure} ../../images/shop_interface.png
 ```
+```{note}
+Credits to GodTierKappa a.k.a. jacz24
+```
 *)
 
 {$DEFINE WL_SHOP_INCLUDED}
@@ -118,7 +121,6 @@ begin
 
   Self.SlotBoxes := TBoxArray.Create(Self.Bounds.TopLeft.Offset(61, 40), 8, 5, 35, 32, [12,15]);
   Self.SlotsArea := Self.SlotBoxes.Merge();
-  //Self.SlotBoxes := TBoxArray.Create(Self.SlotsArea.TopLeft, 4, 2, 47, 47, [4, 4]);
   Self.Slots.Setup('Shop.Slots', Self.SlotBoxes, @Self.FindItemBoundaries);
   Self.Items.Setup('Shop.Items', @Self.Slots, [0, 1], @Self.IsOpen);
 
@@ -129,7 +131,6 @@ begin
 
   with Self.Bounds do
     boxes := TBoxArray.Create([X2-196, Y2-37], 4, 1, 29, 29, [11,0]); // This is the whole button
-    //boxes := TBoxArray.Create([X2-192, Y2-33], 4, 1, 21, 21, [19,0]); // This is just for the inside of the button;
 
   for quantity := Low(ERSShopQuantity) to High(ERSShopQuantity) do
     begin

osrs/interfaces/mainscreen/silverscreen.simba

@@ -88,6 +88,16 @@ begin
   Result := Self.Buttons[b];
 end;
 
+function TRSSilverScreen.IsOpen(): Boolean; forward;
+
+(*
+## SilverScreen.SetupInterface
+```pascal
+procedure TRSSilverScreen.SetupInterface();
+```
+Internal method used to setup the {ref}`TRSSilverScreen` coordinates.
+This is automatically called for you on the {ref}`SilverScreen variable`.
+*)
 procedure TRSSilverScreen.SetupInterface();
 var
   leftSlots, rightSlots : TBoxArray;
@@ -132,7 +142,7 @@ begin
   Self.SlotBoxes := leftSlots + rightSlots;
 
   Self.Slots.Setup('SilverScreen.Slots', Self.SlotBoxes);
-  Self.Items.Setup('SilverScreen.Items', @Self.Slots, [0,10]);
+  Self.Items.Setup('SilverScreen.Items', @Self.Slots, [0,10], @Self.IsOpen);
 
   btns := Self.GetButtons();
   if Length(btns) = Length(ERSItemQuantity) then
@@ -142,6 +152,18 @@ end;
 
 {―― public API ―――――――――――――――――――――――――――――――――――――――――――――――}
 
+(*
+## SilverScreen.IsOpen
+```pascal
+function TRSSilverScreen.IsOpen(): Boolean;
+```
+Returns true if the SilverScreen interface is open.
+
+Example:
+```pascal
+WriteLn SilverScreen.IsOpen();
+```
+*)
 function TRSSilverScreen.IsOpen(): Boolean;
 begin
   try
@@ -151,13 +173,38 @@ begin
   end;
 end;
 
+(*
+## SilverScreen.WaitOpen
+```pascal
+function TRSSilverScreen.WaitOpen(time, interval: Int32): Boolean;
+```
+Returns true if the SilverScreen interface opens within `time` milliseconds.
+
+Example:
+```pascal
+WriteLn SilverScreen.WaitOpen(5000);
+```
+*)
 function TRSSilverScreen.WaitOpen(time, interval : Int32) : Boolean;
 begin
   if interval < 0 then
     interval := RandomMode(100,50,1500);
   Result := SleepUntil(Self.IsOpen, interval, time);
 end;
 
+(*
+## SilverScreen.Close
+```pascal
+function TRSSilverScreen.Close(PressEscape: Boolean): Boolean;
+```
+Attempts to close the {ref}`SilverScreen` interface. If `PressEscape` is true, the escape key is
+pressed to close, otherwise the close button is clicked.
+
+Example:
+```pascal
+WriteLn SilverScreen.Close(True);
+```
+*)
 function TRSSilverScreen.Close(PressEscape : Boolean) : Boolean;
 begin
   if not Self.IsOpen then
@@ -173,6 +220,21 @@ begin
                          Random(1500,2000));
 end;
 
+(*
+## SilverScreen.SetQuantity
+```pascal
+function TRSSilverScreen.SetQuantity(Amount: Int32): Boolean;
+```
+Sets the quantity to craft. Pass -1 for "All". If a preset button (1, 5, 10, All)
+matches the amount, it will be clicked. Otherwise, the "X" button is used to
+enter a custom amount.
+
+Example:
+```pascal
+SilverScreen.SetQuantity(10);
+SilverScreen.SetQuantity(-1); // All
+```
+*)
 function TRSSilverScreen.SetQuantity(Amount: Int32): Boolean;
 const
   ENABLED_COLOR  = $FFFFFF;   // white (active button)
@@ -208,6 +270,21 @@ begin
     end;
 end;
 
+(*
+## SilverScreen.CanCraftItem
+```pascal
+function TRSSilverScreen.CanCraftItem(Item: TRSItem; out Box: TBox): Boolean;
+```
+Checks if the specified item can be crafted. Returns true if the item is found
+and craftable, and outputs the click box for the item.
+
+Example:
+```pascal
+var box: TBox;
+if SilverScreen.CanCraftItem('Opal ring', box) then
+  WriteLn 'Can craft opal ring';
+```
+*)
 function TRSSilverScreen.CanCraftItem(Item : TRSItem; out Box : TBox) : Boolean;
 const
   READY_GOLD  = $1F98FF;  // gold text (craftable)
@@ -227,6 +304,21 @@ begin
   Result := TPA.Length > 0;
 end;
 
+
+(*
+## SilverScreen.IsItemHighlighted
+```pascal
+function TRSSilverScreen.IsItemHighlighted(Item: TRSItem): Boolean;
+```
+Returns true if the specified item is currently highlighted/selected in the interface.
+You probably won't need to work with this directly
+
+Example:
+```pascal
+if SilverScreen.IsItemHighlighted('Opal ring') then
+  Keyboard.KeyPress(EKeyCode.SPACE);
+```
+*)
 function TRSSilverScreen.IsItemHighlighted(Item : TRSItem) : Boolean;
 var
   highlight : TColor := 4807018;
@@ -239,6 +331,19 @@ begin
   Result := TPA.Length > 0;
 end;
 
+(*
+## SilverScreen.CraftItem
+```pascal
+function TRSSilverScreen.CraftItem(Item: TRSItem; Quantity: Int32; UseSpaceBar: Boolean): Boolean;
+```
+Crafts the specified item with the given quantity. If `UseSpaceBar` is true and the
+item is already highlighted, spacebar will be pressed instead of clicking.
+
+Example:
+```pascal
+SilverScreen.CraftItem('Opal ring', 10, True);
+```
+*)
 function TRSSilverScreen.CraftItem(Item : TRSItem; Quantity : Int32;
                                    UseSpaceBar : Boolean) : Boolean;
 var
@@ -259,5 +364,9 @@ begin
     Mouse.Click(box, EMouseButton.LEFT);
 end;
 
+(*
+## SilverScreen variable
+Global {ref}`TRSSilverScreen` variable.
+*)
 var
   SilverScreen: TRSSilverScreen;