IsFriendsWith

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:

Player

Description:

This function sends a request to the Roblox website asking whether a player is a friend of another user, given the Player/UserId of that user. This function caches results so multiple calls of the function on the same player with the same userId may not yield the most up-to-date result. This does not happen when used in a LocalScript.

Parameters

Name	Type	Default	Description
Name userId	Type int64	Default	Summary The `Player/UserId` of the specified player.

Returns

Return Type	Summary
Return Type bool	Summary A boolean indicating whether a player is a friend of the specified user.

Code Samples

How to Check if a Player is a Friend

The below example would print whether or not a recently added player is friends with Gordonrox24.

			
				How to Check if a Player is a Friend

				Expected Output
			
				Expand
				
			game.Players.PlayerAdded:Connect(function(player)
	if player:IsFriendsWith(146569) then
		print(player.Name .. " is friends with gordonrox24!")
	end
end)
		
				Copy Code
			
				Light Theme

IsFriendsWith

Parameters

userId

Returns

bool

Code Samples

How to Check if a Player is a Friend