more work on TRSMake

added more docs

Author: Torwent

osrs.simba

@@ -49,6 +49,7 @@ They should be self-explanatory.
 {$IFNDEF SRLT_GAMETAB_INCLUDED}             {$INCLUDE_ONCE osrs/interfaces/gametabs/gametab.simba}
 {$IFNDEF SRLT_CHAT_TABS_INCLUDED}           {$INCLUDE_ONCE osrs/interfaces/chat/chattabs.simba}
 {$IFNDEF SRLT_CHAT_INCLUDED}                {$INCLUDE_ONCE osrs/interfaces/chat/chat.simba}
+{$IFNDEF SRLT_MAKE_INCLUDED}                {$INCLUDE_ONCE osrs/interfaces/chat/make.simba}
 {$IFNDEF SRLT_MAINSCREEN_INCLUDED}          {$INCLUDE_ONCE osrs/interfaces/mainscreen/mainscreen.simba}
 {$IFNDEF SRLT_INTERFACE_AREA_INCLUDED}      {$INCLUDE_ONCE osrs/interfaces/interfacearea.simba}
 
@@ -131,3 +132,4 @@ They should be self-explanatory.
 {$ENDIF}
 {$ENDIF}
 {$ENDIF}
+{$ENDIF}

osrs/interfaces/chat/make.simba

@@ -15,7 +15,90 @@ type
 
   TRSMake = record
     Items: array of TRSMakeItem;
+    QuantityButtons: TBoxArray;
+    {%codetools on}
+    _IsOpenHelper, _QuantityHelper, _ItemsHelper: TBox;
+    {%codetools on}
     const QUANTITY_ALL: Integer = 0;
+    const TEXT_COLOR: TColor = $203040;
   end;
 
+(*
+## Make.SetupInterface
+```pascal
+procedure TRSMake.SetupInterface();
+```
+Internal method used to setup the {ref}`TRSMake` coordinates.
+
+This is automatically called for you on the {ref}`Make variable`.
+*)
+procedure TRSMake.SetupInterface();
+begin
+  with Chat.Bounds do
+  begin
+    Self._IsOpenHelper.X1 := X1 + 40;
+    Self._IsOpenHelper.Y1 := Y1 + 12;
+    Self._IsOpenHelper.X2 := X1 + 300;
+    Self._IsOpenHelper.Y2 := Y1 + 34;
+  end;
+
+  with Chat.Bounds do
+  begin
+    Self._QuantityHelper.X1 := X2 - 193;
+    Self._QuantityHelper.Y1 := Y1 + 15;
+    Self._QuantityHelper.X2 := X2 - 19;
+    Self._QuantityHelper.Y2 := Y1 + 44;
+  end;
+
+  with Chat.Bounds do
+  begin
+    Self._ItemsHelper.X1 := X1 + 8;
+    Self._ItemsHelper.Y1 := Y1 + 51;
+    Self._ItemsHelper.X2 := X2 - 8;
+    Self._ItemsHelper.Y2 := Y2 - 19;
+  end;
+end;
+
+(*
+## Make.IsOpen
+```pascal
+function TRSMake.IsOpen(): Boolean;
+```
+Returns True/False if the {ref}`Make` if open.
 
+Example:
+```pascal
+WriteLn Make.IsOpen();
+```
+*)
+function TRSMake.IsOpen(): Boolean;
+begin
+  Result := Target.HasColor(Self.TEXT_COLOR, 0, 500, Self._IsOpenHelper);
+end;
+
+(*
+## Make.WaitOpen
+```pascal
+function TRSMake.WaitOpen(time: Integer = 600; interval: Integer = -1): Boolean;
+```
+Returns True if the {ref}`Make` opens within `time` milliseconds.
+
+Example:
+```pascal
+WriteLn Make.WaitOpen();
+```
+*)
+function TRSMake.WaitOpen(time: Integer = 600; interval: Integer = -1): Boolean;
+begin
+  if interval < 0 then interval := RandomMode(100, 50, 1500);
+  Result := SleepUntil(Self.IsOpen(), interval, time);
+end;
+
+
+var
+(*
+(Make variable)=
+## var Make
+Global {ref}`TRSMake` variable.
+*)
+  Make: TRSMake;

osrs/interfaces/gametabs/equipment.simba

@@ -34,14 +34,23 @@ Enumerator of the equipment buttons.
 (*
 (TRSEquipment)=
 ## type TRSEquipment
-Main equipment type reponsible for handling it.
+Main record reponsible for handling the equipment gametab.
 *)
   TRSEquipment = record
     Slots: TRSSlotInterface;
     Items: TRSItemInterface;
     Buttons: array [ERSEquipmentButton] of TRSButton;
   end;
 
+(*
+## Equipment.SetupInterface
+```pascal
+procedure TRSEquipment.SetupInterface();
+```
+Internal method used to setup the {ref}`TRSEquipment` coordinates.
+
+This is automatically called for you on the {ref}`Equipment variable`.
+*)
 procedure TRSEquipment.SetupInterface();
 var
   slots, btns: TBoxArray;
@@ -101,4 +110,9 @@ begin
 end;
 
 var
+(*
+(Equipment variable)=
+## var Equipment
+Global {ref}`TRSEquipment` variable.
+*)
   Equipment: TRSEquipment;

osrs/interfaces/gametabs/gametab.simba

@@ -1,13 +1,31 @@
 (*
 # GameTab
-Gametabs interfaces core
+Gametabs interfaces core.
+Whenever you want to use gametab coordinates that are not unique to a specific
+tab you should use this.
+
+Check {ref}`TRSInterface` to see what coordinates it has available.
 *)
 {$DEFINE SRLT_GAMETAB_INCLUDED}
 {$INCLUDE_ONCE SRLT/osrs.simba}
 
 type
+(*
+(TRSGameTab)=
+## type TRSGameTab
+GameTab type that holds the core coordinates of a gametab.
+*)
   TRSGameTab = type TRSInterface;
 
+(*
+## GameTab.SetupInterface
+```pascal
+procedure TRSGameTab.SetupInterface();
+```
+Internal method used to setup the {ref}`TRSGameTab` coordinates.
+
+This is automatically called for you on the {ref}`GameTab variable`.
+*)
 procedure TRSGameTab.SetupInterface();
 begin
   case RSClient.Mode of
@@ -49,4 +67,9 @@ begin
 end;
 
 var
+(*
+(GameTab variable)=
+## var GameTab
+Global {ref}`TRSGameTab` variable.
+*)
   GameTab: TRSGameTab;

osrs/interfaces/gametabs/inventory.simba

@@ -13,6 +13,15 @@ type
     ShiftEnabled: Boolean;
   end;
 
+(*
+## Inventory.SetupInterface
+```pascal
+procedure TRSInventory.SetupInterface();
+```
+Internal method used to setup the {ref}`TRSInventory` coordinates.
+
+This is automatically called for you on the {ref}`Inventory variable`.
+*)
 procedure TRSInventory.SetupInterface();
 begin
   Self.Slots.Setup('Inventory.Slots', TBoxArray.Create(GameTab.TopLeft.Offset(13,9), 4, 7, 31, 31, [11, 5]));
@@ -377,8 +386,8 @@ end;
 
 var
 (*
-(Inventory)=
+(Inventory variable)=
 ## var Inventory
-Global TRSInventory variable.
+Global {ref}`TRSInventory` variable.
 *)
   Inventory: TRSInventory;

osrs/interfaces/gametabs/magic.simba

@@ -75,6 +75,11 @@ const
   ]);
 
 type
+(*
+(TRSMagic)=
+## type TRSMagic
+Main record reponsible for handling the magic gametab.
+*)
   TRSMagic = record
     SpellCache: array [ERSSpell] of record
       Box: TBox;
@@ -591,9 +596,10 @@ begin
   Result += 1;
 end;
 
+var
 (*
+(Magic variable)=
 ## var Magic
-Global Magic variable.
+Global {ref}`TRSMagic` variable.
 *)
-var
   Magic: TRSMagic;

osrs/interfaces/mainscreen/bank.simba

@@ -114,13 +114,10 @@ end;
 (*
 ## Bank.SetupInterface
 ```pascal
-procedure Bank.SetupInterface;
-```
-Initializes Bank interface coordinates.
-
-```{note}
-This is automatically called on the {ref}`Bank` variable.
+procedure TRSBank.SetupInterface();
 ```
+Internal method used to setup the {ref}`TRSBank` coordinates.
+This is automatically called for you on the {ref}`Bank variable`.
 *)
 procedure TRSBank.SetupInterface();
 var
@@ -1071,4 +1068,9 @@ end;
 
 
 var
+(*
+(Bank variable)=
+## var Bank
+Global {ref}`TRSBank` variable.
+*)
   Bank: TRSBank;

osrs/interfaces/setup.simba

@@ -17,6 +17,7 @@ begin
   Logout.SetupInterface();
   MM2MS.Setup();
   Chat.SetupInterface();
+  Make.SetupInterface();
   InterfaceArea.SetupInterface();
   RSInterface.SetupInterface();
   XPBar.SetupInterface();