WoW:API GetNumFriends: Difference between revisions

Latest revision as of 04:46, 15 August 2023

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

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: @@
-  <center>'''GetNumFriends''' ''-Documentation by jpopcenter-''</center>
+{{wowapi}} __NOTOC__
+Returns how many friends you have.
+  numberOfFriends, onlineFriends = GetNumFriends()
-Returns number of friends.
+== Parameters ==
+=== Returns ===
+:;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.
-	numberOfFriends = GetNumFriends();
+== Example ==
+  DEFAULT_CHAT_FRAME:AddMessage("I've got " .. (GetNumFriends()) .. " friend(s)");
-----
+==== Result ====
-;''Arguments''
+Displays the number of friends you currently have in the default chat frame.
-:;None
-----
-;''Returns''
-:(Number numberOfFriends)
-:;numberOfFriends : The number of friends.
-----
-;''Example''
-  DEFAULT_CHAT_FRAME:AddMessage("I've got " .. GetNumFriends() .. " friend(s)");
-;''Result''
-Prints a message in the default chat frame.
-----
-;''Description''
-: Returns number of friends.
-----
-{{Template:WoW API}}