Navigation menu

WoW:API GetFriendInfo: Difference between revisions

Jump to navigation Jump to search
no edit summary
(status is the last return value.)
No edit summary
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) (Also note that index should not be greater than 50 [see Notes]).
:;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
:;note : String - Friends note.
:: String - Friend's class, or "Unknown" (if offline/invalid).
:;status : String - Friend's current status flags (AFK or DND).
:;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 ==
Line 40: Line 49:


== References ==
== 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)}}
{{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)}}
Anonymous user