Changes: API C FriendList.GetNumFriends

Revision as of 06:05, 24 June 2010

Returns how many friends you have.

numberOfFriends, onlineFriends = GetNumFriends()

numberOfFriends: Integer - The number of friends you have (i.e. the highest valid friend index you can use to get friend information).
onlineFriends: Integer - The number of online friends.

DEFAULT_CHAT_FRAME:AddMessage("I've got " .. (GetNumFriends()) .. " friend(s)");

Displays the number of friends you currently have in the default chat frame.

@@ Line 1: / Line 1: @@
+{{wowapi}} __NOTOC__
-<center>'''GetNumFriends''' - ''Documentation by jpopcenter''</center>
 Returns how many friends you have.
+ numberOfFriends, onlineFriends = GetNumFriends()
- numberOfFriends = GetNumFriends()
 == Parameters ==
 === Returns ===
+:;numberOfFriends : Integer - The number of friends you have (i.e. the highest valid friend index you can use to get friend information).
-:numberOfFriends
+:;onlineFriends : Integer - The number of online friends.
-:;numberOfFriends : Integer - The number of friends you have (i.e. the highest valid friend index you can use to get friend information).
 == Example ==
+ DEFAULT_CHAT_FRAME:AddMessage("I've got " .. (GetNumFriends()) .. " friend(s)");
-<!-- begin code -->
- DEFAULT_CHAT_FRAME:AddMessage("I've got " .. GetNumFriends() .. " friend(s)");
-<!-- end code -->
 ==== Result ====
+Displays the number of friends you currently have in the default chat frame.
-:Displays "I've got 3 friend(s)"
-----
-{{WoW API}}