className: FOnPlatformDataSessionIdChanged

code: typedef TMulticastDelegate_OneParam< void, [PlatformDataSessionIdArgType](API\Plugins\Party\Party\FPartyMemberRepData\PlatformDataSessionIdArgType) > FOnPlatformDataSessionIdChanged


className: FOnPlatformDataUniqueIdChanged

description: Bummer to have two signatures, but cases that want both the old and new values are much rarer, so most don't want to bother with a handler that takes an extra unused param

module: Party

code: typedef TMulticastDelegate_OneParam< void, [PlatformDataUniqueIdArgType](API\Plugins\Party\Party\FPartyMemberRepData\PlatformDataUniqueIdArgType) > FOnPlatformDataUniqueIdChanged


code: virtual const [USocialParty](API\Plugins\Party\Party\USocialParty) * GetOwnerParty() const


code: virtual const [UPartyMember](API\Plugins\Party\Party\UPartyMember) * GetOwningMember() const


className: JoinInProgressDataResponsesArgType

code: typedef typename [TChooseClass](API\Runtime\Core\Templates\TChooseClass)< [TOr](API\Runtime\Core\Templates\TOr)< [TIsPODType](API\Runtime\Core\Math\TIsPODType)< [TArray](API\Runtime\Core\Containers\TArray)< [FPartyMemberJoinInProgressResponse](API\Plugins\Party\Party\FPartyMemberJoinInProgressRespon-) > >, [TIsPointer](API\Runtime\Core\Templates\TIsPointer)< [TArray](API\Runtime\Core\Containers\TArray)< [FPartyMemberJoinInProgressResponse](API\Plugins\Party\Party\FPartyMemberJoinInProgressRespon-) > >>::Value, [TArray](API\Runtime\Core\Containers\TArray)< [FPartyMemberJoinInProgressResponse](API\Plugins\Party\Party\FPartyMemberJoinInProgressRespon-) >, const [MutableJoinInProgressDataResponsesType](API\Plugins\Party\Party\FPartyMemberRepData\MutableJoinInPro-) & >::Result JoinInProgressDataResponsesArgType


className: JoinMethodArgType

code: typedef typename [TChooseClass](API\Runtime\Core\Templates\TChooseClass)< [TOr](API\Runtime\Core\Templates\TOr)< [TIsPODType](API\Runtime\Core\Math\TIsPODType)< [FString](API\Runtime\Core\Containers\FString) >, [TIsPointer](API\Runtime\Core\Templates\TIsPointer)< [FString](API\Runtime\Core\Containers\FString) >>::Value, [FString](API\Runtime\Core\Containers\FString), const [MutableJoinMethodType](API\Plugins\Party\Party\FPartyMemberRepData\MutableJoinMethodType) & >::Result JoinMethodArgType


description: Mark the party data as ownerless. This will bypass any "CanEdit" checks. Useful for using this object in a test context.

code: void MarkOwnerless()


className: MutableCrossplayPreferenceType

description: If the property is a POD or ptr type, we'll work with it by copy. Otherwise, by const ref

code: typedef std::remove_const_t< [ECrossplayPreference](API\Plugins\Party\ECrossplayPreference) > MutableCrossplayPreferenceType


className: MutableJoinInProgressDataResponsesType

code: typedef std::remove_const_t< [TArray](API\Runtime\Core\Containers\TArray)< [FPartyMemberJoinInProgressResponse](API\Plugins\Party\Party\FPartyMemberJoinInProgressRespon-) > > MutableJoinInProgressDataResponsesType


className: MutableJoinInProgressDataRequestType


className: MutableJoinMethodType

code: typedef std::remove_const_t< [FString](API\Runtime\Core\Containers\FString) > MutableJoinMethodType


className: MutablePlatformDataPlatformType

code: typedef std::remove_const_t< [FUserPlatform](API\Plugins\Party\FUserPlatform) > MutablePlatformDataPlatformType


className: MutablePlatformDataSessionIdType

code: typedef std::remove_const_t< [FSessionId](API\Plugins\Party\Party\FSessionId) > MutablePlatformDataSessionIdType


className: MutablePlatformDataUniqueIdType

code: typedef std::remove_const_t< [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) > MutablePlatformDataUniqueIdType


description: Bind to receive the new property value only on changes

code: FOnCrossplayPreferenceChanged & OnCrossplayPreferenceChanged() const


description: Bind to receive both the new and old property value on changes

code: FOnCrossplayPreferenceChangedDif & OnCrossplayPreferenceChangedDif() const


code: FOnJoinInProgressDataResponsesChangedDif & OnJoinInProgressDataResponsesChangedDif() const


code: FOnJoinInProgressDataRequestChanged & OnJoinInProgressDataRequestChanged() const


code: FOnJoinInProgressDataRequestChangedDif & OnJoinInProgressDataRequestChangedDif() const


code: FOnJoinInProgressDataResponsesChanged & OnJoinInProgressDataResponsesChanged() const


code: FOnJoinMethodChanged & OnJoinMethodChanged() const


code: FOnJoinMethodChangedDif & OnJoinMethodChangedDif() const


code: FOnPlatformDataPlatformChanged & OnPlatformChanged() const


code: FOnPlatformDataPlatformChanged & OnPlatformDataPlatformChanged() const


code: FOnPlatformDataPlatformChangedDif & OnPlatformChangedDif() const


code: FOnPlatformDataPlatformChangedDif & OnPlatformDataPlatformChangedDif() const


code: FOnPlatformDataSessionIdChanged & OnPlatformDataSessionIdChanged() const


code: FOnPlatformDataSessionIdChangedDif & OnPlatformDataSessionIdChangedDif() const


code: FOnPlatformDataUniqueIdChanged & OnPlatformDataUniqueIdChanged() const


code: FOnPlatformDataUniqueIdChangedDif & OnPlatformDataUniqueIdChangedDif() const


code: FOnPlatformDataSessionIdChanged & OnPlatformSessionIdChanged() const


code: FOnPlatformDataSessionIdChangedDif & OnPlatformSessionIdChangedDif() const


code: FOnPlatformDataUniqueIdChanged & OnPlatformUniqueIdChanged() const


code: FOnPlatformDataUniqueIdChangedDif & OnPlatformUniqueIdChangedDif() const


className: PlatformDataPlatformArgType

code: typedef typename [TChooseClass](API\Runtime\Core\Templates\TChooseClass)< [TOr](API\Runtime\Core\Templates\TOr)< [TIsPODType](API\Runtime\Core\Math\TIsPODType)< [FUserPlatform](API\Plugins\Party\FUserPlatform) >, [TIsPointer](API\Runtime\Core\Templates\TIsPointer)< [FUserPlatform](API\Plugins\Party\FUserPlatform) >>::Value, [FUserPlatform](API\Plugins\Party\FUserPlatform), const [MutablePlatformDataPlatformType](API\Plugins\Party\Party\FPartyMemberRepData\MutablePlatformDataPlatformType) & >::Result PlatformDataPlatformArgType


className: PlatformDataSessionIdArgType

code: typedef typename [TChooseClass](API\Runtime\Core\Templates\TChooseClass)< [TOr](API\Runtime\Core\Templates\TOr)< [TIsPODType](API\Runtime\Core\Math\TIsPODType)< [FSessionId](API\Plugins\Party\Party\FSessionId) >, [TIsPointer](API\Runtime\Core\Templates\TIsPointer)< [FSessionId](API\Plugins\Party\Party\FSessionId) >>::Value, [FSessionId](API\Plugins\Party\Party\FSessionId), const [MutablePlatformDataSessionIdType](API\Plugins\Party\Party\FPartyMemberRepData\MutablePlatformDataSessionIdType) & >::Result PlatformDataSessionIdArgType


className: PlatformDataUniqueIdArgType

code: typedef typename [TChooseClass](API\Runtime\Core\Templates\TChooseClass)< [TOr](API\Runtime\Core\Templates\TOr)< [TIsPODType](API\Runtime\Core\Math\TIsPODType)< [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) >, [TIsPointer](API\Runtime\Core\Templates\TIsPointer)< [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) >>::Value, [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl), const [MutablePlatformDataUniqueIdType](API\Plugins\Party\Party\FPartyMemberRepData\MutablePlatformDataUniqueIdType) & >::Result PlatformDataUniqueIdArgType


code: void SetCrossplayPreference ( [CrossplayPreferenceArgType](API\Plugins\Party\Party\FPartyMemberRepData\CrossplayPreferenceArgType) NewCrossplayPreference )


code: void SetJoinInProgressDataRequest ( [JoinInProgressDataRequestArgType](API\Plugins\Party\Party\FPartyMemberRepData\JoinInProgressDataRequestArgType) NewJoinInProgressDataRequest )


code: void SetJoinMethod ( [JoinMethodArgType](API\Plugins\Party\Party\FPartyMemberRepData\JoinMethodArgType) NewJoinMethod )


code: virtual void SetOwningMember ( const class [UPartyMember](API\Plugins\Party\Party\UPartyMember) & InOwnerMember )


code: void SetPlatform ( [PlatformDataPlatformArgType](API\Plugins\Party\Party\FPartyMemberRepData\PlatformDataPlatformArgType) NewPlatformDataPlatform )


code: void SetPlatformDataPlatform ( [PlatformDataPlatformArgType](API\Plugins\Party\Party\FPartyMemberRepData\PlatformDataPlatformArgType) NewPlatformDataPlatform )


code: void SetPlatformDataSessionId ( [PlatformDataSessionIdArgType](API\Plugins\Party\Party\FPartyMemberRepData\PlatformDataSessionIdArgType) NewPlatformDataSessionId )


code: void SetPlatformDataUniqueId ( [PlatformDataUniqueIdArgType](API\Plugins\Party\Party\FPartyMemberRepData\PlatformDataUniqueIdArgType) NewPlatformDataUniqueId )


code: void SetPlatformSessionId ( [PlatformDataSessionIdArgType](API\Plugins\Party\Party\FPartyMemberRepData\PlatformDataSessionIdArgType) NewPlatformDataSessionId )


code: void SetJoinInProgressDataResponses ( [JoinInProgressDataResponsesArgType](API\Plugins\Party\Party\FPartyMemberRepData\JoinInProgressDataResponsesArgTy-) NewJoinInProgressDataResponses )


code: void SetPlatformUniqueId ( [PlatformDataUniqueIdArgType](API\Plugins\Party\Party\FPartyMemberRepData\PlatformDataUniqueIdArgType) NewPlatformDataUniqueId )


className: FPartyMemberRepData

description: Base struct used to replicate data about the state of a single party member to all members.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FPartyMemberRepData : public [FOnlinePartyRepDataBase](API\Plugins\Party\Party\FOnlinePartyRepDataBase)


code: bool IsInSession ( const [UPartyMember](API\Plugins\Party\Party\UPartyMember) & PartyMember ) const


code: bool IsSessionOwner ( const [UPartyMember](API\Plugins\Party\Party\UPartyMember) & PartyMember ) const


code: bool operator== ( const [FString](API\Runtime\Core\Containers\FString) & InSessionType ) const


code: bool operator== ( const [FPartyPlatformSessionInfo](API\Plugins\Party\Party\FPartyPlatformSessionInfo) & Other ) const


code: bool operator!= ( const [FPartyPlatformSessionInfo](API\Plugins\Party\Party\FPartyPlatformSessionInfo) & Other ) const


className: FPartyPlatformSessionInfo

OwnerPrimaryId

type: FUniqueNetIdRep...

description: Primary OSS ID of the player that owns this console session

SessionId

type: FString

description: The platform session id. Will be unset if it is not yet available to be joined.

SessionType

description: The platform session type (because in a crossplay party, members can be in different session types)


code: bool operator== ( const [FPartyPrivacySettings](API\Plugins\Party\Party\FPartyPrivacySettings) & Other ) const


code: bool operator!= ( const [FPartyPrivacySettings](API\Plugins\Party\Party\FPartyPrivacySettings) & Other ) const


className: FPartyPrivacySettings

bOnlyLeaderFriendsCanJoin

type: bool

description: True to restrict the party exclusively to friends of the party leader

PartyInviteRestriction

type: EPartyInviteRes...

description: Who is allowed to send invitataions to the party?

PartyType

type: EPartyType

description: The type of party in terms of advertised joinability restrictions


code: void ClearPlatformSessionInfo ( const [FString](API\Runtime\Core\Containers\FString) & SessionType )


description: FPartyRepData::CompareAgainstfor an example

code: virtual void CompareAgainst ( const [FOnlinePartyRepDataBase](API\Plugins\Party\Party\FOnlinePartyRepDataBase) & OldData ) const


className: FOnPrivacySettingsChanged

code: typedef TMulticastDelegate_OneParam< void, [PrivacySettingsArgType](API\Plugins\Party\Party\FPartyRepData\PrivacySettingsArgType) > FOnPrivacySettingsChanged


code: const [FPartyPlatformSessionInfo](API\Plugins\Party\Party\FPartyPlatformSessionInfo) * FindSessionInfo ( const [FString](API\Runtime\Core\Containers\FString) & SessionType ) const


code: virtual const [USocialParty](API\Plugins\Party\Party\USocialParty) * GetOwnerParty() const


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FPartyPlatformSessionInfo](API\Plugins\Party\Party\FPartyPlatformSessionInfo) > & GetPlatformSessions() const


code: void MarkOwnerless()


className: MutablePrivacySettingsType

code: typedef std::remove_const_t< [FPartyPrivacySettings](API\Plugins\Party\Party\FPartyPrivacySettings) > MutablePrivacySettingsType


code: FSimpleMulticastDelegate & OnPlatformSessionsChanged() const


code: FOnPrivacySettingsChanged & OnPrivacySettingsChanged() const


code: FOnPrivacySettingsChangedDif & OnPrivacySettingsChangedDif() const


code: virtual void SetOwningParty ( const class [USocialParty](API\Plugins\Party\Party\USocialParty) & InOwnerParty )


className: PrivacySettingsArgType

code: typedef typename [TChooseClass](API\Runtime\Core\Templates\TChooseClass)< [TOr](API\Runtime\Core\Templates\TOr)< [TIsPODType](API\Runtime\Core\Math\TIsPODType)< [FPartyPrivacySettings](API\Plugins\Party\Party\FPartyPrivacySettings) >, [TIsPointer](API\Runtime\Core\Templates\TIsPointer)< [FPartyPrivacySettings](API\Plugins\Party\Party\FPartyPrivacySettings) >>::Value, [FPartyPrivacySettings](API\Plugins\Party\Party\FPartyPrivacySettings), const [MutablePrivacySettingsType](API\Plugins\Party\Party\FPartyRepData\MutablePrivacySettingsType) & >::Result PrivacySettingsArgType


code: void SetPrivacySettings ( [PrivacySettingsArgType](API\Plugins\Party\Party\FPartyRepData\PrivacySettingsArgType) NewPrivacySettings )


code: void UpdatePlatformSessionInfo ( [FPartyPlatformSessionInfo](API\Plugins\Party\Party\FPartyPlatformSessionInfo) && SessionInfo )


className: FPartyRepData

description: Base struct used to replicate data about the state of the party to all members.

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FPartyRepData : public [FOnlinePartyRepDataBase](API\Plugins\Party\Party\FOnlinePartyRepDataBase)

OwnerParty

type: TWeakObjectPtr<...

PrivacySettings

type: FPartyPrivacySe...

description: The privacy settings for the party


className: FSessionId

description: Gives a smidge more meaning to the intended use for the string. These should just be UniqueId's (and are), but not reliably allocated as shared ptrs, so they cannot be replicated viaFUniqueNetIdRepl.


className: LexToString

code: const TCHAR * LexToString ( [ESocialPartyInviteFailureReason](API\Plugins\Party\Party\ESocialPartyInviteFailureReason) Type )


className: ToString

code: const TCHAR * ToString ( [EPartyJoinDenialReason](API\Plugins\Party\Party\EPartyJoinDenialReason) Type )


code: const TCHAR * ToString ( [EPartyType](API\Plugins\Party\Party\EPartyType) Type )


code: const TCHAR * ToString ( [EApprovalAction](API\Plugins\Party\Party\EApprovalAction) Type )


code: template<typename ChildRepDataT> void EstablishRepDataInstance ( ChildRepDataT & RepDataInstance )


description: Pure virtual that must be overloaded by the inheriting class. Use this method to serialize any UObjects contained that you wish to keep around.

code: virtual void AddReferencedObjects ( [FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector) & Collector )


description: Overload this method to report a name for your referencer

code: virtual [FString](API\Runtime\Core\Containers\FString) GetReferencerName() const


code: const RepDataT * operator->() const


code: void ProcessReceivedData ( const [FOnlinePartyData](API\Plugins\OnlineSubsystem\Interfaces\FOnlinePartyData) & IncomingPartyData, bool bCompareToPrevious )


className: TPartyDataReplicator

description: Base util class for dealing with data that is replicated to party members

code: template<typename RepDataT, class OwningObjectT> class TPartyDataReplicator : public [FGCObject](API\Runtime\CoreUObject\UObject\FGCObject)


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


className: FOnPartyMemberLeft

code: class FOnPartyMemberLeft : public TBaseMulticastDelegate_OneParam< void, EMemberExitedReason >


className: FOnPartyMemberStateChanged

code: class FOnPartyMemberStateChanged : public TBaseMulticastDelegate_NoParams< void >


code: [USocialParty](API\Plugins\Party\Party\USocialParty) & GetParty() const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FOnlinePartyMember](API\Plugins\OnlineSubsystem\Interfaces\FOnlinePartyMember) > GetOSSPartyMember() const


code: const [FPartyMemberRepData](API\Plugins\Party\Party\FPartyMemberRepData) & GetRepData() const


code: [USocialUser](API\Plugins\Party\User\USocialUser) & GetSocialUser() const


code: void InitializePartyMember ( const [FOnlinePartyMemberConstRef](API\Plugins\OnlineSubsystem\Interfaces\FOnlinePartyMemberConstRef) & OssMember, const FSimpleDelegate & OnInitComplete )


code: void NotifyMemberDataReceived ( const [FOnlinePartyData](API\Plugins\OnlineSubsystem\Interfaces\FOnlinePartyData) & MemberData )


code: void NotifyRemovedFromParty ( [EMemberExitedReason](API\Plugins\OnlineSubsystem\Interfaces\EMemberExitedReason) ExitReason )


code: [FOnPartyMemberStateChanged](API\Plugins\Party\Party\UPartyMember\FOnPartyMemberStateChanged) & OnDemoted() const


code: virtual void OnMemberDemotedInternal()


code: virtual void OnMemberPromotedInternal()


code: virtual void OnRemovedFromPartyInternal ( [EMemberExitedReason](API\Plugins\OnlineSubsystem\Interfaces\EMemberExitedReason) ExitReason )


code: [FString](API\Runtime\Core\Containers\FString) ToDebugString ( bool bIncludePartyId ) const


className: UPartyMember

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Config=Game, Within=SocialParty, Transient) class UPartyMember : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

MemberDataReplicator

type: FPartyMemberDat...


code: bool ApplyCrossplayRestriction ( [FPartyJoinApproval](API\Plugins\Party\Party\FPartyJoinApproval) & JoinApproval, const [FUserPlatform](API\Plugins\Party\FUserPlatform) & Platform, const [FOnlinePartyData](API\Plugins\OnlineSubsystem\Interfaces\FOnlinePartyData) & JoinData ) const


code: bool CanInviteUser ( const [USocialUser](API\Plugins\Party\User\USocialUser) & User, const [ESocialPartyInviteMethod](API\Plugins\Party\Party\ESocialPartyInviteMethod) InviteMethod ) const


description: Virtual versions of the package-scoped "CanX" methods above, as a virtual declared within package scoping cannot link (exported public, imported protected)

code: virtual [ESocialPartyInviteFailureReason](API\Plugins\Party\Party\ESocialPartyInviteFailureReason) CanInviteUserInternal ( const [USocialUser](API\Plugins\Party\User\USocialUser) & User, const [ESocialPartyInviteMethod](API\Plugins\Party\Party\ESocialPartyInviteMethod) InviteMethod ) const


code: bool CanKickMember ( const [UPartyMember](API\Plugins\Party\Party\UPartyMember) & PartyMember ) const


code: virtual bool CanKickMemberInternal ( const [UPartyMember](API\Plugins\Party\Party\UPartyMember) & PartyMember ) const


code: bool CanPromoteMember ( const [UPartyMember](API\Plugins\Party\Party\UPartyMember) & PartyMember ) const


code: virtual bool CanPromoteMemberInternal ( const [UPartyMember](API\Plugins\Party\Party\UPartyMember) & PartyMember ) const


description: Create a reservation beacon and connect to the server to get approval for new party members Only relevant while in an active game, not required while pre lobby / game

code: void ConnectToReservationBeacon()


description: Create a spectator beacon and connect to the server to get approval for new spectators

code: void ConnectToSpectatorBeacon()


code: bool ContainsUser ( const [USocialUser](API\Plugins\Party\User\USocialUser) & User ) const


code: virtual [ESocialPartyInviteFailureReason](API\Plugins\Party\Party\ESocialPartyInviteFailureReason) CanInviteUserInternal ( const [USocialUser](API\Plugins\Party\User\USocialUser) & User ) const


description: Determines the reason why, if at all, this party is currently flat-out unjoinable

code: virtual [FPartyJoinDenialReason](API\Plugins\Party\Party\FPartyJoinDenialReason) DetermineCurrentJoinability() const


description: Determines the joinability of this party for a group of users requesting to join

code: virtual [FPartyJoinApproval](API\Plugins\Party\Party\FPartyJoinApproval) EvaluateJoinRequest ( const [TArray](API\Runtime\Core\Containers\TArray)< [IOnlinePartyUserPendingJoinRequestInfoConstRef](API\Plugins\OnlineSubsystem\Interfaces\IOnlinePartyUser-) > & Players, bool bFromJoinRequest ) const


className: FDisconnectPartyEvent

code: class FDisconnectPartyEvent : public TBaseMulticastDelegate_NoParams< void >


className: FLeavePartyEvent

code: class FLeavePartyEvent : public TBaseMulticastDelegate_OneParam< void, EMemberExitedReason >


className: FOnInitializationCompletePreNotify

code: typedef TMulticastDelegate_OneParam< void, [USocialParty](API\Plugins\Party\Party\USocialParty) & > FOnInitializationCompletePreNotify


className: FOnInviteSent

code: class FOnInviteSent : public TBaseMulticastDelegate_OneParam< void, const USocialUser & >


className: FOnLeavePartyAttemptComplete

code: typedef TBaseDelegate_OneParam< void, [ELeavePartyCompletionResult](API\Plugins\OnlineSubsystem\Interfaces\ELeavePartyCompletionResult) > FOnLeavePartyAttemptComplete


className: FOnPartyConfigurationChanged

code: class FOnPartyConfigurationChanged : public TBaseMulticastDelegate_OneParam< void, const FPartyConfiguration & >


className: FOnPartyFunctionalityDegradedChanged

code: class FOnPartyFunctionalityDegradedChanged : public TBaseMulticastDelegate_OneParam< void, bool >


className: FOnPartyMemberConnectionStatusChanged

code: class FOnPartyMemberConnectionStatusChanged : public TBaseMulticastDelegate_TwoParams< void, UPartyMember &, EMemberConnectionStatus >


className: FOnPartyStateChanged

code: class FOnPartyStateChanged : public TBaseMulticastDelegate_TwoParams< void, EPartyState, EPartyState >


className: FOnPartyMemberCreated

code: class FOnPartyMemberCreated : public TBaseMulticastDelegate_OneParam< void, UPartyMember & >


code: class FOnPartyMemberLeft : public TBaseMulticastDelegate_TwoParams< void, UPartyMember *, const EMemberExitedReason >


className: FOnRequestJoinInProgressComplete

code: typedef TBaseDelegate_OneParam< void, const [EPartyJoinDenialReason](API\Plugins\Party\Party\EPartyJoinDenialReason) > FOnRequestJoinInProgressComplete


description: Override in child classes to specify the type ofUPartyMemberto create

code: virtual [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UPartyMember](API\Plugins\Party\Party\UPartyMember) > GetDesiredMemberClass ( bool bLocalPlayer ) const


code: virtual [FPartyPrivacySettings](API\Plugins\Party\Party\FPartyPrivacySettings) GetDesiredPrivacySettings() const


code: template<typename MemberT> MemberT & GetOwningLocalMember() const


code: [ULocalPlayer](API\Runtime\Engine\Engine\ULocalPlayer) & GetOwningLocalPlayer() const


code: const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & GetOwningLocalUserId() const


code: const [FOnlinePartyId](API\Plugins\OnlineSubsystem\FOnlinePartyId) & GetPartyId() const


code: template<typename MemberT> MemberT * GetPartyLeader() const


code: const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & GetPartyLeaderId() const


code: template<typename MemberT> MemberT * GetPartyMember ( const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & MemberId ) const


code: template<typename MemberT> [TArray](API\Runtime\Core\Containers\TArray)< MemberT * > GetPartyMembers() const


code: const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & GetPartyTypeId() const


code: const [FPartyPrivacySettings](API\Plugins\Party\Party\FPartyPrivacySettings) & GetPrivacySettings() const


code: static [FPartyPrivacySettings](API\Plugins\Party\Party\FPartyPrivacySettings) GetPrivacySettingsForConfig ( const [FPartyConfiguration](API\Plugins\OnlineSubsystem\Interfaces\FPartyConfiguration) & PartyConfig )


code: const [FPartyRepData](API\Plugins\Party\Party\FPartyRepData) & GetRepData() const


code: template<typename SocialManagerT> SocialManagerT & GetSocialManager() const


code: [APartyBeaconClient](API\Plugins\OnlineSubsystemUtils\APartyBeaconClient) * GetReservationBeaconClient() const


code: [ASpectatorBeaconClient](API\Plugins\OnlineSubsystemUtils\ASpectatorBeaconClient) * GetSpectatorBeaconClient() const


code: virtual void HandlePartySystemStateChange ( [EPartySystemState](API\Plugins\OnlineSubsystem\Interfaces\EPartySystemState) NewState )


code: virtual void HandlePrivacySettingsChanged ( const [FPartyPrivacySettings](API\Plugins\Party\Party\FPartyPrivacySettings) & NewPrivacySettings )


description: User/member-specific actions that are best exposed on the individuals themselves, but best handled by the actual party.

code: bool HasUserBeenInvited ( const [USocialUser](API\Plugins\Party\User\USocialUser) & User ) const


description: Override in child classes to provide encryption data for party beacon connections.

code: virtual bool InitializeBeaconEncryptionData ( [AOnlineBeaconClient](API\Plugins\OnlineSubsystemUtils\AOnlineBeaconClient) & BeaconClient, const [FString](API\Runtime\Core\Containers\FString) & SessionId )


code: void InitializeParty ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FOnlineParty](API\Plugins\OnlineSubsystem\Interfaces\FOnlineParty) > & InOssParty )


code: virtual void InitializePartyInternal()


code: bool IsCurrentlyCrossplaying() const


description: Only called when a new party is being created by the local player and they are responsible for the rep data. Otherwise we just wait to receive it from the leader.

code: virtual void InitializePartyRepData()


code: bool IsInRestrictedGameSession() const


code: bool IsInviteRateLimited ( const [USocialUser](API\Plugins\Party\User\USocialUser) & User, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: bool IsLocalPlayerPartyLeader() const


description: Is the specified net driver for our reservation beacon?

code: bool IsNetDriverFromReservationBeacon ( const [UNetDriver](API\Runtime\Engine\Engine\UNetDriver) * InNetDriver ) const


code: bool IsPartyLeader ( const [ULocalPlayer](API\Runtime\Engine\Engine\ULocalPlayer) & LocalPlayer ) const


code: virtual void JoinSessionCompleteAnalytics ( const [FSessionId](API\Plugins\Party\Party\FSessionId) & SessionId, const [FString](API\Runtime\Core\Containers\FString) & JoinBootableGroupSessionResult )


code: virtual void LeaveParty ( const [FOnLeavePartyAttemptComplete](API\Plugins\Party\Party\USocialParty\FOnLeavePartyAttemptComplete) & OnLeaveAttemptComplete )


code: [FOnInviteSent](API\Plugins\Party\Party\USocialParty\FOnInviteSent) & OnInviteSent() const


description: Deprecated version

code: virtual void OnInviteSentInternal ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType, const [USocialUser](API\Plugins\Party\User\USocialUser) & InvitedUser, bool bWasSuccessful )


code: virtual void OnInviteSentInternal ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType, const [USocialUser](API\Plugins\Party\User\USocialUser) & InvitedUser, bool bWasSuccessful, const [ESocialPartyInviteFailureReason](API\Plugins\Party\Party\ESocialPartyInviteFailureReason) FailureReason, const [ESocialPartyInviteMethod](API\Plugins\Party\Party\ESocialPartyInviteMethod) InviteMethod )


code: virtual void OnLeftPartyInternal ( [EMemberExitedReason](API\Plugins\OnlineSubsystem\Interfaces\EMemberExitedReason) Reason )


code: virtual void OnLocalPlayerIsLeaderChanged ( bool bIsLeader )


code: virtual void OnMemberCreatedInternal ( [UPartyMember](API\Plugins\Party\Party\UPartyMember) & NewMember )


code: [FDisconnectPartyEvent](API\Plugins\Party\Party\USocialParty\FDisconnectPartyEvent) & OnPartyDisconnected() const


code: [FLeavePartyEvent](API\Plugins\Party\Party\USocialParty\FLeavePartyEvent) & OnPartyLeaveBegin() const


code: [FLeavePartyEvent](API\Plugins\Party\Party\USocialParty\FLeavePartyEvent) & OnPartyLeft() const


code: [FOnPartyMemberCreated](API\Plugins\Party\Party\USocialParty\FOnPartyMemberCreated) & OnPartyMemberCreated() const


code: [FOnPartyMemberLeft](API\Plugins\Party\Party\USocialParty\FOnPartyMemberLeft) & OnPartyMemberLeft() const


code: [FOnPartyStateChanged](API\Plugins\Party\Party\USocialParty\FOnPartyStateChanged) & OnPartyStateChanged() const


description: Re-evaluates whether this party is joinable by anyone and, if not, establishes the reason why

code: void RefreshPublicJoinability()


code: virtual void RemoveLocalMember ( const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & LocalUserId, const [FOnLeavePartyAttemptComplete](API\Plugins\Party\Party\USocialParty\FOnLeavePartyAttemptComplete) & OnLeaveAttemptComplete )


code: void RequestJoinInProgress ( const [UPartyMember](API\Plugins\Party\Party\UPartyMember) & TargetMember, const [FOnRequestJoinInProgressComplete](API\Plugins\Party\Party\USocialParty\FOnRequestJoinInProgressComplete) & CompletionDelegate )


code: void SetPartyMaxSize ( int32 NewSize )


code: void SetIsMissingPlatformSession ( bool bInIsMissingPlatformSession )


code: virtual bool ShouldAlwaysJoinPlatformSession ( const [FSessionId](API\Plugins\Party\Party\FSessionId) & SessionId ) const


code: bool TryInviteUser ( const [USocialUser](API\Plugins\Party\User\USocialUser) & UserToInvite, const [ESocialPartyInviteMethod](API\Plugins\Party\Party\ESocialPartyInviteMethod) InviteMethod, const [FString](API\Runtime\Core\Containers\FString) & MetaData )


code: bool TryKickMember ( const [UPartyMember](API\Plugins\Party\Party\UPartyMember) & PartyMember )


code: bool TryPromoteMember ( const [UPartyMember](API\Plugins\Party\Party\UPartyMember) & PartyMember )


description: Apply local party configuration to the OSS party, optionally resetting the access key to the party in the process

code: void UpdatePartyConfig ( bool bResetAccessKey )


className: USocialParty

description: Party game state that contains all information relevant to the communication within a party Keeps all players in sync with the state of the party and its individual members

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Within=SocialManager, Config=Game, Transient) class USocialParty : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

PartyDataReplicator

type: FPartyDataRepli...

description: Child classes MUST call EstablishRepDataInstance() on this using their member rep data struct instance

ReservationBeaconClientClass

type: TSubclassOf<AP...

description: Reservation beacon class for getting server approval for new party members while in a game

SpectatorBeaconClientClass

type: TSubclassOf<AS...

description: Spectator beacon class for getting server approval for new spectators while in a game


className: ToString

code: const TCHAR * ToString ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SocialSubsystem )


code: virtual void AddUserId ( const QueryUserIdT & UserId, const [FOnQueryComplete](API\Plugins\Party\TSocialQuery\FOnQueryComplete) & QueryCompleteHandler )


className: CurrentQueries

code: static [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [TSocialQuery](API\Plugins\Party\TSocialQuery) > > CurrentQueries;


className: FOnQueryComplete

code: typedef [TDelegate](API\Runtime\Core\Delegates\TDelegate)< void([ESocialSubsystem](API\Plugins\Party\ESocialSubsystem), bool, CompletionCallbackArgs...)> FOnQueryComplete


className: FQueryId

code: typedef QueryUserIdT FQueryId


code: [IOnlineSubsystem](API\Plugins\OnlineSubsystem\IOnlineSubsystem) * GetOSS() const


description: All subclasses ofTSocialQuerymust implement this static method Intentionally not implemented here to catch errors at compile time


code: void Initialize ( const [USocialToolkit](API\Plugins\Party\USocialToolkit) & InToolkit, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) InSubsystemType, const [FOnQueryCompleted](API\Plugins\Party\FOnQueryCompleted) & InOnQueryCompleted )


code: template<typename OtherQueryT> bool operator== ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< OtherQueryT > & OtherQuery ) const


className: TSocialQuery

code: template<typename QueryUserIdT, typename... CompletionCallbackArgs> class TSocialQuery : public [FSocialQueryBase](API\Plugins\Party\FSocialQueryBase)

CompletionCallbacksByUserId

type: TMap< QueryUser...


description: Chat room functions Try to join a chat room by calling CreateRoom, will either create or join if it already exists

code: void CreateOrJoinChatRoom ( [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) LocalUserId, [FChatRoomId](API\Plugins\OnlineSubsystem\Interfaces\FChatRoomId) ChatRoomId, [FOnChatRoomCreatedOrJoined](API\Plugins\Party\FOnChatRoomCreatedOrJoined) CompletionDelegate, [FChatRoomConfig](API\Plugins\OnlineSubsystem\Interfaces\FChatRoomConfig) RoomConfig )


code: [FTimerManager](API\Runtime\Engine\FTimerManager) & GetTimerManager() const


code: [UWorld](API\Runtime\Engine\Engine\UWorld) * GetWorld() const


description: true if the user is already logged as being a part of a given chat room, false otherwise

code: bool IsAlreadyInChatRoom ( const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & LocalUserId, const [FChatRoomId](API\Plugins\OnlineSubsystem\Interfaces\FChatRoomId) & ChatRoomId ) const


description: true if the local player is signed in, false otherwise

code: virtual bool IsOnline() const


description: Leave the joined chat room

code: void LeaveChatRoom ( const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & LocalUserId, const [FOnChatRoomLeft](API\Plugins\Party\FOnChatRoomLeft) & CompletionDelegate )


description: Ctor

code: UChatroom()


className: UChatroom

description: Helper class for maintaining a single chat room at the game level

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Game) class UChatroom : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: ESocialUserStateFlags

description: OSS-agnostic user state filters (presence info generally required). Some of these do imply others and some conflict. Up to consumers to responsibly choose appropriate combinations.

code: enum ESocialUserStateFlags { None = 0, Online = 1, Joinable = 1 << 1, LookingForGroup = 1 << 2, SamePlatform = 1 << 3, InGame = 1 << 4, SameApp = 1 << 5, SameParty = 1 << 6, }


className: FOnNewSocialUserInitialized

code: typedef TBaseDelegate_OneParam< void, [USocialUser](API\Plugins\Party\User\USocialUser) & > FOnNewSocialUserInitialized


className: FOnCustomFilterUser

code: typedef TBaseDelegate_OneParam< bool, const [USocialUser](API\Plugins\Party\User\USocialUser) & > FOnCustomFilterUser


code: bool operator== ( const [FSocialUserListConfig](API\Plugins\Party\User\FSocialUserListConfig) & OtherConfig ) const


className: FSocialUserListConfig

description: Configuration ofISocialUserListproperties that are immutable once the list is created.

code: class FSocialUserListConfig

bAutoUpdate

description: Whether or not the list should be polled regularly for updates (as opposed to manually having UpdateNow triggered)

ForbiddenPresenceFlags

type: ESocialUserStat...

ForbiddenSubsystems

type: TArray<ESocial...

GameSpecificStatusFilters

type: TArray<TFuncti...

description: These functions run whenever the User broadcasts OnGameSpecificStatusChanged and if they all return true will trigger a full re-evaluation of this user for list eligibility.

OnCustomFilterUser

type: FOnCustomFilter...

description: Delegate that is evaluated every time we test a user for inclusion/exclusion.

RelationshipType

type: ESocialRelation...


className: FOnUpdateComplete

description: Fires one time whenever an update results in some kind of change

code: class FOnUpdateComplete : public TBaseMulticastDelegate_NoParams< void >


className: FOnUserAdded

code: class FOnUserAdded : public TBaseMulticastDelegate_OneParam< void, USocialUser & >


code: const [TArray](API\Runtime\Core\Containers\TArray)< [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [USocialUser](API\Plugins\Party\User\USocialUser) > > & GetUsers() const


className: FOnUserRemoved

code: class FOnUserRemoved : public TBaseMulticastDelegate_OneParam< void, const USocialUser & >


description: Give external overwrite to disable list auto update for perf

code: void SetAllowAutoUpdate ( bool bIsEnabled )


code: void SetAllowSortDuringUpdate ( bool bIsEnabled )


description: Trigger an update of the list immediately, regardless of auto update period

code: void UpdateNow()


className: ISocialUserList

code: class ISocialUserList


className: operator&

code: constexpr [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) operator& ( [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) Lhs, [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) Rhs )


className: operator&=

code: [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) & operator&= ( [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) & Lhs, [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) Rhs )


className: operator~

code: constexpr [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) operator~ ( [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) E )


className: operator^

code: constexpr [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) operator^ ( [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) Lhs, [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) Rhs )


className: operator^=

code: [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) & operator^= ( [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) & Lhs, [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) Rhs )


className: operator!

code: constexpr bool operator! ( [ESocialUserStateFlags](API\Plugins\Party\User\ESocialUserStateFlags) E )


code: virtual bool AcceptFriendInvite ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SocialSubsystem ) const


code: void AcceptRequestToJoinParty() const


code: virtual bool BlockUser ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) Subsystem ) const


code: bool CanInviteToParty ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId ) const


code: virtual bool CanReceiveOfflineInvite() const


code: virtual bool CanRequestToJoin() const


code: [FJoinPartyResult](API\Plugins\Party\Party\FJoinPartyResult) CheckPartyJoinability ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId ) const


code: virtual bool CanSendFriendInvite ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: void DismissRequestToJoinParty() const


code: virtual bool EndFriendship ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SocialSubsystem ) const


code: void EstablishOssInfo ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineFriend](API\Plugins\OnlineSubsystem\FOnlineFriend) > & FriendInfo, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: void EstablishOssInfo ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineBlockedPlayer](API\Plugins\OnlineSubsystem\FOnlineBlockedPlayer) > & BlockedPlayerInfo, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: void EstablishOssInfo ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineRecentPlayer](API\Plugins\OnlineSubsystem\FOnlineRecentPlayer) > & RecentPlayerInfo, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


className: FOnBlockedStatusChanged

code: class FOnBlockedStatusChanged : public TBaseMulticastDelegate_TwoParams< void, ESocialSubsystem, bool >


className: FOnFriendRemoved

code: class FOnFriendRemoved : public TBaseMulticastDelegate_OneParam< void, ESocialSubsystem >


className: FOnNicknameChanged

code: class FOnNicknameChanged : public TBaseMulticastDelegate_OneParam< void, const FText & >


className: FOnSubsystemIdEstablished

code: class FOnSubsystemIdEstablished : public TBaseMulticastDelegate_ThreeParams< void, USocialUser &, ESocialSubsystem, const FUniqueNetIdRepl & >


className: FOnUserGameSpecificStatusChanged

description: Provided so that lists with custom game-specific filtering (and any other listeners) can potentially re-evaluate a user the pattern here is similar to OnUserPresenceChanged but not subsystem-specific

code: class FOnUserGameSpecificStatusChanged : public TBaseMulticastDelegate_NoParams< void >


className: FOnUserPresenceChanged

code: class FOnUserPresenceChanged : public TBaseMulticastDelegate_OneParam< void, ESocialSubsystem >


className: FPartyInviteResponseEvent

code: class FPartyInviteResponseEvent : public TBaseMulticastDelegate_NoParams< void >


code: FString GetDisplayName&40;&41; const


code: const FOnlineUserPresence &42; GetPresenceInfo&40;&41; const


code: const FUniqueNetIdRepl & GetUserId&40;&41; const


code: bool HasValidPresenceInfo&40;&41; const


code: FSubsystemUserInfo &40; const FUniqueNetIdRepl & InUserId &41;


className: FSubsystemUserInfo

code: struct FSubsystemUserInfo

BlockedPlayerInfo

type: TWeakPtr<FOnli...

UserId

type: FUniqueNetIdRep...

description: On the fence about caching this locally. We don't care about where it came from if we do, and we can cache it independent from any of the info structs (which will play nice with external mapping queries before querying the user info itself)


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FSocialInteractionHandle](API\Plugins\Party\Interactions\FSocialInteractionHandle) > GetAllAvailableInteractions() const


code: [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > GetAnalyticsContext() const


code: virtual [FUserPlatform](API\Plugins\Party\FUserPlatform) GetCurrentPlatform() const


code: virtual int64 GetCustomSortValuePrimary() const


code: virtual int64 GetCustomSortValueSecondary() const


code: virtual int64 GetCustomSortValueTertiary() const


code: [FString](API\Runtime\Core\Containers\FString) GetDisplayName ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: [EInviteStatus::Type](API\Plugins\OnlineSubsystem\EInviteStatus__Type) GetFriendInviteStatus ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: const [FOnlineUserPresence](API\Plugins\OnlineSubsystem\Interfaces\FOnlineUserPresence) * GetFriendPresenceInfo ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: virtual int64 GetInteractionScore() const


code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetLastOnlineDate() const


code: virtual [FString](API\Runtime\Core\Containers\FString) GetMarkupTagForPlatform ( const [FUserPlatform](API\Plugins\Party\FUserPlatform) & RemoteUserPlatform ) const


code: virtual [FString](API\Runtime\Core\Containers\FString) GetNickname() const


code: [USocialToolkit](API\Plugins\Party\USocialToolkit) & GetOwningToolkit() const


code: virtual [IOnlinePartyJoinInfoConstPtr](API\Plugins\OnlineSubsystem\Interfaces\IOnlinePartyJoinInfoConstPtr) GetPartyJoinInfo ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId ) const


code: [UPartyMember](API\Plugins\Party\Party\UPartyMember) * GetPartyMember ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId ) const


code: [FString](API\Runtime\Core\Containers\FString) GetPlatformIconMarkupTag ( [EPlatformIconDisplayRule](API\Plugins\Party\EPlatformIconDisplayRule) DisplayRule ) const


code: virtual [FString](API\Runtime\Core\Containers\FString) GetPlatformIconMarkupTag ( [EPlatformIconDisplayRule](API\Plugins\Party\EPlatformIconDisplayRule) DisplayRule, [FString](API\Runtime\Core\Containers\FString) & OutLegacyString ) const


code: [TArray](API\Runtime\Core\Containers\TArray)< [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) > GetRelationshipSubsystems ( [ESocialRelationship](API\Plugins\Party\ESocialRelationship) Relationship ) const


code: [TArray](API\Runtime\Core\Containers\TArray)< [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) > GetRelevantSubsystems() const


code: virtual void GetRichPresenceText ( [FText](API\Runtime\Core\Internationalization\FText) & OutRichPresence ) const


code: const [FSubsystemUserInfo](API\Plugins\Party\User\USocialUser\FSubsystemUserInfo) * GetSubsystemUserInfo ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) Subsystem ) const


code: bool GetUserAttribute ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType, const [FString](API\Runtime\Core\Containers\FString) & AttrName, [FString](API\Runtime\Core\Containers\FString) & OutAttrValue ) const


code: [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) GetUserId ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: void HandlePartyInviteReceived ( const [IOnlinePartyJoinInfo](API\Plugins\OnlineSubsystem\Interfaces\IOnlinePartyJoinInfo) & Invite )


code: void HandlePartyInviteRemoved ( const [IOnlinePartyJoinInfo](API\Plugins\OnlineSubsystem\Interfaces\IOnlinePartyJoinInfo) & Invite, [EPartyInvitationRemovedReason](API\Plugins\OnlineSubsystem\Interfaces\EPartyInvitationRemovedReason) Reason )


code: virtual void HandlePartyRequestToJoinSent ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & PartyLeaderId, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & ExpiresAt, const [ERequestToJoinPartyCompletionResult](API\Plugins\OnlineSubsystem\Interfaces\ERequestToJoinPartyCompletionRes-) Result, [FName](API\Runtime\Core\UObject\FName) JoinMethod )


code: void HandleRequestToJoinReceived ( const [IOnlinePartyRequestToJoinInfo](API\Plugins\OnlineSubsystem\Interfaces\IOnlinePartyRequestToJoinInfo) & Request )


code: void HandleRequestToJoinRemoved ( const [IOnlinePartyRequestToJoinInfo](API\Plugins\OnlineSubsystem\Interfaces\IOnlinePartyRequestToJoinInfo) & Request, [EPartyRequestToJoinRemovedReason](API\Plugins\OnlineSubsystem\Interfaces\EPartyRequestToJoinRemovedReason) Reason )


code: virtual void HandleSetNicknameComplete ( int32 LocalUserNum, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & FriendId, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FOnlineError](API\Plugins\OnlineSubsystem\FOnlineError) & Error )


code: virtual bool HasAnyInteractionsAvailable() const


code: bool HasBeenInvitedToParty ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId ) const


code: bool HasNetId ( const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & UniqueId ) const


code: virtual bool HasRequestedToJoinUs() const


code: bool HasSentPartyInvite ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId ) const


code: bool HasSubsystemInfo ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) Subsystem ) const


code: bool HasSubsystemInfo ( const [TSet](API\Runtime\Core\Containers\TSet)< [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) > & SubsystemTypes, bool bRequireAll )


code: void Initialize ( const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & PrimaryId )


code: bool InviteToParty ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId, const [ESocialPartyInviteMethod](API\Plugins\Party\Party\ESocialPartyInviteMethod) InviteMethod, const [FString](API\Runtime\Core\Containers\FString) & MetaData ) const


code: bool IsBlocked ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: bool IsFriend ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: bool IsFriendshipPending ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: bool IsRecentPlayer ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: virtual void JoinParty ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId, const [FName](API\Runtime\Core\UObject\FName) & JoinMethod ) const


code: void NotifyPresenceChanged ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: virtual void NotifyRequestToJoinReceived ( const [IOnlinePartyRequestToJoinInfo](API\Plugins\OnlineSubsystem\Interfaces\IOnlinePartyRequestToJoinInfo) & Request )


code: void NotifyUserUnblocked ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: virtual void NotifyRequestToJoinRemoved ( const [IOnlinePartyRequestToJoinInfo](API\Plugins\OnlineSubsystem\Interfaces\IOnlinePartyRequestToJoinInfo) & Request, [EPartyRequestToJoinRemovedReason](API\Plugins\OnlineSubsystem\Interfaces\EPartyRequestToJoinRemovedReason) Reason )


code: void NotifyUserUnfriended ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: [FOnFriendRemoved](API\Plugins\Party\User\USocialUser\FOnFriendRemoved) & OnFriendInviteRemoved() const


code: void NotifyFriendInviteRemoved ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: virtual void OnPartyInviteAcceptedInternal ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId ) const


code: virtual void OnPartyInviteRejectedInternal ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId ) const


code: virtual void OnPresenceChangedInternal ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: [FOnNicknameChanged](API\Plugins\Party\User\USocialUser\FOnNicknameChanged) & OnSetNicknameCompleted() const


description: Populate list with sort values in order of priority

code: virtual void PopulateSortParameterList ( [TArray](API\Runtime\Core\Containers\TArray)< int64 > & OutSortParams ) const


code: void RegisterInitCompleteHandler ( const [FOnNewSocialUserInitialized](API\Plugins\Party\User\FOnNewSocialUserInitialized) & OnInitializationComplete )


code: virtual bool RejectFriendInvite ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SocialSubsystem ) const


code: virtual void RejectPartyInvite ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId )


code: virtual void RequestToJoinParty ( const [FName](API\Runtime\Core\UObject\FName) & JoinMethod )


code: virtual bool SendFriendInvite ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: virtual bool SetNickname ( const [FString](API\Runtime\Core\Containers\FString) & InNickName )


code: virtual void SetSubsystemId ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType, const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & SubsystemId )


code: void SetUserInfo ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineUser](API\Plugins\OnlineSubsystem\FOnlineUser) > & UserInfo )


code: bool SetUserLocalAttribute ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType, const [FString](API\Runtime\Core\Containers\FString) & AttrName, const [FString](API\Runtime\Core\Containers\FString) & AttrValue )


code: virtual bool UnblockUser ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) Subsystem ) const


code: void ValidateFriendInfo ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: void WithContext ( const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & InAnalyticsContext, void(*)([USocialUser](API\Plugins\Party\User\USocialUser) &) Func )


className: USocialUser

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Within=SocialToolkit) class USocialUser : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

AnalyticsContext

type: TMap<FString, ...

type: bool

type: EOnlinePresence...


code: virtual void CleanupParties ( const [FString](API\Runtime\Core\Containers\FString) & Instance, const [FCleanupPartiesComplete](API\Plugins\Party\USocialDebugTools\FCleanupPartiesComplete) & OnComplete )


className: FCleanupPartiesComplete

code: typedef TBaseDelegate_OneParam< void, bool > FCleanupPartiesComplete


code: IOnlineSubsystem &42; GetOSS&40;&41; const


code: void ModifyPartyField &40; const FString & FieldName, const class FVariantData & FieldValue &41;


code: bool SetJIPRequest &40; const FPartyMemberJoinInProgressRequest & InRequest &41;


code: FInstanceContext &40; const FString & InstanceName, USocialDebugTools & SocialDebugTools &41;


className: FInstanceContext

code: struct FInstanceContext

FriendInviteReceivedDelegateHandle

type: FDelegateHandle

LoginCompleteDelegateHandle

description: Delegates

Name

type: FString

OnlineSub

type: IOnlineSubsyste...

Owner

type: USocialDebugToo...

PartyMemberData

type: FOnlinePartyDat...


className: FJoinInProgressComplete

code: typedef TBaseDelegate_OneParam< void, [EPartyJoinDenialReason](API\Plugins\Party\Party\EPartyJoinDenialReason) > FJoinInProgressComplete


className: FJoinPartyComplete

code: typedef TBaseDelegate_OneParam< void, bool > FJoinPartyComplete


className: FLeavePartyComplete

code: typedef TBaseDelegate_OneParam< void, bool > FLeavePartyComplete


className: FLoginComplete

code: typedef TBaseDelegate_OneParam< void, bool > FLoginComplete


className: FLogoutComplete

code: typedef TBaseDelegate_OneParam< void, bool > FLogoutComplete


className: FSetPartyMemberDataComplete

code: typedef TBaseDelegate_OneParam< void, bool > FSetPartyMemberDataComplete


code: [FInstanceContext](API\Plugins\Party\USocialDebugTools\FInstanceContext) & GetContext ( const [FString](API\Runtime\Core\Containers\FString) & Instance )


code: [FInstanceContext](API\Plugins\Party\USocialDebugTools\FInstanceContext) * GetContextForUser ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId )


code: virtual void GetContextNames ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutContextNames ) const


code: [USocialManager](API\Plugins\Party\USocialManager) & GetSocialManager() const


code: virtual void JoinInProgress ( const [FString](API\Runtime\Core\Containers\FString) & Instance, const [FJoinInProgressComplete](API\Plugins\Party\USocialDebugTools\FJoinInProgressComplete) & OnComplete )


code: virtual void JoinParty ( const [FString](API\Runtime\Core\Containers\FString) & Instance, const [FString](API\Runtime\Core\Containers\FString) & FriendName, const [FJoinPartyComplete](API\Plugins\Party\USocialDebugTools\FJoinPartyComplete) & OnComplete )


code: virtual void LeaveParty ( const [FString](API\Runtime\Core\Containers\FString) & Instance, const [FLeavePartyComplete](API\Plugins\Party\USocialDebugTools\FLeavePartyComplete) & OnComplete )


className: LocalUserNum

code: static constexpr const int32 LocalUserNum = 0;


code: virtual void Login ( const [FString](API\Runtime\Core\Containers\FString) & Instance, const [FOnlineAccountCredentials](API\Plugins\OnlineSubsystem\Interfaces\FOnlineAccountCredentials) & Credentials, const [FLoginComplete](API\Plugins\Party\USocialDebugTools\FLoginComplete) & OnComplete )


code: virtual void Logout ( const [FString](API\Runtime\Core\Containers\FString) & Instance, const [FLogoutComplete](API\Plugins\Party\USocialDebugTools\FLogoutComplete) & OnComplete )


code: virtual void NotifyContextInitialized ( const [FInstanceContext](API\Plugins\Party\USocialDebugTools\FInstanceContext) & Context )


code: virtual void PrintExecCommands() const


code: virtual bool RunCommand ( const TCHAR * Cmd, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & TargetInstances )


code: virtual void SetPartyMemberData ( const [FString](API\Runtime\Core\Containers\FString) & Instance, const [UStruct](API\Runtime\CoreUObject\UObject\UStruct) * StructType, const void * StructData, const [FSetPartyMemberDataComplete](API\Plugins\Party\USocialDebugTools\FSetPartyMemberDataComplete) & OnComplete )


code: virtual void SetPartyMemberDataJson ( const [FString](API\Runtime\Core\Containers\FString) & Instance, const [FString](API\Runtime\Core\Containers\FString) & JsonStr, const [FSetPartyMemberDataComplete](API\Plugins\Party\USocialDebugTools\FSetPartyMemberDataComplete) & OnComplete )


description: FExec.

code: USocialDebugTools()


className: USocialDebugTools

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Within=SocialManager, Config=Game) class USocialDebugTools : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [FExec](API\Runtime\Core\Misc\FExec)


code: static void AddReferencedObjects ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InThis, [FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector) & Collector )


code: virtual bool CanCreateNewPartyObjects() const


code: void CreateParty ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId, const [FPartyConfiguration](API\Plugins\OnlineSubsystem\Interfaces\FPartyConfiguration) & PartyConfig, const [FOnCreatePartyAttemptComplete](API\Plugins\Party\USocialManager\FOnCreatePartyAttemptComplete) & OnCreatePartyComplete )


code: void CreatePersistentParty ( const [FOnCreatePartyAttemptComplete](API\Plugins\Party\USocialManager\FOnCreatePartyAttemptComplete) & OnCreatePartyComplete )


className: DefaultSubsystems

code: static [TArray](API\Runtime\Core\Containers\TArray)< [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) > DefaultSubsystems;


description: Gives child classes a chance to append any additional data to a join request that's about to be sent to another party. This is where you'll add game-specific information that can affect whether you are eligible for the target party.

code: virtual void FillOutJoinRequestData ( const [FOnlinePartyId](API\Plugins\OnlineSubsystem\FOnlinePartyId) & TargetParty, [FOnlinePartyData](API\Plugins\OnlineSubsystem\Interfaces\FOnlinePartyData) & OutJoinRequestData ) const


code: static Step_DeferredPartyCreation = TEXT("DeferredPartyCreation");


code: static Step_FindPlatformSession = TEXT("FindPlatformSession");


code: static Step_JoinParty = TEXT("JoinParty");


code: static Step_LeaveCurrentParty = TEXT("LeaveCurrentParty");


code: static Step_QueryJoinability = TEXT("QueryJoinability");


code: static Step_WaitForPersistentPartyCreation = TEXT("WaitForPersistentPartyCreation");


code: FString ToDebugString&40;&41; const


code: FJoinPartyAttempt &40; TSharedRef< const FRejoinableParty > InRejoinInfo &41;


code: FJoinPartyAttempt &40; const USocialUser &42; InTargetUser, const FOnlinePartyTypeId & InPartyTypeId, const FName & InJoinMethod, const FOnJoinPartyAttemptComplete & InOnJoinComplete &41;


className: FJoinPartyAttempt

code: struct FJoinPartyAttempt

ActionTimeTracker

type: FSocialActionTi...

JoinInfo

type: IOnlinePartyJoi...

JoinMethod

type: FName

OnJoinComplete

type: FOnJoinPartyAtt...

PartyTypeId

type: FOnlinePartyTyp...

RejoinInfo

type: TSharedPtr< con...

TargetUser

type: TWeakObjectPtr<...


className: FOnCreatePartyAttemptComplete

code: typedef TBaseDelegate_OneParam< void, [ECreatePartyCompletionResult](API\Plugins\OnlineSubsystem\Interfaces\ECreatePartyCompletionResult) > FOnCreatePartyAttemptComplete


className: FOnJoinPartyAttemptComplete

code: typedef TBaseDelegate_OneParam< void, const [FJoinPartyResult](API\Plugins\Party\Party\FJoinPartyResult) & > FOnJoinPartyAttemptComplete


className: FOnPartyMembershipChanged

code: class FOnPartyMembershipChanged : public TBaseMulticastDelegate_OneParam< void, USocialParty & >


description: Attempt to restore our party state from the party system

code: typedef TBaseDelegate_OneParam< void, bool > FOnRestorePartyStateFromPartySystemComplete


className: FOnSocialToolkitCreated

code: class FOnSocialToolkitCreated : public TBaseMulticastDelegate_OneParam< void, USocialToolkit & >


code: FRejoinableParty &40; const USocialParty & SourceParty &41;


className: FRejoinableParty

code: struct FRejoinableParty : public [TSharedFromThis< FRejoinableParty >](API\Runtime\Core\Templates\TSharedFromThis)

MemberIds

type: TArray< FUnique...

PartyId

type: TSharedRef< con...


description: Up to the game to decide whether it wants to allow crossplay (generally based on a user setting of some kind)

code: virtual [ECrossplayPreference](API\Plugins\Party\ECrossplayPreference) GetCrossplayPreference() const


code: [USocialDebugTools](API\Plugins\Party\USocialDebugTools) * GetDebugTools() const


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) > & GetDefaultSubsystems()


code: [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) GetFirstLocalUserId ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: [USocialToolkit](API\Plugins\Party\USocialToolkit) * GetFirstLocalUserToolkit() const


code: const [FJoinPartyAttempt](API\Plugins\Party\USocialManager\FJoinPartyAttempt) * GetJoinAttemptInProgress ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId ) const


code: template<typename PartyT> PartyT * GetParty ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId ) const


code: template<typename PartyT> PartyT * GetParty ( const [FOnlinePartyId](API\Plugins\OnlineSubsystem\FOnlinePartyId) & PartyId ) const


code: [USocialParty](API\Plugins\Party\Party\USocialParty) * GetPersistentPartyInternal ( bool bEvenIfLeaving ) const


code: virtual [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [USocialParty](API\Plugins\Party\Party\USocialParty) > GetPartyClassForType ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId ) const


code: template<typename PartyT> PartyT * GetPersistentParty() const


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FSocialInteractionHandle](API\Plugins\Party\Interactions\FSocialInteractionHandle) > & GetRegisteredInteractions()


code: virtual [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [USocialDebugTools](API\Plugins\Party\USocialDebugTools) > GetSocialDebugToolsClass() const


code: static [IOnlineSubsystem](API\Plugins\OnlineSubsystem\IOnlineSubsystem) * GetSocialOss ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: static [FName](API\Runtime\Core\UObject\FName) GetSocialOssName ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: static [FText](API\Runtime\Core\Internationalization\FText) GetSocialOssPlatformName ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: [USocialToolkit](API\Plugins\Party\USocialToolkit) & GetSocialToolkit ( const [ULocalPlayer](API\Runtime\Engine\Engine\ULocalPlayer) & LocalPlayer ) const


code: [USocialToolkit](API\Plugins\Party\USocialToolkit) * GetSocialToolkit ( int32 LocalPlayerNum ) const


code: [USocialToolkit](API\Plugins\Party\USocialToolkit) * GetSocialToolkit ( [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) LocalUserId ) const


code: void HandlePartyDisconnected ( [USocialParty](API\Plugins\Party\Party\USocialParty) * LeavingParty )


code: void HandlePlatformSessionInviteAccepted ( const FUniqueNetIdRef & LocalUserId, const [FOnlineSessionSearchResult](API\Plugins\OnlineSubsystem\FOnlineSessionSearchResult) & InviteResult )


code: virtual void HandleQueryJoinabilityComplete ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & LocalUserId, const [FOnlinePartyId](API\Plugins\OnlineSubsystem\FOnlinePartyId) & PartyId, const [FQueryPartyJoinabilityResult](API\Plugins\OnlineSubsystem\Interfaces\FQueryPartyJoinabilityResult) & Result, [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) PartyTypeId )


description: Initializes the manager - call this right after creating the manager object during GameInstance initialization.

code: virtual void InitSocialManager()


code: bool IsConnectedToPartyService() const


code: bool IsLocalUser ( const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & LocalUserId, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: bool IsPartyJoinInProgress ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & TypeId ) const


description: FExec.

code: static bool IsSocialSubsystemEnabled ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: void JoinParty ( const [USocialUser](API\Plugins\Party\User\USocialUser) & UserToJoin, const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId, const [FOnJoinPartyAttemptComplete](API\Plugins\Party\USocialManager\FOnJoinPartyAttemptComplete) & OnJoinPartyComplete, const [FName](API\Runtime\Core\UObject\FName) & JoinMethod )


code: virtual void NotifyPartyInitialized ( [USocialParty](API\Plugins\Party\Party\USocialParty) & Party )


description: Virtual void OnCreatePartyComplete(const TSharedPtr& PartyId, ECreatePartyCompletionResult Result, FOnlinePartyTypeId PartyTypeId) {} virtual void OnQueryJoinabilityComplete(const FOnlinePartyId& PartyId, EJoinPartyCompletionResult Result, int32 DeniedResultCode, FOnlinePartyTypeId PartyTypeId) {}

code: virtual void OnJoinPartyAttemptCompleteInternal ( const [FJoinPartyAttempt](API\Plugins\Party\USocialManager\FJoinPartyAttempt) & JoinAttemptInfo, const [FJoinPartyResult](API\Plugins\Party\Party\FJoinPartyResult) & Result )


code: [FOnPartyMembershipChanged](API\Plugins\Party\USocialManager\FOnPartyMembershipChanged) & OnPartyJoined() const


code: virtual void OnPartyLeftInternal ( [USocialParty](API\Plugins\Party\Party\USocialParty) & LeftParty, [EMemberExitedReason](API\Plugins\OnlineSubsystem\Interfaces\EMemberExitedReason) Reason )


code: virtual void OnToolkitCreatedInternal ( [USocialToolkit](API\Plugins\Party\USocialToolkit) & NewToolkit )


code: void RefreshCanCreatePartyObjects()


code: template<typename InteractionT> void RegisterInteraction()


description: Makes an attempt for the target local player to join the primary local player's party

code: void RegisterSecondaryPlayer ( int32 LocalPlayerNum, const [FOnJoinPartyComplete](API\Plugins\OnlineSubsystem\Interfaces\FOnJoinPartyComplete) & Delegate )


code: void RestorePartyStateFromPartySystem ( const [FOnRestorePartyStateFromPartySystemComplete](API\Plugins\Party\USocialManager\FOnRestorePartyStateFromPartySys-) & OnRestoreComplete )


code: virtual void ShutdownSocialManager()


code: virtual bool ShouldTryRejoiningPersistentParty ( const [FRejoinableParty](API\Plugins\Party\USocialManager\FRejoinableParty) & InRejoinableParty ) const


description: Validate that we are clear to try joining a party of the given type. If not, gives the reason why.

code: virtual [FJoinPartyResult](API\Plugins\Party\Party\FJoinPartyResult) ValidateJoinAttempt ( const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId ) const


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

code: virtual [FJoinPartyResult](API\Plugins\Party\Party\FJoinPartyResult) ValidateJoinTarget ( const [USocialUser](API\Plugins\Party\User\USocialUser) & UserToJoin, const [FOnlinePartyTypeId](API\Plugins\OnlineSubsystem\FOnlinePartyTypeId) & PartyTypeId ) const


className: USocialManager

description: Singleton manager at the top of the social framework

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Within=GameInstance, Config=Game) class USocialManager : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [FExec](API\Runtime\Core\Misc\FExec)

bShutdownPending

description: Set during shutdown, used to early-out of lingering OnlineSubsystem callbacks that are pending.

JoinAttemptsByTypeId

type: TMap<FOnlinePa...

RejoinableParty

type: TSharedPtr<FRe...

description: Info on the persistent party we were in when losing connection to the party service and want to rejoin when it returns

ToolkitClass

type: TSubclassOf<US...

description: The desired type of SocialToolkit to create for each local player


code: static int32 GetMaxNicknameLength()


code: static int32 GetDefaultMaxPartySize()


code: static int32 GetMinNicknameLength()


description:
Get a platform description (from GetSocialPlatformDescriptions) for a specific OnlineSubsystem.
the social platform description for that online subsystem. May return null if it is not found.

code: static const [FSocialPlatformDescription](API\Plugins\Party\FSocialPlatformDescription) * GetSocialPlatformDescriptionForOnlineSubsystem ( const [FName](API\Runtime\Core\UObject\FName) & OnlineSubsystemName )


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FSocialPlatformDescription](API\Plugins\Party\FSocialPlatformDescription) > & GetSocialPlatformDescriptions()


code: static [FString](API\Runtime\Core\Containers\FString) GetUniqueIdEnvironmentPrefix ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


description: Checks if current OnlineSubsystem name is Sony specific

code: static bool IsSonyOSS ( const [FName](API\Runtime\Core\UObject\FName) & OSSName )


code: static bool MustSendPrimaryInvites()


className: USocialSettings

description: Config-driven settings object for the social framework. Only the CDO is ever expected to be used, no instance is ever expected to be created.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Game) class USocialSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: bool AcceptFriendInvite ( const [USocialUser](API\Plugins\Party\User\USocialUser) & SocialUser, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


description: Only handles accepting a friend request via the friends interface, assumes all checks are handled previously

code: virtual bool AcceptFriendInviteInternal ( const [USocialUser](API\Plugins\Party\User\USocialUser) & SocialUser, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


className: AllToolkitsByOwningPlayer

code: static [TMap](API\Runtime\Core\Containers\TMap)< [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< const [ULocalPlayer](API\Runtime\Engine\Engine\ULocalPlayer) >, [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [USocialToolkit](API\Plugins\Party\USocialToolkit) > > AllToolkitsByOwningPlayer;


code: void AddLocalUserOnlineProperties ( [FPresenceProperties](API\Plugins\OnlineSubsystem\Interfaces\FPresenceProperties) OnlineProperties )


description:
Can we automatically re-create a persistent party, for example on party join failure or on party kick? Typically you will want to, so the user always has a party, but there may be scenarios where you want to delay creating a new party until the client is in a better state.
true if we can automatically recreate a persistent party

code: virtual bool CanAutoRecreatePersistentParty() const


code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISocialUserList](API\Plugins\Party\User\ISocialUserList) > CreateUserList ( const [FSocialUserListConfig](API\Plugins\Party\User\FSocialUserListConfig) & ListConfig ) const


className: FBasicToolkitEvent

code: class FBasicToolkitEvent : public TBaseMulticastDelegate_NoParams< void >


className: FFriendInviteEvent

code: class FFriendInviteEvent : public TBaseMulticastDelegate_TwoParams< void, USocialUser &, ESocialSubsystem >


description: Finds a SocialUser given a unique net ID from any OSS

code: [USocialUser](API\Plugins\Party\User\USocialUser) * FindUser ( const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & UserId ) const


className: FOnPartyRequestToJoinReceivedEvent

code: class FOnPartyRequestToJoinReceivedEvent : public TBaseMulticastDelegate_TwoParams< void, USocialUser &, IOnlinePartyRequestToJoinInfoConstRef >


className: FOnKnownUserInitialized

code: class FOnKnownUserInitialized : public TBaseMulticastDelegate_OneParam< void, USocialUser & >


className: FOnPartyRequestToJoinRemovedEvent

code: class FOnPartyRequestToJoinRemovedEvent : public TBaseMulticastDelegate_ThreeParams< void, USocialUser &, IOnlinePartyRequestToJoinInfoConstRef, EPartyRequestToJoinRemovedReason >


className: FOnPartyRequestToJoinSentEvent

code: class FOnPartyRequestToJoinSentEvent : public TBaseMulticastDelegate_OneParam< void, const USocialUser & >


className: FOnRelationshipEstablished

code: class FOnRelationshipEstablished : public TBaseMulticastDelegate_ThreeParams< void, USocialUser &, ESocialSubsystem, bool >


className: FOnSocialUserInvalidated

code: class FOnSocialUserInvalidated : public TBaseMulticastDelegate_OneParam< void, const USocialUser & >


className: FPartyInviteEvent

code: class FPartyInviteEvent : public TBaseMulticastDelegate_OneParam< void, USocialUser & >


code: const [TArray](API\Runtime\Core\Containers\TArray)< [USocialUser](API\Plugins\Party\User\USocialUser) * > & GetAllUsers() const


code: bool GetAuthAttribute ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType, const [FString](API\Runtime\Core\Containers\FString) & AttributeKey, [FString](API\Runtime\Core\Containers\FString) & OutValue ) const


code: [USocialChatManager](API\Plugins\Party\Chat\USocialChatManager) & GetChatManager() const


code: [USocialUser](API\Plugins\Party\User\USocialUser) & GetLocalUser() const


code: [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) GetLocalUserNetId ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: [ULocalPlayer](API\Runtime\Engine\Engine\ULocalPlayer) & GetOwningLocalPlayer() const


code: const [FOnlineUserPresence](API\Plugins\OnlineSubsystem\Interfaces\FOnlineUserPresence) * GetPresenceInfo ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: const [FString](API\Runtime\Core\Containers\FString) & GetRecentPlayerNamespaceToQuery() const


code: [USocialManager](API\Plugins\Party\USocialManager) & GetSocialManager() const


code: [IOnlineSubsystem](API\Plugins\OnlineSubsystem\IOnlineSubsystem) * GetSocialOss ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: template<typename ToolkitT> static ToolkitT * GetToolkitForPlayer ( const [ULocalPlayer](API\Runtime\Engine\Engine\ULocalPlayer) * LocalPlayer )


description: Handle result of AcceptFriendInvite

code: void HandleAcceptFriendInviteComplete ( int32 LocalUserNum, bool bWasSuccessful, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & InviterUserId, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FString](API\Runtime\Core\Containers\FString) & ErrorStr )


description: Handle result of TrySendFriendInviteInternal

code: void HandleSendFriendInviteComplete ( int32 LocalUserNum, bool bWasSuccessful, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & InvitedUserId, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FString](API\Runtime\Core\Containers\FString) & ErrorStr, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType, [FString](API\Runtime\Core\Containers\FString) DisplayName )


code: void HandleUserInvalidated ( [USocialUser](API\Plugins\Party\User\USocialUser) & InvalidUser )


code: virtual void InitializeToolkit ( [ULocalPlayer](API\Runtime\Engine\Engine\ULocalPlayer) & InOwningLocalPlayer )


code: virtual bool IsOwnerLoggedIn() const


code: virtual bool IsFriendshipRestricted ( const [USocialUser](API\Plugins\Party\User\USocialUser) & SocialUser, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


description: Whether we allow other users to send us invites

code: virtual const bool IsInviteAllowedFromUser ( const [USocialUser](API\Plugins\Party\User\USocialUser) & User, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [IOnlinePartyJoinInfo](API\Plugins\OnlineSubsystem\Interfaces\IOnlinePartyJoinInfo) > & InviteRef ) const


code: virtual void NotifyPartyInviteReceived ( [USocialUser](API\Plugins\Party\User\USocialUser) & SocialUser, const [IOnlinePartyJoinInfo](API\Plugins\OnlineSubsystem\Interfaces\IOnlinePartyJoinInfo) & Invite )


code: virtual void NotifyPartyInviteRemoved ( [USocialUser](API\Plugins\Party\User\USocialUser) & SocialUser, const [IOnlinePartyJoinInfo](API\Plugins\OnlineSubsystem\Interfaces\IOnlinePartyJoinInfo) & Invite )


code: void NotifySubsystemIdEstablished ( [USocialUser](API\Plugins\Party\User\USocialUser) & SocialUser, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType, const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & SubsystemId )


code: virtual void OnAcceptFriendInviteComplete ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & InviterUserId, bool bInviteSucceeded, const [FString](API\Runtime\Core\Containers\FString) & InviteError )


code: virtual void OnBlockPlayerComplete ( int32 LocalUserNum, bool bWasSuccessful, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & BlockedPlayerID, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FString](API\Runtime\Core\Containers\FString) & ErrorStr, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: virtual void OnDeleteFriendComplete ( int32 LocalPlayer, bool bWasSuccessful, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & FormerFriendId, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FString](API\Runtime\Core\Containers\FString) & ErrorStr, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: [FFriendInviteEvent](API\Plugins\Party\USocialToolkit\FFriendInviteEvent) & OnFriendInviteReceived() const


code: [FFriendInviteEvent](API\Plugins\Party\USocialToolkit\FFriendInviteEvent) & OnFriendInviteSent() const


description: Called when a Friend's presence did change

code: virtual void OnFriendPresenceDidChange ( const [USocialUser](API\Plugins\Party\User\USocialUser) & FriendSocialUser, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineUserPresence](API\Plugins\OnlineSubsystem\Interfaces\FOnlineUserPresence) > & NewPresence, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: [FPartyInviteEvent](API\Plugins\Party\USocialToolkit\FPartyInviteEvent) & OnPartyInviteReceived() const


code: [FPartyInviteEvent](API\Plugins\Party\USocialToolkit\FPartyInviteEvent) & OnPartyInviteRemoved() const


code: virtual void OnQueryBlockedPlayersComplete ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, bool bWasSuccessful, const [FString](API\Runtime\Core\Containers\FString) & ErrorStr, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: virtual void OnQueryBlockedPlayersSuccess ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType, const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineBlockedPlayer](API\Plugins\OnlineSubsystem\FOnlineBlockedPlayer) >> & BlockedPlayers )


code: virtual void OnQueryFriendsListSuccess ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType, const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineFriend](API\Plugins\OnlineSubsystem\FOnlineFriend) >> & FriendsList )


code: virtual void OnQueryRecentPlayersComplete ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UserId, const [FString](API\Runtime\Core\Containers\FString) & Namespace, bool bWasSuccessful, const [FString](API\Runtime\Core\Containers\FString) & ErrorStr, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: virtual void OnQueryRecentPlayersSuccess ( [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType, const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FOnlineRecentPlayer](API\Plugins\OnlineSubsystem\FOnlineRecentPlayer) >> & FriendsList )


code: virtual void OnReadFriendsListComplete ( int32 LocalUserNum, bool bWasSuccessful, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FString](API\Runtime\Core\Containers\FString) & ErrorStr, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: [FOnRelationshipEstablished](API\Plugins\Party\USocialToolkit\FOnRelationshipEstablished) & OnRecentPlayerAdded() const


code: virtual void OnSendFriendInviteComplete ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & InvitedUserId, const [FString](API\Runtime\Core\Containers\FString) & InviteeName, bool bInviteSuceeded, const [FString](API\Runtime\Core\Containers\FString) & InviteError )


code: [FBasicToolkitEvent](API\Plugins\Party\USocialToolkit\FBasicToolkitEvent) & OnToolkitReset() const


code: virtual void OnUnblockPlayerComplete ( int32 LocalUserNum, bool bWasSuccessful, const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UnblockedPlayerID, const [FString](API\Runtime\Core\Containers\FString) & ListName, const [FString](API\Runtime\Core\Containers\FString) & ErrorStr, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType )


code: [FOnRelationshipEstablished](API\Plugins\Party\USocialToolkit\FOnRelationshipEstablished) & OnUserBlocked() const


description: Up to the caller whether they want the action executed immediately upon creation of theUSocialUserinstance, or after the instance is fully initialized (i.e. has finished discovering all available backend information) Default is to execute after initialization and is generally more appropriate.

code: void QueueUserDependentAction ( const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & SubsystemId, [FUserDependentAction](API\Plugins\Party\FUserDependentAction) UserActionDelegate )


code: void QueueUserDependentAction ( const [FUniqueNetIdRepl](API\Runtime\Engine\GameFramework\FUniqueNetIdRepl) & UserId, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([USocialUser](API\Plugins\Party\User\USocialUser) &)> && UserActionFunc, bool bExecutePostInit )


description: Only handles sending a friend request via the friends interface, assumes all checks are handled previously

code: virtual bool SendFriendInviteInternal ( [USocialUser](API\Plugins\Party\User\USocialUser) & SocialUser, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


code: void SetLocalUserOnlineState ( [EOnlinePresenceState::Type](API\Plugins\OnlineSubsystem\Interfaces\EOnlinePresenceState__Type) OnlineState )


description: Attempts to send a friend invite to another user based on display name or email. Only necessary to use this path when you do not have a knownUSocialUserfor this user already.

code: void TrySendFriendInvite ( const [FString](API\Runtime\Core\Containers\FString) & DisplayNameOrEmail ) const


code: bool TrySendFriendInvite ( [USocialUser](API\Plugins\Party\User\USocialUser) & SocialUser, [ESocialSubsystem](API\Plugins\Party\ESocialSubsystem) SubsystemType ) const


className: USocialToolkit

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

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Within=SocialManager, Config=Game) class USocialToolkit : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [FExec](API\Runtime\Core\Misc\FExec)

bQueryBlockedPlayersOnStartup

type: bool

bQueryFriendsOnStartup

description: Something nicer is definitely possible and worth revisiting.

ChatManagerClass

description: Class to use when creating the ChatManager

FriendListToQuery

description: The name of the friends list to query

RecentPlayerNamespaceToQuery

description: The name of the recent player namespace to query

SocialUserClass

description: The type of SocialUser to create to represent known users


className: EPatchCheckResult

description: Possible outcomes at the end of just the patch check

module: PatchCheck

code: enum EPatchCheckResult { NoPatchRequired, PatchRequired, NoLoggedInUser, PatchCheckFailure, Count, }


className: FEnvironmentWantsPatchCheck

description: For backwards compatibility only!

code: typedef TBaseDelegate_NoParams< bool > FEnvironmentWantsPatchCheck


code: void AddEnvironmentWantsPatchCheckBackCompatDelegate ( [FName](API\Runtime\Core\UObject\FName) Tag, [FEnvironmentWantsPatchCheck](API\Plugins\PatchCheck\FEnvironmentWantsPatchCheck) Delegate )


className: FOnPatchCheckComplete

code: typedef TMulticastDelegate_OneParam< void, [EPatchCheckResult](API\Plugins\PatchCheck\EPatchCheckResult) > FOnPatchCheckComplete


code: virtual bool EnvironmentWantsPatchCheck() const


code: static [FPatchCheck](API\Plugins\PatchCheck\FPatchCheck) & Get()


code: void OnCheckForPatchComplete ( const [FUniqueNetId](API\Runtime\CoreOnline\Online\FUniqueNetId) & UniqueId, [EUserPrivileges::Type](API\Plugins\OnlineSubsystem\Interfaces\EUserPrivileges__Type) Privilege, uint32 PrivilegeResult, bool bConsoleCheck )


code: virtual void PatchCheckComplete ( [EPatchCheckResult](API\Plugins\PatchCheck\EPatchCheckResult) PatchResult )


code: void RemoveEnvironmentWantsPatchCheckBackCompatDelegate ( [FName](API\Runtime\Core\UObject\FName) Tag )


code: virtual void StartOSSPatchCheck()


code: FPatchCheck &40; const FPatchCheck & Other &41;


className: FPatchCheck

code: class FPatchCheck

type: TMap<FName,FE...

description: For backwards compatibility withUUpdateManager

bCheckOSSForUpdate

description: Check the default OSS for an update

bCheckPlatformOSSForUpdate

description: Check the platform OSS for an update

bIsCheckInProgress

description: Track whether we can start a new check

OnComplete

type: FOnPatchCheckCo...


description: Called before the module has been unloaded

code: virtual void PreUnloadCallback()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


className: IPatchCheckModule

code: class IPatchCheckModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)

PatchCheck

type: TUniquePtr<FPa...


code: virtual [FPatchCheck](API\Plugins\PatchCheck\FPatchCheck) * MakePatchCheck()


className: TPatchCheckModule

code: template<class PatchCheckClass> class TPatchCheckModule : public [IPatchCheckModule](API\Plugins\PatchCheck\IPatchCheckModule)


className: EPBIKRootBehavior

module: PBIK

code: enum EPBIKRootBehavior { PrePull, PinToInput, Free, }


code: bool HasChild ( const [FBone](API\Plugins\PBIK\Core\FBone) * Bone )


code: FBone ( const [FName](API\Runtime\Core\UObject\FName) InName, const int32 & InParentIndex, const FVector & InOrigPosition, const FQuat & InOrigRotation, bool bInIsSolverRoot )


className: FBone

code: struct FBone

Body

type: FRigidBody*...

description: Initialized - these fields are null/empty until after Solver::Initialize()

Children

type: TArray<FBone&...

Length

type: float

LocalPositionOrig

type: FVector

LocalRotationOrig

type: FQuat

Parent

type: FBone*


className: FBoneSettings

code: struct FBoneSettings

PreferredAngles

type: FRotator

X

type: ELimitType


code: virtual void RemoveStretch ( const float Percent )


code: void Solve ( const [FPBIKSolverSettings](API\Plugins\PBIK\Core\FPBIKSolverSettings) & Settings )


code: void GetDebugLinesForBodies ( [TArray](API\Runtime\Core\Containers\TArray)< [FDebugLine](API\Plugins\PBIK\Core\FDebugLine) > & OutLines )


className: FDebugDraw

code: struct FDebugDraw

Solver

type: FPBIKSolver...


code: FDebugLine ( const FVector & InA, const FVector & InB )


className: FDebugLine

code: struct FDebugLine


code: void SetGoal ( const FVector & InPositionGoal, const FQuat & InRotationGoal, const [FEffectorSettings](API\Plugins\PBIK\Core\FEffectorSettings) & InSettings )


code: void UpdateFromInputs ( const [FBone](API\Plugins\PBIK\Core\FBone) & SolverRoot )


code: FEffector ( [FBone](API\Plugins\PBIK\Core\FBone) * InBone )


className: FEffector

code: struct FEffector

DistancesFromEffector

type: TArray< float >

Pin

type: TWeakPtr<FPinC...

Settings

type: FEffectorSettin...


className: FEffectorSettings

code: struct FEffectorSettings

PinRotation

description: Range 0-1 (default is 1.0).

PositionAlpha

description: Range 0-1, default is 1.

PullChainAlpha

description: Range 0-1 (default is 1.0).

RotationAlpha

description: Range 0-1, default is 1.

StrengthAlpha

description: Range 0-1 (default is 1.0).


code: virtual void Solve ( const [FPBIKSolverSettings](API\Plugins\PBIK\Core\FPBIKSolverSettings) & Settings )


code: FJointConstraint ( [FRigidBody](API\Plugins\PBIK\Core\FRigidBody) * InA, [FRigidBody](API\Plugins\PBIK\Core\FRigidBody) * InB )


className: FJointConstraint

code: struct FJointConstraint : public [PBIK::FConstraint](API\Plugins\PBIK\Core\FConstraint)


description: Pre-init / setup functions

code: int32 AddBone ( const [FName](API\Runtime\Core\UObject\FName) Name, const int32 ParentIndex, const FVector & InOrigPosition, const FQuat & InOrigRotation, bool bIsSolverRoot )


code: int32 AddEffector ( [FName](API\Runtime\Core\UObject\FName) BoneName )


code: void GetBoneGlobalTransform ( const int32 Index, FTransform & OutTransform )


code: int32 GetBoneIndex ( [FName](API\Runtime\Core\UObject\FName) BoneName ) const


code: [PBIK::FBoneSettings](API\Plugins\PBIK\Core\FBoneSettings) * GetBoneSettings ( const int32 Index )


description: Main runtime functions

code: bool Initialize()


description: Set input / get output at runtime

code: void SetBoneTransform ( const int32 Index, const FTransform & InTransform )


code: void SetEffectorGoal ( const int32 Index, const FVector & InPosition, const FQuat & InRotation, const [PBIK::FEffectorSettings](API\Plugins\PBIK\Core\FEffectorSettings) & Settings )


code: void Solve ( const [FPBIKSolverSettings](API\Plugins\PBIK\Core\FPBIKSolverSettings) & Settings )


className: FPBIKSolverSettings

bAllowStretch

description: If true, joints will translate to reach the effectors; causing bones to lengthen if necessary.

GlobalPullChainAlpha

description: A global multiplier for all Pull Chain Alpha values on all effectors.

Iterations

description: High iteration counts can help solve complex joint configurations with competing constraints, but will increase runtime cost.

MassMultiplier

description: A global mass multiplier; higher values will make the joints more stiff, but require more iterations.

MaxAngle

description: Maximum angle that a joint can be rotated per constraint iteration.

OverRelaxation

description: Pushes constraints beyond their normal amount to speed up convergence.

PrePullRootSettings

type: FRootPrePullSet...

description: Settings only applicable when Root Behavior is set to "PrePull".

RootBehavior

type: EPBIKRootBehavi...

description: (Default is PrePull) Set the behavior of the solver root.


code: void SetGoal ( const FVector & InGoalPosition, const FQuat & InGoalRotation, const float InAlpha )


code: FPinConstraint ( [FRigidBody](API\Plugins\PBIK\Core\FRigidBody) * InBody, const FVector & InPinPositionOrig, const FQuat & InPinRotationOrig, const bool bInPinRotation )


className: FPinConstraint

code: struct FPinConstraint : public [PBIK::FConstraint](API\Plugins\PBIK\Core\FConstraint)


code: void ApplyPushToPosition ( const FVector & Push )


code: void ApplyPushToRotateBody ( const FVector & Push, const FVector & Offset )


code: void ApplyRotationDelta ( const FQuat & InDelta )


code: [FRigidBody](API\Plugins\PBIK\Core\FRigidBody) * GetParentBody() const


code: void Initialize ( const [FBone](API\Plugins\PBIK\Core\FBone) * SolverRoot )


code: void UpdateFromInputs ( const [FPBIKSolverSettings](API\Plugins\PBIK\Core\FPBIKSolverSettings) & Settings )


code: void UpdateTransformAndMassFromBones()


code: FRigidBody ( [FBone](API\Plugins\PBIK\Core\FBone) * InBone )


className: FRootPrePullSettings

PositionAlpha

description: Range 0-1, default is 1.

PositionAlphaX

description: Range 0-1, default is 1. Blend contribution to position offset in the X axis in component space.

PositionAlphaY

description: Range 0-1, default is 1. Blend contribution to position offset in the Y axis in component space.

PositionAlphaZ

description: Range 0-1, default is 1. Blend contribution to position offset in the Z axis in component space.

RotationAlpha

description: Range 0-1, default is 0.

RotationAlphaX

description: Range 0-1, default is 1. Blend contribution to rotation offset in the X axis in component space.

RotationAlphaY

description: Range 0-1, default is 1. Blend contribution to rotation offset in the Y axis in component space.

RotationAlphaZ

description: Range 0-1, default is 1. Blend contribution to rotation offset in the Z axis in component space.


description: A C2 continuous ease out function. Input range, 0-1.

code: namespace PBIK { static float PBIK::CircularEaseOut ( const float & Input ) }


className: FRigidBody

code: struct FRigidBody

ChildLocalPositions

type: TArray< FVector...

Effector

type: FEffector*

J

type: FBoneSettings

Pin

type: FPinConstraint...

SolverSettings

type: constFPBIKSolv...


code: namespace PBIK { enum ELimitType { Free, Limited, Locked, } }


code: namespace PBIK { static PBIK::GLOBAL_UNITS = 100.0f; }


code: namespace PBIK { static PBIK::MIN_MASS = 0.5f; }


description: A long tail ease out function. Input range, 0-1.

code: namespace PBIK { static float PBIK::QuarticEaseOut ( const float & Input ) }


description: For sorting Bodies hierarchically (root to leaf order)

code: namespace PBIK { bool PBIK::operator< ( const [FRigidBody](API\Plugins\PBIK\Core\FRigidBody) & Lhs, const [FRigidBody](API\Plugins\PBIK\Core\FRigidBody) & Rhs ) }


description: An ease out function. Input range, 0-1.

code: namespace PBIK { static float PBIK::SquaredEaseOut ( const float & Input ) }


className: EPBIKLimitType

code: enum EPBIKLimitType { Free, Limited, Locked, }


code: void CopyToCoreStruct ( [PBIK::FBoneSettings](API\Plugins\PBIK\Core\FBoneSettings) & Settings ) const


className: FPBIKBoneSetting

Bone

type: FName

description: The Bone that these settings will be applied to.

bUsePreferredAngles

type: bool

description: When true, this bone will "prefer" to rotate in the direction specified by the Preferred Angles when the chain it belongs to is compressed.

MaxX

type: float

description: Range is 0 to 180 (Default is 0).

MaxY

description: Range is 0 to 180 (Default is 0).

MaxZ

description: Range is 0 to 180 (Default is 0).

MinX

description: Range is -180 to 0 (Default is 0).

MinY

description: Range is -180 to 0 (Default is 0).

MinZ

description: Range is -180 to 0 (Default is 0).

PositionStiffness

description: Range is 0 to 1 (Default is 0).

PreferredAngles

description: The local Euler angles (in degrees) used to rotate this bone when the chain it belongs to is squashed.

RotationStiffness

description: Range is 0 to 1 (Default is 0).

X

type: EPBIKLimitType

description: Limit the rotation angle of the bone on the X axis.

Y

description: Limit the rotation angle of the bone on the Y axis.

Z

description: Limit the rotation angle of the bone on the Z axis.


code: void Draw ( [FRigVMDrawInterface](API\Plugins\RigVM\RigVMCore\FRigVMDrawInterface) * DrawInterface, [FPBIKSolver](API\Plugins\PBIK\Core\FPBIKSolver) * Solver ) const


className: FPBIKDebug

bDrawDebug

description: If true, turns on debug drawing for the node.

DrawScale

description: The scale of the debug drawing.


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


className: FPBIKEffector

Bone

description: The bone that this effector will pull on.

PinRotation

description: Range 0-1 (default is 1.0).

PositionAlpha

description: Range 0-1, default is 1.

PullChainAlpha

description: Range 0-1 (default is 1.0).

RotationAlpha

description: Range 0-1, default is 1.

StrengthAlpha

description: Range 0-1 (default is 1.0).

Transform

type: FTransform

description: The target location and rotation for this effector.


description: IModuleInterfaceimplementation

code: virtual void StartupModule()


className: FPBIKModule

code: class FPBIKModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: FPBIKWorkData

BoneSettingToSolverBoneIndex

type: TArray< int32 >

Solver

type: FPBIKSolver


description: Execute logic for this struct

code: virtual void Execute()


description: Based on a Position Based solver at core, this node can solve multi chains within a root using multi effectors

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)( Meta=(DisplayName="Full Body IK", Category="Hierarchy", Keywords="FBIK, Position Based, PBIK, IK, Full Body, Multi, Effector, N-Chain, FB, HIK, HumanIK", NodeColor="0 1 1")) struct FRigUnit_PBIK : public [FRigUnit_HighlevelBaseMutable](API\Plugins\ControlRig\Units\Highlevel\FRigUnit_HighlevelBaseMutable)

BoneSettings

type: TArray<FPBIKBo...

description: Per-bone settings to control the resulting pose. Includes limits and preferred angles.

Debug

type: FPBIKDebug

description: Debug drawing options.

Effectors

type: TArray<FPBIKEf...

description: An array of effectors. These specify target transforms for different parts of the skeleton.

ExcludedBones

type: TArray<FName>

description: These bones will be excluded from the solver.

Root

description: This is usually the top-most skinned bone; often the "Pelvis" or "Hips", but can be set to any bone.

Settings

type: FPBIKSolverSett...

description: Global solver settings.

WorkData

type: FPBIKWorkData

description: Runtime-only data


description:
Used by the "Sync to Content Browser" right-click menu option in the editor.
Whether the object references content (all overrides of this function should return true)

module: PCG

code: virtual bool GetReferencedContentObjects ( [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & Objects ) const


code: APCGVolume ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )