Skip to content

Commit c22a8ee

Browse files
committed
fix(TRSObject/TRSEntity): will now error if Size.X or Size.Y is less than 0.005
- Tons of docs fixes. Typos, parsing docs issues the compiler was complaining, duplicate labels, images missing, image names with typos, etc
1 parent 03df579 commit c22a8ee

34 files changed

Lines changed: 295 additions & 185 deletions

osrs/antiban/antibanform.simba

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1032,11 +1032,11 @@ Global {ref}`TAntibanFormHelper` variable.
10321032
AntibanForm: TAntibanFormHelper;
10331033

10341034
(*
1035-
## ScriptForm CreateInventoryTab
1035+
## ScriptForm.CreateAntibanTab
10361036
```pascal
1037-
function TScriptForm.CreateInventoryTab(): TLazTabSheet;
1037+
function TScriptForm.CreateAntibanTab(): TLazTabSheet;
10381038
```
1039-
Sets up a `TLazTabSheet` on your `TScriptForm` to configure your `Inventory Layouts`.
1039+
Sets up a `TLazTabSheet` on your `TScriptForm` to configure your {ref}`Antiban`.
10401040

10411041
Example:
10421042
```pascal
@@ -1045,13 +1045,12 @@ var
10451045
form: TScriptForm;
10461046
begin
10471047
form.Setup();
1048-
form.CreateInventoryTab();
1048+
form.CreateAntibanTab();
10491049
form.Run();
10501050
end.
10511051
```
1052-
```{figure} ../../images/inventoryform.gif
1052+
```{figure} ../../images/antibanform.gif
10531053
```
1054-
For a more complete example check out the file `Simba/Includes/WaspLib/examples/inventory_form.simba`.
10551054
*)
10561055
function TScriptForm.CreateAntibanTab(): TLazTabSheet;
10571056
var

osrs/finders/overheadfinder.simba

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
(*
2-
## OverheadFinder
2+
# OverheadFinder
33

44
Prayer/Protection Overhead Detection System.
55

osrs/interfaces/chat/chatoptions.simba

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -301,15 +301,15 @@ begin
301301
end;
302302

303303
(*
304-
## Chat.IsTitle
304+
## Chat.WaitTitle
305305
```pascal
306-
function TRSChat.IsTitle(text: String; similarity: Single = 0.8): Boolean;
306+
function TRSChat.WaitTitle(text: String; time: Integer = 600; similarity: Single = 0.8; interval: Integer = -1): Boolean;
307307
```
308308
Returns True/False if the current chat title matches `text`.
309309

310310
Example:
311311
```pascal
312-
WriteLn Chat.IsTitle('Select an option');
312+
WriteLn Chat.WaitTitle('Select an option');
313313
```
314314
*)
315315
function TRSChat.WaitTitle(text: String; time: Integer = 600; similarity: Single = 0.8; interval: Integer = -1): Boolean;

osrs/interfaces/gametabs/combat.simba

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ end;
236236

237237

238238
(*
239-
## Combat.StyleBoxes
239+
## Combat.WeaponStyle
240240
```pascal
241241
property TRSCombat.WeaponStyle: EWeaponStyle;
242242
property TRSCombat.WeaponStyle(value: EWeaponStyle): Boolean;
@@ -299,7 +299,7 @@ end;
299299

300300

301301
(*
302-
## Combat.StyleBoxes
302+
## Combat.MeleeStyle
303303
```pascal
304304
property TRSCombat.MeleeStyle: EMeleeStyle;
305305
property TRSCombat.MeleeStyle(value: EMeleeStyle): Boolean;

osrs/interfaces/handlers/inventory_form.simba

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@ Global {ref}`TInventoryFormHelper` variable.
490490
InventoryForm: TInventoryFormHelper;
491491

492492
(*
493-
## ScriptForm CreateInventoryTab
493+
## ScriptForm.CreateInventoryTab
494494
```pascal
495495
function TScriptForm.CreateInventoryTab(): TLazTabSheet;
496496
```

osrs/interfaces/handlers/prayer_form.simba

Lines changed: 28 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -163,16 +163,38 @@ end;
163163
{$H+}
164164

165165
(*
166-
## TRSPrayerForm Selected
166+
## TRSPrayerForm.Selected
167167
```pascal
168168
property TRSPrayerForm.Selected(prayers: TRSPrayerSet);
169+
property TRSPrayerForm.Selected: TRSPrayerSet;
169170
```
170-
Set's the defined prayers as the set of selected prayers.
171-
Useful for saving user settings between sessions. Selected prayers from a previous
172-
session could be saved and then reset on the next session by setting them
173-
with the procedure upon building the form.
171+
Get/Set the defined prayers as a set of selected prayers.
174172

175-
Example:
173+
Useful for saving user settings between sessions.
174+
175+
Selected prayers from a previous session could be saved and then reset on the
176+
next session by setting them with the procedure upon building the form.
177+
178+
Getting example:
179+
```pascal
180+
{$I WaspLib/osrs.simba}
181+
182+
var
183+
form: TScriptForm;
184+
tab: TTabSheet;
185+
prayerForm: TRSPrayerForm;
186+
187+
begin
188+
form.Setup('Script settings');
189+
tab := TLazTabSheet.Create(form.PageControl);
190+
prayerForm.Setup(tab, 50, 50);
191+
prayerForm.SetAllowedPrayers([ERSPrayer.EAGLE_EYE, ERSPrayer.RIGOUR]);
192+
form.Run();
193+
WriteLn(prayerForm.Selected);
194+
end.
195+
```
196+
197+
Setting example:
176198
```pascal
177199
{$I WaspLib/osrs.simba}
178200

@@ -206,32 +228,6 @@ begin
206228
Self._Select(prayer);
207229
end;
208230

209-
(*
210-
## TRSPrayerForm Selected
211-
```pascal
212-
property TRSPrayerForm.Selected(prayers: TRSPrayerSet);
213-
```
214-
Get's the currently selected prayers.
215-
216-
Example:
217-
```pascal
218-
{$I WaspLib/osrs.simba}
219-
220-
var
221-
form: TScriptForm;
222-
tab: TTabSheet;
223-
prayerForm: TRSPrayerForm;
224-
225-
begin
226-
form.Setup('Script settings');
227-
tab := TLazTabSheet.Create(form.PageControl);
228-
prayerForm.Setup(tab, 50, 50);
229-
prayerForm.SetAllowedPrayers([ERSPrayer.EAGLE_EYE, ERSPrayer.RIGOUR]);
230-
form.Run();
231-
WriteLn(prayerForm.Selected);
232-
end.
233-
```
234-
*)
235231
property TRSPrayerForm.Selected: TRSPrayerSet;
236232
begin
237233
Result := Self.SelectedPrayers;

osrs/interfaces/mainscreen/anvil.simba

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ function TRSAnvil.WaitOpen(time: Integer; interval: Integer = -1): Boolean;
137137
```
138138
Returns true if the {ref}`Anvil` is open within `time` milliseconds.
139139

140-
## Example:
140+
Example:
141141
```pascal
142142
WriteLn Anvil.WaitOpen();
143143
```
@@ -159,7 +159,7 @@ This is probably more complex than most people would think it is because buttons
159159
are not always visible depending on the amount of metal bars your have in your
160160
{ref}`Inventory`.
161161

162-
## Example:
162+
Example:
163163
```pascal
164164
WriteLn Anvil.SetQuantity(QUANTITY_ALL);
165165
```
@@ -216,7 +216,7 @@ function TRSAnvil.CanSmith(item: TRSItem): Boolean;
216216
```
217217
Checks if the specified `item` is currently available to smith.
218218

219-
## Example:
219+
Example:
220220
```pascal
221221
WriteLn Anvil.CanSmith('Rune 2h sword');
222222
```
@@ -239,7 +239,7 @@ function TRSAnvil.Smith(item: TRSItem; quantity: Integer = QUANTITY_ALL; keyboar
239239
```
240240
Attempts to smith the specified `item` with the specified `quantity`.
241241

242-
## Example:
242+
Example:
243243
```pascal
244244
WriteLn Anvil.Smith('Rune 2h sword');
245245
```

osrs/interfaces/mainscreen/bank.simba

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1584,7 +1584,7 @@ begin
15841584
end;
15851585

15861586
(*
1587-
## Bank.LockSlot
1587+
## Bank.UnlockSlot
15881588
```pascal
15891589
function TRSBank.UnlockSlot(slot: Integer): Boolean;
15901590
```

osrs/interfaces/mainscreen/depositbox.simba

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ function TRSDepositBox.WaitOpen(time: Integer; interval: Integer = -1): Boolean;
148148
```
149149
Returns true if the {ref}`DepositBox` is open within `time` milliseconds.
150150

151-
## Example:
151+
Example:
152152
```pascal
153153
WriteLn DepositBox.WaitOpen();
154154
```

osrs/interfaces/mainscreen/fairyring.simba

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ function TRSFairyRing.WaitOpen(time: Integer; interval: Integer = -1): Boolean;
122122
```
123123
Returns true if the fairy ring interface is open within `time` milliseconds.
124124

125-
## Example:
125+
Example:
126126
```pascal
127127
WriteLn FairyRing.WaitOpen();
128128
```

0 commit comments

Comments
 (0)