friends_func
Table of Contents
Scripting - Friend control function
Here can find some information about Enhanced Scripting function to control friend list by script!
AddFriend
| Add a Player to a friend list | |
| Syntax | Friend.AddPlayer(string FriendListName, string PlayerName, int PlayerSerial) |
| Description: | |
| Add the player specified to the Friend list named in FriendListName parameter | |
| Returns | void |
| In Object: | Friend |
| Parameters: | FriendListName, PlayerName, PlayerSerial |
RemoveFriend
| Remove a serial from a friend list | |
| Syntax | Friend.RemoveFriend(string FriendListName, int Serial) |
| Description: | |
| Remove the friend specified from the Friend list named in FriendListName parameter | |
| Returns | bool - True success, False fail to remove |
| In Object: | Friend |
| Parameters: | FriendListName, Serial |
Check Friend
| Check if Player is in FriendList | |
| Syntax | Friend.IsFriend(int) |
| Description: | |
| Get a bool value if serial is in friend list or not, also if partyinclude option is active on GUI search in party also. | |
| Returns | bool |
| In Object: | Friend |
| Parameters: | SerialToSearch |
Change List
| Change Friend list | |
| Syntax | Friend.ChangeList(string) |
| Description: | |
| Change friend list, List must be exist in friend list GUI configuration | |
| Returns | void |
| In Object: | Friend |
| Parameters: | ListName |
Read Data
| Get friend list | |
| Syntax | Friend.GetList(string) |
| Description: | |
| Retrive list of serial in list, List must be exist in friend list GUI configuration. | |
| Returns | list (int) |
| In Object: | Friend |
| Parameters: | FriendListName |
friends_func.txt · Last modified: 2022/09/24 20:52 by credzba