Navigation menu

WoW:API GetFriendInfo: Difference between revisions

Jump to navigation Jump to search
no edit summary
m (formatting repair)
No edit summary
Line 3: Line 3:
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->


  retVal1, retVal2, retVal3, retVal4 = GetFriendInfo(arg1);
  name, level, class, area, connected = GetFriendInfo(friendIndex);


<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
Line 12: Line 12:
;''Arguments''
;''Arguments''


:(arg1) : Int - Index of friend (Does not appear to be the exact order they appear in the friends list as online friends are sorted to the top but always have the same index)
:(friendIndex) : Int - Index of friend (Does not appear to be the exact order they appear in the friends list as online friends are sorted to the top but always have the same index)


----
----
;''Returns''
;''Returns''


:retVal1, retVal2, retVal3, retVal4
:name, level, class, area, connected




:;retVal1 : String - Friends name.
:;name : String - Friends name.
:;retVal2 : String - Friends level. If unknown returns 0, but sometimes 1 (can someone else test this)
:;level : String - Friends level. If unknown returns 0, but sometimes 1 (can someone else test this)
::looks like this is 1 when arg1 is out of bounds (e.g., 0) --[[User:Topaz|Topaz]] 22:37, 12 Mar 2005 (EST)
::looks like this is 1 when arg1 is out of bounds (e.g., 0) --[[User:Topaz|Topaz]] 22:37, 12 Mar 2005 (EST)
:;retVal3 : String - Friends class. If unknown returns "Unknown"
:;class : String - Friends class. If unknown returns "Unknown"
:;retval4 : String - Friends current location. If unknown returns "Unknown"
:;area : String - Friends current location. If unknown returns "Unknown"
:;connected : Boolean - Whether or not the friend is currently online


----
----
Anonymous user