1. Epic GamesDeveloper
  3. USocialManager

USocialManager

Singleton manager at the top of the social framework

API > API/Plugins > API/Plugins/Party

Inheritance Hierarchy

References

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

Syntax

UCLASS (Within=GameInstance, Config=Game)  
class USocialManager :  
    public UObject ,  
    public FExec

Remarks

Singleton manager at the top of the social framework

Variables

  Type Name Description
Protected variable bool bShutdownPending Set during shutdown, used to early-out of lingering OnlineSubsystem callbacks that are pending.
Protected variable TMap< FOnlinePartyTypeId, FJoinPartyAttempt > JoinAttemptsByTypeId  
Protected variable TArray< FUniqueNetIdRef > MemberIds  
Public variable USocialManager::FOnPartyMembershipChanged & OnSocialToolkitDestroyed  
Protected variable FName OriginalJoinMethod  
Protected variable TSharedRef< const FOnlinePartyId > PartyId  
Protected variable PRAGMA_DISABLE_DEPRECATION_WARNINGSTSharedPtr< FRejoinableParty > RejoinableParty Info on the persistent party we were in when losing connection to the party service and want to rejoin when it returns
Protected variable TSubclassOf< USocialToolkit > ToolkitClass The desired type of SocialToolkit to create for each local player

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static void  
Protected function Virtual Const bool  
Public function void

CreateParty ( const FOnlinePartyTypeId& PartyTypeId,
const FPartyConfiguration& PartyConfig,
const FOnCreatePartyAttemptComplete& OnCreatePartyComplete
)

  
Public function void

CreatePersistentParty ( const FOnCreatePartyAttemptComplete& OnCreatePartyComplete
)

  
Protected function Virtual Const void

FillOutJoinRequestData ( const FOnlinePartyId& TargetParty,
FOnlinePartyData& OutJoinRequestData
)

 Gives child classes a chance to append any additional data to a join request that's about to be sent to another party.
Protected function Virtual Const ECrossplayPreference Up to the game to decide whether it wants to allow crossplay (generally based on a user setting of some kind)
Public function Const USocialDebugTools *  
Public function Static const TArray< ESocialSubsystem > &  
Public function Const FUniqueNetIdRepl  
Public function Const int32  
Public function Const USocialToolkit *  
Public function Const const FJoinPartyAttempt *  
Public function Static FUserPlatform  
Public function Const PartyT *

GetParty ( const FOnlinePartyId& PartyId
)

  
Public function Const PartyT *

GetParty ( const FOnlinePartyTypeId& PartyTypeId
)

  
Protected function Virtual Const TSubclassOf< USocialParty >

GetPartyClassForType ( const FOnlinePartyTypeId& PartyTypeId
)

  
Public function Const PartyT *  
Protected function Const USocialParty *

GetPersistentPartyInternal ( bool bEvenIfLeaving
)

  
Public function Static const TArray< FSocialInteractionHandle > &  
Protected function Virtual Const TSubclassOf< USocialDebugTools >  
Public function Static IOnlineSubsystem *

GetSocialOss ( UWorld* World,
ESocialSubsystem SubsystemType
)

  
Public function Static FName  
Public function Static FText  
Public function Const USocialToolkit &

GetSocialToolkit ( const ULocalPlayer& LocalPlayer
)

  
Public function Const USocialToolkit *

GetSocialToolkit ( int32 LocalPlayerNum
)

  
Public function Const USocialToolkit *

GetSocialToolkit ( FUniqueNetIdRepl LocalUserId
)

  
Public function void  
Protected function void  
Protected function Virtual void

HandleQueryJoinabilityComplete ( const FUniqueNetId& LocalUserId,
const FOnlinePartyId& PartyId,
const FQueryPartyJoinabilityResult& Result,
FOnlinePartyTypeId PartyTypeId
)

  
Public function Virtual void Initializes the manager - call this right after creating the manager object during GameInstance initialization.
Public function Const bool  
Public function Const bool

IsLocalUser ( const FUniqueNetIdRepl& LocalUserId,
ESocialSubsystem SubsystemType
)

  
Public function Const bool  
Public function Const bool  
Public function Static bool FExec.
Protected function void

JoinParty ( const USocialUser& UserToJoin,
const FOnlinePartyTypeId& PartyTypeId,
const FOnJoinPartyAttemptComplete& OnJoinPartyComplete,
const FName& JoinMethod
)

  
Public function Virtual void  
Protected function Virtual void

OnJoinPartyAttemptCompleteInternal ( const FJoinPartyAttempt& JoinAttemptInfo,
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) {}
Public function Const FOnPartyMembershipChanged &  
Protected function Virtual void  
Public function Const USocialManager::FOnSocialToolkitCreated TBaseMulticastDelegate_OneParam  
Public function Const USocialManager::FOnSocialToolkitDestroyed TBaseMulticastDelegate_OneParam Event triggered when a social toolkit is destroyed.
Protected function Virtual void  
Protected function void  
Protected function void  
Public function void

RegisterSecondaryPlayer ( int32 LocalPlayerNum,
const FOnJoinPartyComplete& Delegate
)

 Makes an attempt for the target local player to join the primary local player's party
Protected function Virtual void  
Public function void  
Protected function Virtual Const PRAGMA_DISABLE_DEPRECATION_WARNINGS bool

ShouldTryRejoiningPersistentParty ( const FRejoinableParty& InRejoinableParty
)

  
Public function Virtual void  
Protected function Virtual Const FJoinPartyResult

ValidateJoinAttempt ( const FOnlinePartyTypeId& PartyTypeId
)

 Validate that we are clear to try joining a party of the given type. If not, gives the reason why.
Public function Virtual Const FJoinPartyResult

ValidateJoinTarget ( const USocialUser& UserToJoin,
const FOnlinePartyTypeId& PartyTypeId
)

 Validates that the target user has valid join info for us to use and that we can join any party of the given type

Classes

  Type Name Description
Public struct FJoinPartyAttempt    
Public class FOnPartyMembershipChanged    
Public class FOnSocialToolkitCreated    
Public class FOnSocialToolkitDestroyed    

Typedefs

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

Constants

Name Description
DefaultSubsystems  
RegisteredInteractions  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page