API BNGetFriendGameAccountInfo

From Wowpedia
Jump to: navigation, search

Returns information about the specified toon of a RealID or BattleTag friend.

hasFocus, characterName, client, realmName, realmID, faction, race, class, guild, zoneName, level, gameText, broadcastText, broadcastTime, canSoR, bnetIDGameAccount, presenceID, unknown, unknown, characterGUID = BNGetFriendGameAccountInfo(friendIndex, accountIndex)

Arguments

friendIndex 
Number - The index on the friends list for this RealID friend.
accountIndex 
Number - The index of accounts for this RealID friend.

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 - From the list of "WoW" (BNET_CLIENT_WOW), "S2" (BNET_CLIENT_S2), "D3" (BNET_CLIENT_D3) or "HS" (BNET_CLIENT_WTCG) for World of Warcraft, StarCraft 2, Diablo 3 or Heartstone.
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 - Returns an empty string in all cases, guilded, same guild as querying character, unguilded, same server, or other server.
zoneName 
String - The localized zone name (e.g., "The Undercity").
level 
String - The current level (e.g., "90").
gameText 
String - An XML/HTML-safe representation of the current location of the player (e.g. Val'Sharah - Earthen Ring but with the apostrophe represented in XML/HTML-safe code).
broadcastText 
String - The Battle.Net broadcast message.
broadcastTime 
Number - The number of milliseconds elapsed since the current broadcast message was sent.
canSoR 
Boolean - Whether or not this friend can receive a Scroll of Resurrection.
bnetIDGameAccount 
Number - See discussion page (for descriptive, but not functional overlap with presenceID notes).
presenceID 
Number - A unique numeric identifier for this friend's battle.net account for the current session.
unknown 
Boolean - Unknown purpose - see discussion page.
unknown 
Boolean - Unknown purpose - see discussion page.
characterGUID 
String - Character's GUID. Nil if character is not currently in WoW.


Patch changes

  • Warlords of Draenor Patch 6.2.4 (2016-03-22): Name Changed from BNGetFriendToonInfo to BNGetFriendGameAccountInfo.
  • Mists of Pandaria Patch 5.0.4 (2012-08-28): Returns changed: faction is now a string. canSoR and toonID added.

See also