WoW:API GetFriendInfo: Difference between revisions
Jump to navigation
Jump to search
GetFriendInfo - Documentation by IonDefender
mNo edit summary |
m (Updated index description, added details.) |
||
| Line 1: | Line 1: | ||
<center>'''GetFriendInfo''' '' | <center>'''GetFriendInfo''' - ''Documentation by [[user:Author|IonDefender]]''</center> | ||
Gets the name, level, class, and | Gets the name, level, class, location and status of a friend | ||
name, level, class, area, connected = GetFriendInfo(friendIndex) | |||
== Parameters == | == Parameters == | ||
=== Arguments === | === Arguments === | ||
:(friendIndex) | :(friendIndex) | ||
:;friendIndex : Integer - Index of friend ( | :;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) | ||
=== Returns === | === Returns === | ||
:name, level, class, area, connected | :name, level, class, area, connected | ||
:;name : String - Friend's name ("Unknown" if index is out of bounds.) | |||
:;name : String - | :;level : Integer - Friend's level (0 if player is not online, 1 if index is out of bounds (confirmed by [[User:Topaz|Topaz]] 22:37, 12 Mar 2005 (EST)) | ||
:;level : Integer - | :;class : String - Friend's class ("Unknown" if index is out of bounds or friend is offline). | ||
:;area : String - Friend's current location ("Unknown" if index is out of bounds or friend is offline). | |||
:;class : String - | :;connected : Flag - 1 if friend is online, nil if not online (or index out of bounds). | ||
:;area : String - | |||
:;connected : | |||
== Example == | == Example == | ||
<!-- begin code --> | |||
local name, level, class, loc = GetFriendInfo(1); | |||
DEFAULT_CHAT_FRAME:AddMessage("Your friend "..name.." (The level "..level.." "..class..") is in "..loc.."."); | |||
<!-- end code --> | |||
==== Result ==== | |||
<!-- begin code --> | |||
Your friend Bill (The level 99 Leprechaun) is in Neverland. | |||
<!-- end code --> | |||
== Details == | |||
: Friend information isn't necessarily automatically kept up to date. You can use the [[API ShowFriends|ShowFriends]] function to request an update from the server. | |||
---- | ---- | ||
__NOTOC__ | __NOTOC__ | ||
{{Template:WoW API}} | {{Template:WoW API}} | ||
[[Category:API Friend Functions|GetFriendInfo]] | [[Category:API Friend Functions|GetFriendInfo]] | ||
Revision as of 19:14, 11 September 2005
Gets the name, level, class, location and status of a friend
name, level, class, area, connected = GetFriendInfo(friendIndex)
Parameters
Arguments
- (friendIndex)
- 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)
Returns
- name, level, class, area, connected
- name
- String - Friend's name ("Unknown" if index is out of bounds.)
- level
- Integer - Friend's level (0 if player is not online, 1 if index is out of bounds (confirmed by Topaz 22:37, 12 Mar 2005 (EST))
- class
- String - Friend's class ("Unknown" if index is out of bounds or friend is offline).
- area
- String - Friend's current location ("Unknown" if index is out of bounds or friend is offline).
- connected
- Flag - 1 if friend is online, nil if not online (or index out of bounds).
Example
local name, level, class, loc = GetFriendInfo(1);
DEFAULT_CHAT_FRAME:AddMessage("Your friend "..name.." (The level "..level.." "..class..") is in "..loc..".");
Result
Your friend Bill (The level 99 Leprechaun) is in Neverland.
Details
- Friend information isn't necessarily automatically kept up to date. You can use the ShowFriends function to request an update from the server.