WoW:API GetFriendInfo: Difference between revisions
Jump to navigation
Jump to search
(→Notes) |
|||
| Line 5: | Line 5: | ||
== Parameters == | == Parameters == | ||
=== Arguments === | === Arguments === | ||
:;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). | :;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) (Also note that index should not be greater than 50 [see Notes]). | ||
=== Returns === | === Returns === | ||
:;name : String - Friend's name, or nil (if index is invalid) | :;name : String - Friend's name, or nil (if index is invalid) | ||
| Line 26: | Line 27: | ||
==Notes== | ==Notes== | ||
Friend information isn't necessarily automatically kept up to date. You can use the [[API ShowFriends|ShowFriends]] function to request an update from the server. | Friend information isn't necessarily automatically kept up to date. You can use the [[API ShowFriends|ShowFriends]] function to request an update from the server. | ||
Do not use indexes greater than 50 (the maximum number of friend list entries)! | |||
In some AddOn constellations I got WoW crashing by typing "/script GetFriendInfo(51)" (especially if FlagRSP was activated). | |||
This crash leads to ERROR #132 (memory could not be "read"). | |||
Please use GetNumFriends() to iterate over all indexes securely. | |||
Revision as of 12:36, 1 May 2007
← WoW API < GetFriendInfo
Retrieves information about a person on your friends list.
name, level, class, area, connected, status = GetFriendInfo(friendIndex);
Parameters
Arguments
- 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) (Also note that index should not be greater than 50 [see Notes]).
Returns
- name
- String - Friend's name, or nil (if index is invalid)
- level
- Integer - Friend's level, or 0 (if offline/invalid).
- class
- String - Friend's class, or "Unknown" (if offline/invalid).
- area
- String - Friend's current location, or "Unknown" (if offline/invalid).
- connected
- Boolean - 1 if friend is online, nil otherwise.
- status
- String - Friend's current status flags (AFK or DND).
Example
local name, level, class, loc, connected, status = GetFriendInfo(1);
if (name) then
DEFAULT_CHAT_FRAME:AddMessage("Your "..status.." friend "..name.." (The level "..level.." "..class..") is in "..loc..".");
else
DEFAULT_CHAT_FRAME:AddMessage("You have no friends?!");
end
Result
Your <AFK> friend Bill (The level 99 Leprechaun) is in Neverland.
Notes
Friend information isn't necessarily automatically kept up to date. You can use the ShowFriends function to request an update from the server.
Do not use indexes greater than 50 (the maximum number of friend list entries)!
In some AddOn constellations I got WoW crashing by typing "/script GetFriendInfo(51)" (especially if FlagRSP was activated).
This crash leads to ERROR #132 (memory could not be "read").
Please use GetNumFriends() to iterate over all indexes securely.