WoW:API BNGetFriendInfo: Difference between revisions
Jump to navigation
Jump to search
m (Number of seconds since last online was incorrect based on trial and error) |
(corrected mistake in surname description) |
||
| Line 9: | Line 9: | ||
:presenceID, givenName, surname, toonName, toonID, client, isOnline, lastOnline, isAFK, isDND, broadcastText, noteText, isFriend, broadcastTime | :presenceID, givenName, surname, toonName, toonID, client, isOnline, lastOnline, isAFK, isDND, broadcastText, noteText, isFriend, broadcastTime | ||
;presenceID : Number - a unique numeric identifier for this friend for this session | ;presenceID : Number - a unique numeric identifier for this friend for this session | ||
;givenName : String - the friend's first name | ;givenName : String - a |K [[UI_escape_sequences|Escape Sequence]] representing the friend's first/given name (As of 4.0) | ||
;surname : String - the friend's family name | ;surname : String - a |K [[UI_escape_sequences|Escape Sequence]] representing the friend's Surname/family name (As of 4.0) | ||
;toonName : String - the name of the friend's currently logged in character | ;toonName : String - the name of the friend's currently logged in character | ||
;toonID : Number - a unique numeric identifier for this friend's character for this session | ;toonID : Number - a unique numeric identifier for this friend's character for this session | ||
Revision as of 14:05, 15 October 2010
Returns information about the specified RealID friend
presenceID, givenName, surname, toonName, toonID, client, isOnline, lastOnline, isAFK, isDND, broadcastText, noteText, isFriend, broadcastTime = BNGetFriendInfo(friendIndex)
Arguments
- friendIndex
- number - The index on the friends list for this RealID friend
Returns
- presenceID, givenName, surname, toonName, toonID, client, isOnline, lastOnline, isAFK, isDND, broadcastText, noteText, isFriend, broadcastTime
- presenceID
- Number - a unique numeric identifier for this friend for this session
- givenName
- String - a |K Escape Sequence representing the friend's first/given name (As of 4.0)
- surname
- String - a |K Escape Sequence representing the friend's Surname/family name (As of 4.0)
- toonName
- String - the name of the friend's currently logged in character
- toonID
- Number - a unique numeric identifier for this friend's character for this session
- client
- String - Either "WoW" or "S2", for World of Warcraft or Starcraft2
- isOnline
- Boolean - true if the friend is online
- lastOnline
- Number - the number of seconds since this friend was last online since last Epoch, January 1, 1970, nil if currently online
- isAFK
- Boolean - true if the friend is flagged as Away
- isDND
- Boolean - true if the friend is flagged as Busy
- broadcastText
- String - the contents of the friend's broadcast message
- noteText
- String - the contents of the player's note about this friend
- isFriend
- Boolean - unknown
- broadcastTime
- Number - the number of seconds since the friend send the current broadcast
Details
The client names can be accessed via the globals BNET_CLIENT_WOW and BNET_CLIENT_SC2