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

> Unreal Engine API Reference > Plugins > Party > USocialToolkit

Light Theme

Dark Theme

USocialToolkit

Represents the full suite of social functionality available to a given LocalPlayer

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USocialToolkit

References

Module	Party
Header	/Engine/Plugins/Online/OnlineFramework/Source/Party/Public/SocialToolkit.h
Include	#include "SocialToolkit.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Within=SocialManager)
class USocialToolkit :
public UObject,
public FExec

Remarks

Represents the full suite of social functionality available to a given LocalPlayer

Variables

	Name	Description
bool	bQueryBlockedPlayersOnStartup
bool	bQueryFriendsOnStartup	Something nicer is definitely possible and worth revisiting.
bool	bQueryRecentPlayersOnStartup
TSubclassOf< US...	ChatManagerClass	Class to use when creating the ChatManager
FString	FriendListToQuery	The name of the friends list to query
FString	RecentPlayerNamespaceToQuery	The name of the recent player namespace to query
TSubclassOf< US...	SocialUserClass	The type of SocialUser to create to represent known users

Constructors

	Name	Description
	USocialToolkit()

Functions

	Name	Description
bool	AcceptFriendInvite ( const USocialUser& SocialUser, ESocialSubsystem SubsystemType )
void	AddLocalUserOnlineProperties ( FPresenceProperties OnlinePropertie... )
TSharedRef< ...	CreateUserList ( const FSocialUserListConfig& ListC... )
bool	Debug_IsRandomlyChangingPresence()
USocialUser ...	FindUser ( const FUniqueNetIdRepl& UserId )	Finds a SocialUser given a unique net ID from any OSS
const TArray...	GetAllUsers()
bool	GetAuthAttribute ( ESocialSubsystem SubsystemType, const FString& AttributeKey, FString& OutValue )
USocialChatM...	GetChatManager()
TSubclassOf<...	GetChatManagerClass()
USocialUser ...	GetLocalUser()
FUniqueNetId...	GetLocalUserNetId ( ESocialSubsystem SubsystemType )
int32	GetLocalUserNum()
ULocalPlayer...	GetOwningLocalPlayer()
const FOnlin...	GetPresenceInfo ( ESocialSubsystem SubsystemType )
const FStrin...	GetRecentPlayerNamespaceToQuery()
USocialManag...	GetSocialManager()
IOnlineSubsy...	GetSocialOss ( ESocialSubsystem SubsystemType )
ToolkitT ...	GetToolkitForPlayer ( const ULocalPlayer* LocalPlaye... )
void	HandleUserInvalidated ( USocialUser& InvalidUser )
void	InitializeToolkit ( ULocalPlayer& InOwningLocalPlayer )
bool	IsFriendshipRestricted ( const USocialUser& SocialUser, ESocialSubsystem SubsystemType )
bool	IsOwnerLoggedIn()
void	NotifySubsystemIdEstablished ( USocialUser& SocialUser, ESocialSubsystem SubsystemType, const FUniqueNetIdRepl& SubsystemI... )
void	OnAcceptFriendInviteComplete ( const FUniqueNetId& InviterUserId, bool bInviteSucceeded, const FString& InviteError )
void	OnBlockPlayerComplete ( int32 LocalUserNum, bool bWasSuccessful, const FUniqueNetId& BlockedPlayerI..., const FString& ListName, const FString& ErrorStr, ESocialSubsystem SubsystemType )
void	OnDeleteFriendComplete ( int32 LocalPlayer, bool bWasSuccessful, const FUniqueNetId& FormerFriendId, const FString& ListName, const FString& ErrorStr, ESocialSubsystem SubsystemType )
FFriendInvit...	OnFriendInviteReceived()
FFriendInvit...	OnFriendInviteSent()
FOnRelations...	OnFriendshipEstablished()
FOnKnownUser...	OnKnownUserInitialized()
void	OnOwnerLoggedIn()
void	OnOwnerLoggedOut()
FPartyInvite...	OnPartyInviteReceived()
void	OnQueryBlockedPlayersComplete ( const FUniqueNetId& UserId, bool bWasSuccessful, const FString& ErrorStr, ESocialSubsystem SubsystemType )
void	OnQueryBlockedPlayersSuccess ( ESocialSubsystem SubsystemType, const TArray< TSharedRef< FOnlineBl... )
void	OnQueryFriendsListSuccess ( ESocialSubsystem SubsystemType, const TArray< TSharedRef< FOnlineFr... )
void	OnQueryRecentPlayersComplete ( const FUniqueNetId& UserId, const FString& Namespace, bool bWasSuccessful, const FString& ErrorStr, ESocialSubsystem SubsystemType )
void	OnQueryRecentPlayersSuccess ( ESocialSubsystem SubsystemType, const TArray< TSharedRef< FOnlineRe... )
void	OnReadFriendsListComplete ( int32 LocalUserNum, bool bWasSuccessful, const FString& ListName, const FString& ErrorStr, ESocialSubsystem SubsystemType )
FOnRelations...	OnRecentPlayerAdded()
void	OnSendFriendInviteComplete ( const FUniqueNetId& InvitedUserId, const FString& InviteeName, bool bInviteSuceeded, const FString& InviteError )
FOnSocialUse...	OnSocialUserInvalidated()
FBasicToolki...	OnToolkitReset()
void	OnUnblockPlayerComplete ( int32 LocalUserNum, bool bWasSuccessful, const FUniqueNetId& UnblockedPlaye..., const FString& ListName, const FString& ErrorStr, ESocialSubsystem SubsystemType )
FOnRelations...	OnUserBlocked()
void	QueryBlockedPlayers()
void	QueryFriendsLists()
void	QueryRecentPlayers()
void	QueueUserDependentAction ( const FUniqueNetIdRepl& SubsystemI..., FUserDependentAction UserActionDele... )	Queues an action to be executed when a USocialUser corresponding to the given UniqueId has been established.
void	QueueUserDependentAction ( const FUniqueNetIdRepl& UserId, TFunction< void&)>&& ..., bool bExecutePostInit )	Queues an action to be executed when a USocialUser corresponding to the given UniqueId has been established.
void	SetLocalUserOnlineState ( EOnlinePresenceState::Type OnlineSt... )
void	TrySendFriendInvite ( const FString& DisplayNameOrEmail )	Attempts to send a friend invite to another user based on display name or email.
bool	TrySendFriendInvite ( USocialUser& SocialUser, ESocialSubsystem SubsystemType )

Overridden from FExec

		Name	Description
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Out )	FExec.

Classes

	Name	Description
	FBasicToolkitEvent
	FFriendInviteEvent
	FOnKnownUserInitialized
	FOnRelationshipEstablished
	FOnSocialUserInvalidated
	FPartyInviteEvent

Constants

Name	Description
AllToolkitsByOwningPlayer

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

Take our survey

Dismiss