WoW:API GetFriendInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
<center>'''GetFriendInfo''' ''-Documentation by [[user:Author|IonDefender]]-''</center>
<center>'''GetFriendInfo''' ''-Documentation by [[user:Author|IonDefender]]-''</center>


<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
Gets the name, level, class, and location of your friends


  name, level, class, area, connected = GetFriendInfo(friendIndex);
  name, level, class, area, connected = GetFriendInfo(friendIndex);


<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
== Parameters ==
=== Arguments ===
:(friendIndex)


Gets the name, level, class, and location of your friends
:;friendIndex : Integer - 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)
 
----
;''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, level, class, area, connected




:;name : String - Friends name.
:;name : String - Friends name.
:;level : String - Friends level. If unknown returns 0, but sometimes 1 (can someone else test this)
:;level : Integer - 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"
:;class : String - Friends class. If unknown returns "Unknown"
Line 27: Line 22:
:;connected : Boolean - Whether or not the friend is currently online
:;connected : Boolean - Whether or not the friend is currently online


----
== Example ==
;''Example''
 
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
  local num1, num2, num3, num4 = GetFriendInfo(1);
  local num1, num2, num3, num4 = GetFriendInfo(1);
  DEFAULT_CHAT_FRAME:AddMessage("Your friend "..num1.." (The level "..num2.." "..num3..") is in "..num4..".");
  DEFAULT_CHAT_FRAME:AddMessage("Your friend "..num1.." (The level "..num2.." "..num3..") is in "..num4..".");


;''Result''
====Result====
<!-- If it helps, include example results here, though they are not required-->
  Your friend Bill (The level 99 Leprechaun) is in Neverland.
  Your friend Bill (The level 99 Leprechaun) is in Neverland.


----
----
__NOTOC__
{{Template:WoW API}}
{{Template:WoW API}}
<!-- Update the category to the appropriate subsection, and be sure to put the function name as the label for the category link. Multiple subcategories are okay if appropriate, please dont link functions to the API Functions category directly. -->
[[Category:API Friend Functions|GetFriendInfo]]
[[Category:API Functions|Empty Template]]

Revision as of 05:08, 25 August 2005

GetFriendInfo -Documentation by IonDefender-

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

name, level, class, area, connected = GetFriendInfo(friendIndex);

Parameters

Arguments

(friendIndex)
friendIndex
Integer - 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
Integer - 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.

Template:WoW API

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetFriendInfo&oldid=9117"