Added friends notes (2.4)
(→Notes) |
(Added friends notes (2.4)) |
||
| 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 == | ||
| Line 14: | Line 14: | ||
:;connected : Boolean - 1 if friend is online, nil otherwise. | :;connected : Boolean - 1 if friend is online, nil otherwise. | ||
:;status : String - Friend's current status flags (AFK or DND). | :;status : String - Friend's current status flags (AFK or DND). | ||
:;note : String - Friends 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 36: | Line 38: | ||
Please use GetNumFriends() to iterate over all indexes securely. | 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)}} | |||