WoW:API GetNumFriends: Difference between revisions
Jump to navigation
Jump to search
({{wowapi}}) |
m (Move page script moved page API GetNumFriends to API GetNumFriends without leaving a redirect) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ | {{wowapi}} __NOTOC__ | ||
Returns how many friends you have. | Returns how many friends you have. | ||
numberOfFriends = GetNumFriends() | numberOfFriends, onlineFriends = GetNumFriends() | ||
== Parameters == | == Parameters == | ||
=== Returns === | === Returns === | ||
:;numberOfFriends : Integer - The number of friends you have (i.e. the highest valid friend index you can use to get friend information). | :;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. | |||
== Example == | == Example == | ||
DEFAULT_CHAT_FRAME:AddMessage("I've got " .. GetNumFriends() .. " friend(s)"); | DEFAULT_CHAT_FRAME:AddMessage("I've got " .. (GetNumFriends()) .. " friend(s)"); | ||
==== Result ==== | ==== Result ==== | ||
Displays the number of friends you currently have in the default chat frame. | Displays the number of friends you currently have in the default chat frame. | ||
Latest revision as of 04:46, 15 August 2023
← WoW API < GetNumFriends
Returns how many friends you have.
numberOfFriends, onlineFriends = GetNumFriends()
Parameters[edit]
Returns[edit]
- 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.
Example[edit]
DEFAULT_CHAT_FRAME:AddMessage("I've got " .. (GetNumFriends()) .. " friend(s)");
Result[edit]
Displays the number of friends you currently have in the default chat frame.