v0.13.8

C_BattleNet

namespaceavailable in: camelot

Status in wowlua

35 functions: 0 implemented, 2 recorded, 33 guessed.

Functions

functionwhat it doesstatus
AreFriendTagsEnabledWhether tags for Battle.net friends are enabled. · by wowlua
(): boolean
guessed
AreHighResTexturesInstalledWhether the high-resolution textures are installed. · by wowlua
(): boolean
guessed
AreRealIDFriendsEnabledWhether Real ID friends are enabled for the account. · by wowlua
(): boolean
guessed
AreTitleFriendCustomNamesEnabledWhether custom names for in-game friends are enabled. · by wowlua
(): boolean
guessed
AreTitleFriendsEnabledWhether in-game friends of this game title are enabled. · by wowlua
(): boolean
guessed
BNCheckBattleTagInviteToRecentAllyChecks whether a recent ally can be invited as a BattleTag friend. · by wowlua
(recentAllyGUID: string)
guessed
BNCheckTitleFriendInviteToUnitChecks whether the unit can be invited as an in-game friend. · by wowlua
(unit: string)
guessed
CanToggleHighResTexturesWithoutClientReloadWhether the high-resolution textures can be turned on or off without reloading the client. · by wowlua
(): boolean
guessed
GetAccountInfoByGUIDReturns information about a Battle.net friend account.
(guid: string): BNetAccountInfo?
guessed
GetAccountInfoByIDReturns information about a Battle.net friend account.
(id: number, wowAccountGUID: string?): BNetAccountInfo?
guessed
GetCustomTitleFriendNameReturns the custom name given to an in-game friend, or nil. · by wowlua
(id: number): string?
guessed
GetFriendAccountInfoReturns information about a Battle.net friend account.
(friendIndex: number, wowAccountGUID: string?): BNetAccountInfo?
guessed
GetFriendGameAccountInfoReturns information on the game the Battle.net friend is playing.
(friendIndex: number, accountIndex: number): BNetGameAccountInfo?
guessed
GetFriendInviteInfoReturns information about a pending Battle.net friend invite. · by wowlua
(inviteIndex: number): BNetFriendInviteInfo?
guessed
GetFriendLevelFromInviteTextReturns the Battle.net friend level that the given invite text corresponds to. · by wowlua
(inviteText: string): BattleNetFriendLevel
guessed
GetFriendNumGameAccountsReturns the number of game accounts for the Battle.net friend.
(friendIndex: number): number
guessed
GetGameAccountInfoByGUIDReturns information about the Battle.net game account of the player with the given GUID. · by wowlua
(guid: string): BNetGameAccountInfo?
guessed
GetGameAccountInfoByIDReturns information about a Battle.net game account. · by wowlua
(id: number): BNetGameAccountInfo?
guessed
InstallHighResTexturesInstalls the high-resolution textures. · by wowlua
()
guessed
InviteFriendInvites a Battle.net friend's game account to the group. · by wowlua
(gameAccountID: number)
guessed
IsBattleNetFriendsListEnabledWhether the Battle.net friends list is enabled. · by wowlua
(): boolean
guessed
IsBattleNetFriendsListSupportedWhether the Battle.net friends list is supported. · by wowlua
(): boolean
recorded
IsFriendTagSupportedForCurrentGameTypeWhether the friend tag can be used in the current game type. · by wowlua
(friendTag: BattleNetFriendTag): boolean
recorded
SearchFriendsSearches the friends list and returns the IDs of the matching friends. · by wowlua
(searchInfo: AuroraFriendsSearchInfo): number[]
guessed
SendGameDataSends an addon message to a Battle.net friend's game account and returns whether it was sent or why not. · by wowlua
(gameAccountID: number, prefix: stringView, data: stringView): SendAddonMessageResult
guessed
SendTitleFriendInviteByNameSends an in-game friend invite to the named player. · by wowlua
(name: string)
guessed
SendVerifiedBattleNetFriendInviteSends the Battle.net friend invite that is waiting for confirmation. · by wowlua
()
guessed
SendWhisperSends a whisper to a Battle.net friend and returns whether it was sent. · by wowlua
(bnetAccountID: number, text: stringView): boolean
guessed
SetAFKSets or clears the player's away status on Battle.net. · by wowlua
(isAFK: boolean)
guessed
SetAppearOfflineSets whether the player appears offline to Battle.net friends. · by wowlua
(isAppearOffline: boolean)
guessed
SetBlockedBlocks or unblocks a Battle.net account. · by wowlua
(bnetAccountID: number, block: boolean)
guessed
SetCustomMessageSets the player's Battle.net status message and returns whether it was set. · by wowlua
(text: string): boolean
guessed
SetCustomTitleFriendNameGives an in-game friend a custom name. · by wowlua
(id: number, customName: string)
guessed
SetDNDSets or clears the player's busy (do not disturb) status on Battle.net. · by wowlua
(isDND: boolean)
guessed
SetFriendTagsSets the tags of a Battle.net friend. · by wowlua
(id: number, friendTags: BattleNetFriendTag[])
guessed

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

Structures

  • AuroraFriendsSearchInfo · searchText, isOnline, isOffline, isDND, isAFK, isInQueue, isAvailableForQueue, tags
  • BNetAccountInfo · bnetAccountID, accountName, battleTag, isFriend, isBattleTagFriend, friendLevel?, lastOnlineTime, isAFK, isDND, isFavorite, friendTags, appearOffline, customMessage, customMessageTime, note, rafLinkType, gameAccountInfo
  • BNetFriendInviteInfo · inviteID, accountName, creationTimestamp, friendLevel?
  • BNetGameAccountInfo · gameAccountID, clientProgram, isOnline, isGameBusy, isGameAFK, isAppearOffline, wowProjectID?, characterName?, realmName?, realmDisplayName?, realmID?, factionName?, raceName?, classID?, className?, classFilename?, areaName?, characterLevel?, richPresence?, playerGuid?, canSummon, hasFocus, regionID, isInCurrentRegion, timerunningSeasonID?

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (BattleNet 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.