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 > USocialManager

Light Theme

Dark Theme

USocialManager

Singleton manager at the top of the social framework

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USocialManager

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Within=GameInstance, Config=Game)
class USocialManager :
public UObject,
public FExec

Remarks

Singleton manager at the top of the social framework

Variables

	Name	Description
bool	bShutdownPending	Set during shutdown, used to early-out of lingering OnlineSubsystem callbacks that are pending.
USocialManager:...	OnSocialToolkitCreated
TSharedPtr< FRe...	RejoinableParty	Info on the persistent party we were in when losing connection to the party service and want to rejoin when it returns
TSubclassOf< US...	ToolkitClass	The desired type of SocialToolkit to create for each local player

Constructors

	Name	Description
	USocialManager()

Functions

	Name	Description
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
bool	CanCreateNewPartyObjects()
void	CreateParty ( const FOnlinePartyTypeId& PartyTyp..., const FPartyConfiguration& PartyCo..., const FOnCreatePartyAttemptComplete... )
void	CreatePersistentParty ( const FOnCreatePartyAttemptComplete... )
void	FillOutJoinRequestData ( const FOnlinePartyId& TargetParty, FOnlinePartyData& OutJoinRequestDa... )	Gives child classes a chance to append any additional data to a join request that's about to be sent to another party.
ECrossplayPr...	GetCrossplayPreference()	Up to the game to decide whether it wants to allow crossplay (generally based on a user setting of some kind)
USocialDebug...	GetDebugTools()
const TArray...	GetDefaultSubsystems()
FUniqueNetId...	GetFirstLocalUserId ( ESocialSubsystem SubsystemType )
int32	GetFirstLocalUserNum()
USocialToolk...	GetFirstLocalUserToolkit()
const FJoinP...	GetJoinAttemptInProgress ( const FOnlinePartyTypeId& PartyTyp... )
FUserPlatfor...	GetLocalUserPlatform()
PartyT *	GetParty ( const FOnlinePartyId& PartyId )
PartyT *	GetParty ( const FOnlinePartyTypeId& PartyTyp... )
TSubclassOf<...	GetPartyClassForType ( const FOnlinePartyTypeId& PartyTyp... )
PartyT *	GetPersistentParty()
USocialParty...	GetPersistentPartyInternal ( bool bEvenIfLeaving )
const TArray...	GetRegisteredInteractions()
TSubclassOf<...	GetSocialDebugToolsClass()
IOnlineSubsy...	GetSocialOss ( UWorld* World, ESocialSubsystem SubsystemType )
FName	GetSocialOssName ( ESocialSubsystem SubsystemType )
FText	GetSocialOssPlatformName ( ESocialSubsystem SubsystemType )
USocialToolk...	GetSocialToolkit ( const ULocalPlayer& LocalPlayer )
USocialToolk...	GetSocialToolkit ( int32 LocalPlayerNum )
USocialToolk...	GetSocialToolkit ( FUniqueNetIdRepl LocalUserId )
void	HandlePartyDisconnected ( USocialParty* LeavingParty )
void	HandlePlatformSessionInviteAccepted ( const FUniqueNetIdRef& LocalUserId, const FOnlineSessionSearchResult& ... )
void	HandleQueryJoinabilityComplete ( const FUniqueNetId& LocalUserId, const FOnlinePartyId& PartyId, const FQueryPartyJoinabilityResult ..., FOnlinePartyTypeId PartyTypeId )
void	InitSocialManager()	Initializes the manager - call this right after creating the manager object during GameInstance initialization.
bool	IsConnectedToPartyService()
bool	IsLocalUser ( const FUniqueNetIdRepl& LocalUserI..., ESocialSubsystem SubsystemType )
bool	IsPartyJoinInProgress ( const FOnlinePartyTypeId& TypeId )
bool	IsPersistentPartyJoinInProgress()
bool	IsSocialSubsystemEnabled ( ESocialSubsystem SubsystemType )
void	JoinParty ( const USocialUser& UserToJoin, const FOnlinePartyTypeId& PartyTyp..., const FOnJoinPartyAttemptComplete&... )
void	NotifyPartyInitialized ( USocialParty& Party )
void	OnJoinPartyAttemptCompleteInternal ( const FJoinPartyAttempt& JoinAttem..., const FJoinPartyResult& Result )	Virtual void OnCreatePartyComplete(const TSharedPtr& PartyId, ECreatePartyCompletionResult Result, FOnlinePartyTypeId PartyTypeId) {} virtual void OnQueryJoinabilityComplete(const FOnlinePartyId& PartyId, EJoinPartyCompletionResult Result, int32 DeniedResultCode, FOnlinePartyTypeId PartyTypeId) {}
FOnPartyMemb...	OnPartyJoined()
void	OnPartyLeftInternal ( USocialParty& LeftParty, EMemberExitedReason Reason )
USocialManag...	OnSocialToolkitCreated()
void	OnToolkitCreatedInternal ( USocialToolkit& NewToolkit )
void	RefreshCanCreatePartyObjects()
void	RegisterInteraction()
void	RegisterSecondaryPlayer ( int32 LocalPlayerNum, const FOnJoinPartyComplete& Delega... )	Makes an attempt for the target local player to join the primary local player's party
void	RegisterSocialInteractions()
void	RestorePartyStateFromPartySystem ( const FOnRestorePartyStateFromParty... )
bool	ShouldTryRejoiningPersistentParty ( const FRejoinableParty& InRejoinab... )
void	ShutdownSocialManager()
FJoinPartyRe...	ValidateJoinAttempt ( const FOnlinePartyTypeId& PartyTyp... )	Validate that we are clear to try joining a party of the given type. If not, gives the reason why.
FJoinPartyRe...	ValidateJoinTarget ( const USocialUser& UserToJoin, const FOnlinePartyTypeId& PartyTyp... )	Validates that the target user has valid join info for us to use and that we can join any party of the given type

Overridden from FExec

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

Classes

	Name	Description
	FJoinPartyAttempt
	FOnPartyMembershipChanged
	FOnSocialToolkitCreated
	FRejoinableParty

Typedefs

Name	Description
FOnCreatePartyAttemptComplete
FOnJoinPartyAttemptComplete
FOnRestorePartyStateFromPartySystemComplete	Attempt to restore our party state from the party system

Constants

Name	Description
AllManagersByGameInstance
DefaultSubsystems
RegisteredInteractions

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

Take our survey

Dismiss