Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
Returns information about the specified toon of a RealID friend.
hasFocus, characterName, client, realmName, realmID, faction, race, class, guild, zoneName, level, gameText, broadcastText, broadcastTime, canSoR, toonID, bnetIDAccount, isGameAFK, isGameBusy = BNGetFriendGameAccountInfo(friendIndex) = BNGetGameAccountInfo(bnetIDGameAccount) = BNGetGameAccountInfoByGUID(guid)
Arguments[]
BNGetFriendGameAccountInfo[]
- friendIndex
- number - Ranging from 1 to BNGetNumFriendGameAccounts()
BNGetGameAccountInfo[]
- bnetIDGameAccount
- number - A unique numeric identifier for the friend during this session.
BNGetGameAccountInfoByGUID[]
- guid
- string
Returns[]
- hasFocus
- boolean - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame.
- characterName
- string - The name of the logged in toon/character.
- client
- string - Either "WoW" (BNET_CLIENT_WOW), "S2" (BNET_CLIENT_S2), "WTCG" (BNET_CLIENT_WTCG), "App" (BNET_CLIENT_APP), "Hero" (BNET_CLIENT_HEROES), "Pro" (BNET_CLIENT_OVERWATCH), "CLNT" (BNET_CLIENT_CLNT), or "D3" (BNET_CLIENT_D3) for World of Warcraft, StarCraft 2, Hearthstone, BNet Application, Heroes of the Storm, Overwatch, another client, or Diablo 3.
- realmName
- string - The name of the logged in realm.
- realmID
- number - The ID for the logged in realm.
- faction
- string - The faction name (i.e., "Alliance" or "Horde").
- race
- string - The localized race name (e.g., "Blood Elf").
- class
- string - The localized class name (e.g., "Death Knight").
- guild
- string - Seems to return "" even if the player is in a guild.
- zoneName
- string - The localized zone name (e.g., "The Undercity").
- level
- string - The current level (e.g., "90").
- gameText
- string - For WoW, returns "
zoneName
-realmName
". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. - broadcastText
- string - The Battle.Net broadcast message.
- broadcastTime
- number - The number of seconds elapsed since the current broadcast message was sent.
- canSoR
- boolean - Whether or not this friend can receive a Scroll of Resurrection.
- toonID
- number - A unique numeric identifier for the friend's character during this session.
- bnetIDAccount
- number
- isGameAFK
- boolean
- isGameBusy
- boolean
Example[]
local bnetIDGameAccount = select(6,BNGetFriendInfo(1)) -- assuming friend index 1 is me (Grdn)
local _, characterName, _, realmName = BNGetGameAccountInfo(bnetIDGameAccount)
print(toonName.." plays on "..realmName) -- Grdn plays on Onyxia
Patch changes[]
Patch 6.2.4 (2016-03-22): API Changed from BNGetToonInfo to BNGetGameAccountInfo.
Patch 5.0.4 (2012-08-28): Returns changed: faction
is now a string. canSoR
and toonID
added.