Friend

Table of Contents

Methods

AddFriendTarget

Syntax: Friend.AddFriendTarget()
Returns: Void

AddPlayer

Syntax: Friend.AddPlayer(friendlist, name, serial)

Add the player specified to the Friend list named in FriendListName parameter

Parameters:
  • friendlist (String): Name of the the Friend List. (See Agent tab)
  • name (String): Name of the Friend want to add.
  • serial (Int32): Serial of the Friend you want to add.
Returns: Void

ChangeList

Syntax: Friend.ChangeList(friendlist)

Change friend list, List must be exist in friend list GUI configuration

Parameters:
  • friendlist (String): Name of the list of friend.
Returns: Void

GetList

Syntax: Friend.GetList(friendlist)

Retrieve list of serial in list, List must be exist in friend Agent tab.

Parameters:
  • friendlist (String): Name of the list of friend.
Returns: List[Int32]

GuildExists

Syntax: Friend.GuildExists(list, guild)

Check if a guild exists in a Friend list.

Parameters:
  • list (String)
  • guild (String)
Returns: Boolean

GuildInsert

Syntax: Friend.GuildInsert(list, guild)

Insert a guild into a Friend list.

Parameters:
  • list (String)
  • guild (Friend.FriendGuild)
Returns: Void

GuildRead

Syntax: Friend.GuildRead(list, guilds)
Parameters:
  • list (String)
  • guilds (List`1&@)
Returns: Void

GuildReplace

Syntax: Friend.GuildReplace(listName, index, newGuild)

Replace a guild in a Friend list.

Parameters:
  • listName (String)
  • index (Int32)
  • newGuild (Friend.FriendGuild)
Returns: Void

GuildsRead

Syntax: Friend.GuildsRead(list, guilds)
Parameters:
  • list (String)
  • guilds (List`1&@)
Returns: Void

IsFriend

Syntax: Friend.IsFriend(serial)

Check if Player is in FriendList, returns a bool value.

Parameters:
  • serial (Int32): Serial you want to check
Returns: Boolean

ListDelete

Syntax: Friend.ListDelete(description)

Delete a Friend list from persistence.

Parameters:
  • description (String)
Returns: Void

ListExists

Syntax: Friend.ListExists(description)

Check if a Friend list exists by name.

Parameters:
  • description (String)
Returns: Boolean

ListInsert

Syntax: Friend.ListInsert(description, includeparty, preventattack, autoacceptparty, slfriend, tbfriend, comfriend, minfriend)

Insert a new Friend list into persistence (overload). Insert a new Friend list into persistence.

Parameters:
  • description (String)
  • includeparty (Boolean)
  • preventattack (Boolean)
  • autoacceptparty (Boolean)
  • slfriend (Boolean)
  • tbfriend (Boolean)
  • comfriend (Boolean)
  • minfriend (Boolean)
Returns: Void

ListsRead

Syntax: Friend.ListsRead()

Read all Friend lists from persistence.

Returns: List[Friend.FriendList]

PlayerDelete

Syntax: Friend.PlayerDelete(list, player)

Delete a player from a Friend list. Delete a player from a Friend list by serial.

Parameters:
  • list (String)
  • player (Friend.FriendPlayer)
Returns: Void

PlayerExists

Syntax: Friend.PlayerExists(list, player)

Check if a player exists in a Friend list. Check if a player serial exists in a Friend list.

Parameters:
  • list (String)
  • player (Friend.FriendPlayer)
Returns: Boolean

PlayerInsert

Syntax: Friend.PlayerInsert(list, player)

Insert a player into a Friend list.

Parameters:
  • list (String)
  • player (Friend.FriendPlayer)
Returns: Void

PlayerReplace

Syntax: Friend.PlayerReplace(listName, index, newPlayer)

Replace a player in a Friend list.

Parameters:
  • listName (String)
  • index (Int32)
  • newPlayer (Friend.FriendPlayer)
Returns: Void

PlayersRead

Syntax: Friend.PlayersRead(list, players)
Parameters:
  • list (String)
  • players (List`1&@)
Returns: Void

RemoveFriend

Syntax: Friend.RemoveFriend(friendlist, serial)

Remove the player specified from the Friend list named in FriendListName parameter

Parameters:
  • friendlist (String): Name of the the Friend List. (See Agent tab)
  • serial (Int32): Serial of the Friend you want to remove.
Returns: Boolean