1+ (*
2+ # Friends
3+ Methods to interact with the friends gametab.
4+ ```{figure} ../../images/friends.png
5+ ```
6+ *)
17{$DEFINE WL_FRIENDS_INCLUDED}
28{$INCLUDE_ONCE WaspLib/osrs.simba}
39
410type
511(*
6- ## Friends Button Enum
12+ ## ERSFriendsButton
713```pascal
8- ERSFriendsButton = enum (ADD, DEL, FRIENDS, IGNORE);
14+ ERSFriendsButton = enum(ADD, DEL, FRIENDS, IGNORE);
915```
10-
1116Represents the buttons in the friends tab.
1217*)
13- ERSFriendsButton = enum (ADD, DEL, FRIENDS, IGNORE);
18+ ERSFriendsButton = enum(ADD, DEL, FRIENDS, IGNORE);
1419
1520(*
16- ## Friend Record
17- ```pascal
18- type
19- TRSFriend = record
20- Name: String;
21- World: Integer;
22- Bounds: TBox;
23- end;
24- ```
25-
21+ ## TRSFriend Record
2622Represents a friend/ignore in the friends tab.
2723*)
2824 TRSFriend = record
@@ -33,6 +29,10 @@ Represents a friend/ignore in the friends tab.
3329
3430 TRSFriendArray = array of TRSFriend;
3531
32+ (*
33+ ## TRSFriends Record
34+ Main record responsible with handling the friends gametab.
35+ *)
3636 TRSFriends = record
3737 Scroll: TRSScrollBar;
3838 Buttons: array [ERSFriendsButton] of TRSButton;
@@ -243,7 +243,7 @@ begin
243243 friend := Self.Find(name);
244244 if friend = Default(TRSFriend) then Exit;
245245
246- Mouse.Click(friend.Bounds, EMouseButton.Right );
246+ Mouse.Click(friend.Bounds, EMouseButton.RIGHT );
247247 if not ChooseOption.WaitOpen(2000, 250) then Exit;
248248
249249 Result := ChooseOption.Select('Delete ' + friend.Name);
@@ -342,6 +342,8 @@ begin
342342end;
343343
344344var
345+ (*
346+ ## Friends variable
347+ Global {ref}`TRSFriends` variable.
348+ *)
345349 Friends: TRSFriends;
346-
347-
0 commit comments