C_FriendList

namespaceavailable in: camelot

Status in wowlua

32 functions: 12 implemented, 1 recorded, 19 guessed. 27 events, 2 of them fired by the emulator on its own.

Functions

function	what it does	status
`AddFriend`	Adds a friend to your friend list. `(name: string, notes: string?)`	guessed
`AddIgnore`	Adds a player to your ignore list. `(name: string): boolean`	implemented
`AddOrDelIgnore`	Adds or removes a player to/from the ignore list. `(name: string)`	implemented
`AddOrRemoveFriend`	Adds or removes a player to or from the friends list. `(name: string, notes: string)`	guessed
`DelIgnore`	Removes a player from your ignore list. `(name: string): boolean`	implemented
`DelIgnoreByIndex`	Removes a player from your ignore list. `(index: number)`	implemented
`GetFriendInfo`	Retrieves information about a person on your friends list. `(name: string): FriendInfo?`	guessed
`GetFriendInfoByIndex`	Retrieves information about a person on your friends list. `(index: number): FriendInfo?`	guessed
`GetIgnoreName`	Returns the name of a currently ignored player. `(index: number): string?`	implemented
`GetNumFriends`	Returns how many friends you have. `(): number`	guessed
`GetNumIgnores`	Returns the number of entries on your ignore list. `(): number`	implemented
`GetNumOnlineFriends`	Returns the number of online friends. `(): number`	implemented
`GetNumWhoResults`	Get the number of entries resulting from your most recent /who query. `(): (number, number)`	implemented
`GetSelectedFriend`	Returns the index of the currently selected friend. `(): number?`	guessed
`GetSelectedIgnore`	Returns the currently selected index in the ignore listing. `(): number?`	guessed
`GetWhoInfo`	Retrieves info about a character on your current /who list. `(index: number): WhoInfo?`	implemented
`GetWhoRaceFilters`	Returns the races the Who list can be filtered by: the races of the player's faction. · by wowlua `(): WhoFilter[]`	guessed
`IsFriend`	Returns whether a character is your friend. `(guid: string): boolean`	guessed
`IsIgnored`	Returns whether a character is being ignored by you. `(token: string): boolean`	implemented
`IsIgnoredByGuid`	Returns whether a character is being ignored by you. `(guid: string): boolean`	guessed
`IsLegacyFriendSystemEnabled`	Whether the legacy friend system is in use. · by wowlua `(): boolean`	recorded
`IsOnIgnoredList`	Whether the player is on the ignore list. · by wowlua `(token: string): boolean`	implemented
`RemoveFriend`	Removes a friend from the friends list. `(name: string): boolean`	guessed
`RemoveFriendByIndex`	Removes a friend from the friends list. `(index: number)`	guessed
`SendWho`	Requests a list of other online players. `(filter: string, origin: number?, filters: SendWhoFilters?)`	implemented
`SetFriendNotes`	Sets the note text for a friend. `(name: string, notes: string): boolean`	guessed
`SetFriendNotesByIndex`	Sets the note text for a friend. `(index: number, notes: string)`	guessed
`SetSelectedFriend`	Updates the current selected friend. `(index: number)`	guessed
`SetSelectedIgnore`	Sets the currently selected ignore entry. `(index: number)`	guessed
`SetWhoToUi`	Sets how the result of a /who request will be delivered. `(whoToUi: boolean)`	guessed
`ShowFriends`	Requests updated friends information from server. `()`	guessed
`SortWho`	Sorts the last /who reply received by the client. `(sorting: string, ascending: boolean?)`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`BATTLE_NET_FRIEND_TAG_ENABLED_STATUS_UPDATED`	`no payload`	not implemented
`BATTLE_NET_TITLE_FRIEND_CUSTOM_NAME_ENABLED_STATUS_UPDATED`	`no payload`	not implemented
`BN_BLOCK_FAILED_TOO_MANY`	`blockType: string`	not implemented
`BN_BLOCK_LIST_UPDATED`	`no payload`	not implemented
`BN_CHAT_WHISPER_UNDELIVERABLE`	`senderID: number`	not implemented
`BN_CONNECTED`	`suppressNotification: boolean`	not implemented
`BN_CUSTOM_MESSAGE_CHANGED`	`id: number?`	not implemented
`BN_CUSTOM_MESSAGE_LOADED`	`no payload`	not implemented
`BN_DISCONNECTED`	`result: boolean, suppressNotification: boolean`	not implemented
`BN_FRIEND_ACCOUNT_OFFLINE`	`friendId: number, isCompanionApp: boolean`	not implemented
`BN_FRIEND_ACCOUNT_ONLINE`	`friendId: number, isCompanionApp: boolean`	not implemented
`BN_FRIEND_INFO_CHANGED`	`friendIndex: number?`	not implemented
`BN_FRIEND_INVITE_ADDED`	`accountID: number`	not implemented
`BN_FRIEND_INVITE_LIST_INITIALIZED`	`listSize: number`	not implemented
`BN_FRIEND_INVITE_REMOVED`	`no payload`	not implemented
`BN_FRIEND_LIST_SIZE_CHANGED`	`accountID: number?`	not implemented
`BN_INFO_CHANGED`	`no payload`	not implemented
`BN_REQUEST_FOF_SUCCEEDED`	`no payload`	not implemented
`CONFIRM_BATTLE_NET_FRIEND_INVITE_SHOW`	`name: string, friendLevel: BattleNetFriendLevel`	not implemented
`FRIENDLIST_UPDATE`	`no payload`	not implemented
`IGNORELIST_UPDATE`	`no payload`	implemented
`LEGACY_FRIEND_SYSTEM_STATUS_UPDATED`	`no payload`	not implemented
`MUTELIST_UPDATE`	`no payload`	not implemented
`NEW_MATCHMAKING_PARTY_INVITE`	`no payload`	not implemented
`REJECTED_MATCHMAKING_PARTY_INVITE`	`name: string`	not implemented
`SOCIAL_UI_FRIENDS_LIST_SYSTEM_STATUS_UPDATED`	`no payload`	not implemented
`WHO_LIST_UPDATE`	`no payload`	implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("BATTLE_NET_FRIEND_TAG_ENABLED_STATUS_UPDATED").

Structures

FriendInfo · connected, name, className?, area?, notes?, guid, level, dnd, afk, rafLinkType
SendWhoFilters · classIDs, raceIDs, uiMapIDs
WhoFilter · name, ID
WhoInfo · fullName, fullGuildName, level, raceStr, classStr, area, filename?, gender, timerunningSeasonID?

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (FriendList system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.