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.
For thread safety, this property is not safe to read in an unsynchronized thread.
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
A boolean indicating whether a player is a friend of the specified user.
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.