m
Move page script moved page API GetFriendInfo to WoW:API GetFriendInfo without leaving a redirect
m (Move page script moved page API GetFriendInfo to WoW:API GetFriendInfo without leaving a redirect) |
|||
| (5 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ | {{wowapi}} __NOTOC__ | ||
Retrieves information about a person on your friends list. | Retrieves information about a person on your friends list. | ||
name, level, class, area, connected, status = GetFriendInfo(friendIndex); | name, level, class, area, connected, status, note = GetFriendInfo(friendIndex); | ||
== 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 | ||
:;level : Integer - Friend's level, or 0 (if offline/invalid). | :: String - Friend's name, or nil (if index is invalid) | ||
:;class : String - Friend's class, or "Unknown" (if offline/invalid). | :;level | ||
:;area : String - Friend's current location, or "Unknown" (if offline/invalid). | :: Integer - Friend's level, or 0 (if offline/invalid). | ||
:;connected : Boolean - 1 if friend is online, nil otherwise. | :;class | ||
:;status : String - Friend's current status flags (AFK or DND). | :: 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). | |||
:;note | |||
:: String - Friend's note. | |||
== Example == | == Example == | ||
This example is pre-2.4 and thus doesn't utilize the friend note. | |||
local name, level, class, loc, connected, status = GetFriendInfo(1); | local name, level, class, loc, connected, status = GetFriendInfo(1); | ||
if (name) then | if (name) then | ||
| Line 26: | Line 38: | ||
==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)! | |||
With some AddOns installed the client may crash after typing "/script GetFriendInfo(51)" (especially if FlagRSP is activated). | |||
This crash leads to ERROR #132 (memory could not be "read"). | |||
Please use GetNumFriends() to iterate over all indexes securely. | |||
== References == | |||
{{Elink|icon=wowus|link=http://forums.worldofwarcraft.com/thread.html?topicId=5835557417#1|site="ACTUAL API Changes - 2.3.3 to 2.4.1" - Forum post by Iriel (UI and Macros Forum MVP)}} | |||