WoW:API GetFriendInfo: Difference between revisions
Jump to navigation
Jump to search
GetFriendInfo - Documentation by IonDefender
mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
<center>'''GetFriendInfo''' - ''Documentation by [[user:Author|IonDefender]]''</center> | <center>'''GetFriendInfo''' - ''Documentation by [[user:Author|IonDefender]]''</center> | ||
Gets the name, level, class, location | Gets the name, level, class, location, connection, status of a friend | ||
name, level, class, area, connected = GetFriendInfo(friendIndex) | name, level, class, area, connected, status = GetFriendInfo(friendIndex) | ||
== Parameters == | == Parameters == | ||
=== Arguments === | === Arguments === | ||
| Line 17: | Line 17: | ||
:;area : String - Friend's current location ("Unknown" if index is out of bounds or friend is offline). | :;area : String - Friend's current location ("Unknown" if index is out of bounds or friend is offline). | ||
:;connected : Flag - 1 if friend is online, nil if not online (or index out of bounds). | :;connected : Flag - 1 if friend is online, nil if not online (or index out of bounds). | ||
:;status : String - Friends current status (IE AFK/etc found by [[User:Tigerheart|Tigerheart]]). | |||
== Example == | == Example == | ||
<!-- begin code --> | <!-- begin code --> | ||
local name, level, class, loc = GetFriendInfo(1); | local name, level, class, loc, connected, status = GetFriendInfo(1); | ||
DEFAULT_CHAT_FRAME:AddMessage("Your friend "..name.." (The level "..level.." "..class..") is in "..loc.."."); | DEFAULT_CHAT_FRAME:AddMessage("Your "..status.." friend "..name.." (The level "..level.." "..class..") is in "..loc.."."); | ||
<!-- end code --> | <!-- end code --> | ||
==== Result ==== | ==== Result ==== | ||
<!-- begin code --> | <!-- begin code --> | ||
Your friend Bill (The level 99 Leprechaun) is in Neverland. | Your <AFK> friend Bill (The level 99 Leprechaun) is in Neverland. | ||
<!-- end code --> | <!-- end code --> | ||
Revision as of 06:03, 16 January 2006
Gets the name, level, class, location, connection, status of a friend
name, level, class, area, connected, status = GetFriendInfo(friendIndex)
Parameters
Arguments
- (friendIndex)
- friendIndex
- Integer - Index of friend in the friend list (Note that status changes can re-order the friend list, indexes are not guaranteed to remain stable across events)
Returns
- name, level, class, area, connected
- name
- String - Friend's name ("Unknown" if index is out of bounds.)
- level
- Integer - Friend's level (0 if player is not online, 1 if index is out of bounds (confirmed by Topaz 22:37, 12 Mar 2005 (EST))
- class
- String - Friend's class ("Unknown" if index is out of bounds or friend is offline).
- area
- String - Friend's current location ("Unknown" if index is out of bounds or friend is offline).
- connected
- Flag - 1 if friend is online, nil if not online (or index out of bounds).
- status
- String - Friends current status (IE AFK/etc found by Tigerheart).
Example
local name, level, class, loc, connected, status = GetFriendInfo(1);
DEFAULT_CHAT_FRAME:AddMessage("Your "..status.." friend "..name.." (The level "..level.." "..class..") is in "..loc..".");
Result
Your <AFK> friend Bill (The level 99 Leprechaun) is in Neverland.
Details
- Friend information isn't necessarily automatically kept up to date. You can use the ShowFriends function to request an update from the server.