WoW:API GetFriendInfo: Difference between revisions
Jump to navigation
Jump to search
GetFriendInfo -Documentation by IonDefender-
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 --> | ||
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'' | ||
:( | :(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'' | ||
: | :name, level, class, area, connected | ||
:; | :;name : String - Friends name. | ||
:; | :;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) | ||
:; | :;class : String - Friends class. If unknown returns "Unknown" | ||
:; | :;area : String - Friends current location. If unknown returns "Unknown" | ||
:;connected : Boolean - Whether or not the friend is currently online | |||
---- | ---- | ||
Revision as of 20:05, 11 May 2005
name, level, class, area, connected = GetFriendInfo(friendIndex);
Gets the name, level, class, and location of your friends
- Arguments
- (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
- name, level, class, area, connected
- name
- String - Friends name.
- 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) --Topaz 22:37, 12 Mar 2005 (EST)
- class
- String - Friends class. If unknown returns "Unknown"
- area
- String - Friends current location. If unknown returns "Unknown"
- connected
- Boolean - Whether or not the friend is currently online
- Example
local num1, num2, num3, num4 = GetFriendInfo(1);
DEFAULT_CHAT_FRAME:AddMessage("Your friend "..num1.." (The level "..num2.." "..num3..") is in "..num4..".");
- Result
Your friend Bill (The level 99 Leprechaun) is in Neverland.