WoW:API GetFriendInfo - Revision history

Move page script: Move page script moved page API GetFriendInfo to WoW:API GetFriendInfo without leaving a redirect

2023-08-15T04:45:56Z

Move page script moved page API GetFriendInfo to API GetFriendInfo without leaving a redirect

← Older revision	Revision as of 04:45, 15 August 2023
(No difference)

WoWWiki>Fulz at 18:30, 6 January 2019

2019-01-06T18:30:07Z

← Older revision		Revision as of 18:30, 6 January 2019
Line 5:		Line 5:
	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	:;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) (Also note that index should not be greater than 50 [see Notes]).		:;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) (Also note that index should not be greater than 50 [see Notes]).

	=== Returns ===		=== Returns ===
	:;name : String - Friend's name, or nil (if index is invalid)		:;name
	:;level : Integer - Friend's level, or 0 (if offline/invalid).		:: String - Friend's name, or nil (if index is invalid)
	:;class : String - Friend's class, or "Unknown" (if offline/invalid).		:;level
	:;area : String - Friend's current location, or "Unknown" (if offline/invalid).		:: Integer - Friend's level, or 0 (if offline/invalid).
	:;connected : Boolean - 1 if friend is online, nil otherwise.		:;class
	:;~~note : String - Friends note.~~		:: String - Friend's class, or "Unknown" (if offline/invalid).
	:;status : String - Friend's current status flags (AFK or DND).		:;area
			:: String - Friend's current location, or "Unknown" (if offline/invalid).
			:;connected
			:: Boolean - 1 if friend is online, nil otherwise.
			:;
			:;status
			:: String - Friend's current status flags (AFK or DND).
			:;note
			:: String - Friend's note.

	== Example ==		== Example ==
Line 40:		Line 49:

	== References ==		== References ==

	{{Elink\|icon=wowus\|link=http://forums.worldofwarcraft.com/thread.html?topicId=5835557417#1\|site="ACTUAL API Changes - 2.3.3 to 2.4.1" - Forum post by Iriel (UI and Macros Forum MVP)}}		{{Elink\|icon=wowus\|link=http://forums.worldofwarcraft.com/thread.html?topicId=5835557417#1\|site="ACTUAL API Changes - 2.3.3 to 2.4.1" - Forum post by Iriel (UI and Macros Forum MVP)}}

WoWWiki>Valana: status is the last return value.

2009-04-06T04:56:04Z

status is the last return value.

← Older revision		Revision as of 04:56, 6 April 2009
Line 13:		Line 13:
	:;area : String - Friend's current location, or "Unknown" (if offline/invalid).		:;area : String - Friend's current location, or "Unknown" (if offline/invalid).
	:;connected : Boolean - 1 if friend is online, nil otherwise.		:;connected : Boolean - 1 if friend is online, nil otherwise.
			:;note : String - Friends note.
	:;status : String - Friend's current status flags (AFK or DND).		:;status : String - Friend's current status flags (AFK or DND).
	~~:;note : String - Friends note.~~

	== Example ==		== Example ==

WoWWiki>Egingell: /* Notes */ Removed personal pronoun and adjusted grammar.

2009-01-10T20:42:44Z

Notes: Removed personal pronoun and adjusted grammar.

← Older revision		Revision as of 20:42, 10 January 2009
Line 33:		Line 33:
	Do not use indexes greater than 50 (the maximum number of friend list entries)!		Do not use indexes greater than 50 (the maximum number of friend list entries)!

	In some ~~AddOn constellations I got WoW crashing by~~ typing "/script GetFriendInfo(51)" (especially if FlagRSP ~~was~~ activated).		With some AddOns installed the client may crash after typing "/script GetFriendInfo(51)" (especially if FlagRSP is activated).

	This crash leads to ERROR #132 (memory could not be "read").		This crash leads to ERROR #132 (memory could not be "read").

WoWWiki>Nafe: Added friends notes (2.4)

2008-05-06T16:23:41Z

Added friends notes (2.4)

← Older revision		Revision as of 16:23, 6 May 2008
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
	Retrieves information about a person on your friends list.		Retrieves information about a person on your friends list.
	name, level, class, area, connected, status = GetFriendInfo(friendIndex);		name, level, class, area, connected, status, note = GetFriendInfo(friendIndex);

	== Parameters ==		== Parameters ==
Line 14:		Line 14:
	:;connected : Boolean - 1 if friend is online, nil otherwise.		:;connected : Boolean - 1 if friend is online, nil otherwise.
	:;status : String - Friend's current status flags (AFK or DND).		:;status : String - Friend's current status flags (AFK or DND).
			:;note : String - Friends note.

	== Example ==		== Example ==
			This example is pre-2.4 and thus doesn't utilize the friend note.
	local name, level, class, loc, connected, status = GetFriendInfo(1);		local name, level, class, loc, connected, status = GetFriendInfo(1);
	if (name) then		if (name) then
Line 36:		Line 38:

	Please use GetNumFriends() to iterate over all indexes securely.		Please use GetNumFriends() to iterate over all indexes securely.

			== References ==

			{{Elink\|icon=wowus\|link=http://forums.worldofwarcraft.com/thread.html?topicId=5835557417#1\|site="ACTUAL API Changes - 2.3.3 to 2.4.1" - Forum post by Iriel (UI and Macros Forum MVP)}}

WoWWiki>Ohklus: /* Notes */

2007-05-01T12:36:12Z

Notes

← Older revision		Revision as of 12:36, 1 May 2007
Line 5:		Line 5:
	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	:;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).		:;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) (Also note that index should not be greater than 50 [see Notes]).

	=== Returns ===		=== Returns ===
	:;name : String - Friend's name, or nil (if index is invalid)		:;name : String - Friend's name, or nil (if index is invalid)
Line 26:		Line 27:
	==Notes==		==Notes==
	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.		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.


			Do not use indexes greater than 50 (the maximum number of friend list entries)!

			In some AddOn constellations I got WoW crashing by typing "/script GetFriendInfo(51)" (especially if FlagRSP was activated).

			This crash leads to ERROR #132 (memory could not be "read").

			Please use GetNumFriends() to iterate over all indexes securely.

WoWWiki>Starlightblunder: /* Returns */

2007-01-03T12:16:13Z

Returns

← Older revision		Revision as of 12:16, 3 January 2007
Line 1:		Line 1:
	~~<center>'''~~GetFriendInfo~~''' - ''Documentation by [[user:Author\|IonDefender]]''</center>~~		{{wowapi}} __NOTOC__
			Retrieves information about a person on your friends list.
			name, level, class, area, connected, status = GetFriendInfo(friendIndex);

	~~Gets the name, level, class, location, connection, status of a friend~~

	~~name, level, class, area, connected, status = GetFriendInfo(friendIndex)~~
	== Parameters ==		== Parameters ==
	=== Arguments ===		=== 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).

	:;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 : String - Friend's name, or nil (if index is invalid)
			:;level : Integer - Friend's level, or 0 (if offline/invalid).
			:;class : String - Friend's class, or "Unknown" (if offline/invalid).
			:;area : String - Friend's current location, or "Unknown" (if offline/invalid).
			:;connected : Boolean - 1 if friend is online, nil otherwise.
			:;status : String - Friend's current status flags (AFK or DND).

	~~:;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 [[User:Topaz\|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).~~
	~~:;status : String - Friends current status (IE AFK/etc found by [[User:Tigerheart\|Tigerheart]]).~~
	== Example ==		== Example ==
	~~<!-- begin code -->~~
	local name, level, class, loc, connected, status = GetFriendInfo(1);		local name, level, class, loc, connected, status = GetFriendInfo(1);
	DEFAULT_CHAT_FRAME:AddMessage("Your "..status.." friend "..name.." (The level "..level.." "..class..") is in "..loc..".");		if (name) then
	<!-- end ~~code -->~~		DEFAULT_CHAT_FRAME:AddMessage("Your "..status.." friend "..name.." (The level "..level.." "..class..") is in "..loc..".");
	==== Result ====		else
	~~<!-- begin code -->~~		DEFAULT_CHAT_FRAME:AddMessage("You have no friends?!");
	Your <AFK> friend Bill (The level 99 Leprechaun) is in Neverland.		end
	~~<!-- end code -->~~		===Result===
			Your <AFK> friend Bill (The level 99 Leprechaun) is in Neverland.
	~~== 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.~~


	~~----~~		==Notes==
	~~{{WoW~~ API}}		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__~~

WoWWiki>Tigerheart at 06:03, 16 January 2006

2006-01-16T06:03:16Z

← Older revision		Revision as of 06:03, 16 January 2006
Line 1:		Line 1:
	<center>'''GetFriendInfo''' - ''Documentation by [[user:Author\|IonDefender]]''</center>		<center>'''GetFriendInfo''' - ''Documentation by [[user:Author\|IonDefender]]''</center>

	Gets the name, level, class, location ~~and~~ status of a friend		Gets the name, level, class, location, connection, status of a friend

	name, level, class, area, connected = GetFriendInfo(friendIndex)		name, level, class, area, connected, status = GetFriendInfo(friendIndex)
	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
Line 17:		Line 17:
	:;area : String - Friend's current location ("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).		:;connected : Flag - 1 if friend is online, nil if not online (or index out of bounds).
			:;status : String - Friends current status (IE AFK/etc found by [[User:Tigerheart\|Tigerheart]]).
	== Example ==		== Example ==
	<!-- begin code -->		<!-- begin code -->
	local name, level, class, loc = GetFriendInfo(1);		local name, level, class, loc, connected, status = GetFriendInfo(1);
	DEFAULT_CHAT_FRAME:AddMessage("Your friend "..name.." (The level "..level.." "..class..") is in "..loc..".");		DEFAULT_CHAT_FRAME:AddMessage("Your "..status.." friend "..name.." (The level "..level.." "..class..") is in "..loc..".");
	<!-- end code -->		<!-- end code -->
	==== Result ====		==== Result ====
	<!-- begin code -->		<!-- begin code -->
	Your friend Bill (The level 99 Leprechaun) is in Neverland.		Your <AFK> friend Bill (The level 99 Leprechaun) is in Neverland.
	<!-- end code -->		<!-- end code -->

WoWWiki>Gxam at 19:48, 7 January 2006

2006-01-07T19:48:27Z

← Older revision		Revision as of 19:48, 7 January 2006
Line 33:		Line 33:
	----		----
	{{WoW API}}		{{WoW API}}
			__NOTOC__

WoWWiki>Muert at 12:40, 4 January 2006

2006-01-04T12:40:30Z

← Older revision		Revision as of 12:40, 4 January 2006
Line 29:		Line 29:
	== Details ==		== 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.		: 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__~~		{{WoW API}}
	{{~~Template:~~WoW API}}
	~~[[Category:API Friend Functions\|GetFriendInfo]]~~