WoW:API GetNumFriends: Difference between revisions

WoW:API GetNumFriends (source)

16 bytes added , 11 September 2005

m

Minor reformatting.

Anonymous user

@@ Line 1: / Line 1: @@
- <center>'''GetNumFriends''' ''-Documentation by jpopcenter-''</center>
+<center>'''GetNumFriends''' - ''Documentation by jpopcenter''</center>
-Returns number of friends.
+Returns how many friends you have.
-	numberOfFriends = GetNumFriends();
+ numberOfFriends = GetNumFriends()
+== Parameters ==
+=== Returns ===
+:numberOfFriends
-----
+:;numberOfFriends : Integer - The number of friends you have (i.e. the highest valid friend index you can use to get friend information).
-;''Arguments''
+== Example ==
+<!-- begin code -->
-:;None
-----
-;''Returns''
-:(Number numberOfFriends)
-:;numberOfFriends : The number of friends.
-----
-;''Example''
   DEFAULT_CHAT_FRAME:AddMessage("I've got " .. GetNumFriends() .. " friend(s)");
+<!-- end code -->
-;''Result''
+==== Result ====
+:Displays "I've got 3 friend(s)"
-Prints a message in the default chat frame.
-----
-;''Description''
-: Returns number of friends.
 ----
+__NOTOC__
 {{Template:WoW API}}
-[[Category:API Functions|GetNumFriends]]
 [[Category:API Friend Functions|GetNumFriends]]