Skip to main content
Version: 4.24

Online Friends Subsystem

This API reference documents what methods and events are supported by Online Subsystem Blueprints. For full documentation on this API, refer to the Unreal Engine documentation.

Need to use a method or event that's not currently supported? Please reach out to support.

Supported Events#

EventSupported?Unreal Engine DocsParameters
OnFriendsChange✔Details
OnOutgoingInviteSent✔Details
OnInviteReceived✔Detailsconst FUniqueNetId& UserId
const FUniqueNetId& FriendId
OnInviteAccepted✔Detailsconst FUniqueNetId& UserId
const FUniqueNetId& FriendId
OnInviteRejected✔Detailsconst FUniqueNetId& UserId
const FUniqueNetId& FriendId
OnInviteAborted✔Detailsconst FUniqueNetId& UserId
const FUniqueNetId& FriendId
OnFriendRemoved✔Detailsconst FUniqueNetId& UserId
const FUniqueNetId& FriendId
OnRejectInviteComplete✔Detailsbool bWasSuccessful
const FUniqueNetId& FriendId
const FString& ListName
const FString& ErrorStr
OnDeleteFriendComplete✔Detailsbool bWasSuccessful
const FUniqueNetId& FriendId
const FString& ListName
const FString& ErrorStr
OnBlockedPlayerComplete✔Detailsbool bWasSuccessful
const FUniqueNetId& UniqueId
const FString& ListName
const FString& ErrorStr
OnUnblockedPlayerComplete✔Detailsbool bWasSuccessful
const FUniqueNetId& UniqueId
const FString& ListName
const FString& ErrorStr
OnBlockListChange✔Detailsconst FString& ListName
OnQueryRecentPlayersComplete✔Detailsconst FUniqueNetId& UserId
const FString& Namespace
bool bWasSuccessful
const FString& Error
OnQueryBlockedPlayersComplete✔Detailsconst FUniqueNetId& UserId
bool bWasSuccessful
const FString& Error
OnRecentPlayersAdded✔Detailsconst FUniqueNetId& UserId
const TArray<TSharedRef<FOnlineRecentPlayer>>& AddedPlayers

Supported Functions#

FunctionSupported?Unreal Engine DocsParameters
ReadFriendsList✔ 🕔Detailsint32 LocalUserNum
const FString& ListName
DeleteFriendsList✔ 🕔Detailsint32 LocalUserNum
const FString& ListName
SendInvite✔ 🕔Detailsint32 LocalUserNum
const FUniqueNetId& FriendId
const FString& ListName
AcceptInvite✔ 🕔Detailsint32 LocalUserNum
const FUniqueNetId& FriendId
const FString& ListName
RejectInvite✔Detailsint32 LocalUserNum
const FUniqueNetId& FriendId
const FString& ListName
SetFriendAlias✔ 🕔Detailsint32 LocalUserNum
const FUniqueNetId& FriendId
const FString& ListName
const FString& Alias
DeleteFriend✔Detailsint32 LocalUserNum
const FUniqueNetId& FriendId
const FString& ListName
GetFriendsList✔Detailsint32 LocalUserNum
const FString& ListName
TArray<TSharedRef<FOnlineFriend>>& OutFriends
GetFriend✔Detailsint32 LocalUserNum
const FUniqueNetId& FriendId
const FString& ListName
IsFriend✔Detailsint32 LocalUserNum
const FUniqueNetId& FriendId
const FString& ListName
AddRecentPlayers✔ 🕔Detailsconst FUniqueNetId& UserId
const TArray<FReportPlayedWithUser>& InRecentPlayers
const FString& ListName
QueryRecentPlayers✔Detailsconst FUniqueNetId& UserId
const FString& Namespace
GetRecentPlayers✔Detailsconst FUniqueNetId& UserId
const FString& Namespace
TArray<TSharedRef<FOnlineRecentPlayer>>& OutRecentPlayers
DumpRecentPlayers✔Details
BlockPlayer✔Detailsint32 LocalUserNum
const FUniqueNetId& PlayerId
UnblockPlayer✔Detailsint32 LocalUserNum
const FUniqueNetId& PlayerId
QueryBlockedPlayers✔Detailsconst FUniqueNetId& UserId
GetBlockedPlayers✔Detailsconst FUniqueNetId& UserId
TArray<TSharedRef<FOnlineBlockedPlayer>>& OutBlockedPlayers
DumpBlockedPlayers✔Details
QueryFriendSettings✔ 🕔Detailsconst FUniqueNetId& LocalUserId
UpdateFriendSettings✔ 🕔Detailsconst FUniqueNetId& LocalUserId
const FFriendSettings& NewSettings
QueryFriendSettings〰Detailsconst FUniqueNetId& UserId
const FString& Source
GetFriendSettings✔Detailsconst FUniqueNetId& UserId
TMap<FString, TSharedRef<FOnlineFriendSettingsSourceData>>& OutSettings
SetFriendSettings✔ 🕔Detailsconst FUniqueNetId& UserId
const FString& Source
bool bNeverShowAgain