WoW:API GetFriendInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (formatting repair)
Line 22: Line 22:
:;retVal1 : String - Friends name.
:;retVal1 : String - Friends name.
:;retVal2 : String - Friends level. If unknown returns 0, but sometimes 1 (can someone else test this)
:;retVal2 : 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)
:;retVal3 : String - Friends class. If unknown returns "Unknown"
:;retVal3 : String - Friends class. If unknown returns "Unknown"
:;retval4 : String - Friends current location. If unknown returns "Unknown"
:;retval4 : String - Friends current location. If unknown returns "Unknown"

Revision as of 03:37, 13 March 2005

GetFriendInfo -Documentation by IonDefender-


retVal1, retVal2, retVal3, retVal4 = GetFriendInfo(arg1);


Gets the name, level, class, and location of your friends


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)

Returns
retVal1, retVal2, retVal3, retVal4


retVal1
String - Friends name.
retVal2
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)
retVal3
String - Friends class. If unknown returns "Unknown"
retval4
String - Friends current location. If unknown returns "Unknown"

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.

Template:WoW API