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.
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.
Using this in a
Script, as opposed to a
LocalScript, will not get you the most up-to-date information. If a player leaves a group while they are in the game, it will still think they’re in that group until they leave. However, this does not happen when used with a LocalScript.
This is because the method caches results, so multiple calls of the function on the same player with the same userId will yield the same result as when the method was first called with the given userId.
articles/Creating-VIP-Doors|Creating VIP Doors
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.