Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

IOnlineFriends::IsFriend

Checks that a unique player id is part of the specified user's friends list

Windows

MacOS

Linux

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineFriendsInterface.h
Include	#include "Interfaces/OnlineFriendsInterface.h"

Syntax

bool IsFriend
(
    int32 LocalUserNum,
    const FUniqueNetId & FriendId,
    const FString & ListName
)

Remarks

Checks that a unique player id is part of the specified user's friends list

Returns

true if friends list was found and the friend was valid

Parameters

Parameter	Description
LocalUserNum	the controller number of the associated user that made the request
FriendId	the id of the player being checked for friendship
ListName	name of the friends list to read

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss