GetFriendsAsync

Yields

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts.

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

Players

Description:

The GetFriends Players function returns a FriendPages object which contains information for all of the given Player|Player's friends. The items within the FriendPages object are tables with the following fields:

Name	Type	Description
Id	int64	The friend's UserId
Username	string	The friend's username
DisplayName	string	The display name of the friend.
IsOnline	bool	If the friend is currently online

See the code samples for an easy way to iterate over all a player’s friends.

Parameters

Name	Type	Default	Description
Name userId	Type int64	Default	Summary The userId of the player being specified.

Returns

Return Type	Summary
Return Type FriendPages	Summary

Code Samples

Print Roblox Friends

This code sample loads the Player/UserId of the player whose username is provided at the top of the script by using Players/GetUserIdFromNameAsync. Then, it gets a FriendPages object by calling Players/GetFriendsAsync and iterates over each entry using the iterPageItems function. The username of each friend is stored in a table, then printed at the end.

			
				Print Roblox Friends

				Expected Output
			
				Expand
				
			local Players = game:GetService("Players")

local USERNAME = "Shedletsky"

local function iterPageItems(pages)
	return coroutine.wrap(function()
		local pagenum = 1
		while true do
			for _, item in ipairs(pages:GetCurrentPage()) do
				coroutine.yield(item, pagenum)
			end
			if pages.IsFinished then
				break
			end
			pages:AdvanceToNextPageAsync()
			pagenum = pagenum + 1
		end
	end)
end

-- First, get the user ID of the player
local userId = Players:GetUserIdFromNameAsync(USERNAME)
-- Then, get a FriendPages object for their friends
local friendPages = Players:GetFriendsAsync(userId)
-- Iterate over the items in the pages. For FriendPages, these
-- are tables of information about the friend, including Username.
-- Collect each username in a table
local usernames = {}
for item, pageNo in iterPageItems(friendPages) do
	table.insert(usernames, item.Username)
end
-- and finally, print!
print("Friends of " .. USERNAME .. ": " .. table.concat(usernames, ", "))
		
			When run, this code sample will load the friends of the player whose username is provided at the top of the script.
		
				Copy Code
			
				Light Theme