Navigation
API > API/Plugins > API/Plugins/Party
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
| Name | USocialParty |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineFramework/Source/Party/Public/Party/SocialParty.h |
| Include Path | #include "Party/SocialParty.h" |
Syntax
UCLASS (MinimalAPI, Abstract, Within=SocialManager, Config=Game, Transient)
class USocialParty : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USocialParty
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USocialParty() |
Party/SocialParty.h |
Classes
Structs
| Name | Remarks |
|---|---|
| FPendingMemberApproval |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnInitializationCompletePreNotify | TMulticastDelegate_OneParam< void, USocialParty & > | Party/SocialParty.h | |
| FOnLeavePartyAttemptComplete | TBaseDelegate_OneParam< void, ELeavePartyCompletionResult > | Party/SocialParty.h | |
| FOnRequestJoinInProgressComplete | TBaseDelegate_OneParam< void, const EPartyJoinDenialReason > | Party/SocialParty.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasReceivedRepData | bool | Party/SocialParty.h | ||
| bIsInitialized | bool | Party/SocialParty.h | ||
| bIsLeavingParty | bool | Party/SocialParty.h | ||
| bIsMemberPromotionPossible | bool | Party/SocialParty.h | ||
| bIsMissingPlatformSession | bool | Party/SocialParty.h | ||
| bIsMissingXmppConnection | TOptional< bool > | True when we have limited functionality due to lacking an xmpp connection. | Party/SocialParty.h | |
| bIsRequestingShutdown | TOptional< bool > | Party/SocialParty.h | ||
| bStayWithPartyOnDisconnect | bool | Party/SocialParty.h | ||
| CurrentConfig | FPartyConfiguration | Party/SocialParty.h | ||
| CurrentLeaderId | FUniqueNetIdRepl | Tracked explicitly so we know which player was demoted whenever the leader changes | Party/SocialParty.h | |
| JoinInProgressRequestTimeout | int32 | How long in seconds before join in progress requests timeout and are cleared from member data. | Party/SocialParty.h |
|
| JoinInProgressResponseTimeout | int32 | How long in seconds before join in progress responses are cleared from member data. | Party/SocialParty.h |
|
| JoinInProgressTimerHandle | FTimerHandle | Party/SocialParty.h | ||
| JoinInProgressTimerRate | float | How often the timer should check in seconds for stale data when running. | Party/SocialParty.h |
|
| LastInviteSentById | TMap< FUniqueNetIdRepl, double > | Party/SocialParty.h | ||
| LastReservationBeaconClientNetDriverName | FName | Last known reservation beacon client net driver name Intended to be used to detect network errors related to our current or last reservation beacon client's net driver. | Party/SocialParty.h | |
| LastSpectatorBeaconClientNetDriverName | FName | Last known spectator beacon client net driver name Intended to be used to detect network errors related to our current or last spectator beacon client's net driver. | Party/SocialParty.h | |
| OnInitializationCompletePreNotifyEvent | FOnInitializationCompletePreNotify | Party/SocialParty.h | ||
| OnInviteSentEvent | FOnInviteSent | Party/SocialParty.h | ||
| OnPartyConfigurationChangedEvent | FOnPartyConfigurationChanged | Party/SocialParty.h | ||
| OnPartyDisconnectedEvent | FDisconnectPartyEvent | Party/SocialParty.h | ||
| OnPartyFunctionalityDegradedChangedEvent | FOnPartyFunctionalityDegradedChanged | Party/SocialParty.h | ||
| OnPartyLeaveBeginEvent | FLeavePartyEvent | Party/SocialParty.h | ||
| OnPartyLeftEvent | FLeavePartyEvent | Party/SocialParty.h | ||
| OnPartyMemberConnectionStatusChangedEvent | FOnPartyMemberConnectionStatusChanged | Party/SocialParty.h | ||
| OnPartyMemberCreatedEvent | FOnPartyMemberCreated | Party/SocialParty.h | ||
| OnPartyMemberLeftEvent | FOnPartyMemberLeft | Party/SocialParty.h | ||
| OnPartyStateChangedEvent | FOnPartyStateChanged | Party/SocialParty.h | ||
| OssParty | TSharedPtr< const FOnlineParty > | Party/SocialParty.h | ||
| OwningLocalUserId | FUniqueNetIdRepl | Party/SocialParty.h | ||
| PartyMembersById | TMap< FUniqueNetIdRepl, TObjectPtr< UPartyMember > > | Party/SocialParty.h | ||
| PendingApprovals | TQueue< FPendingMemberApproval > | Party/SocialParty.h | ||
| PlatformUserInviteCooldown | double | Party/SocialParty.h |
|
|
| PrimaryUserInviteCooldown | double | Party/SocialParty.h |
|
|
| RequestJoinInProgressComplete | TOptional< FOnRequestJoinInProgressComplete > | Complete delegate for join in progress requests. This should only have one at a time. | Party/SocialParty.h | |
| ReservationBeaconClient | TWeakObjectPtr< APartyBeaconClient > | Reservation beacon client instance while getting approval for new party members | Party/SocialParty.h | |
| SpectatorBeaconClient | TWeakObjectPtr< ASpectatorBeaconClient > | Spectator beacon client instance while getting approval for spectator | Party/SocialParty.h | |
| UPartyMember | friend | Party/SocialParty.h | ||
| USocialManager | friend | Party/SocialParty.h | ||
| USocialUser | friend | Party/SocialParty.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CancelJoinInProgressRequest() |
Party/SocialParty.h | ||
bool CanInviteUser
(
const USocialUser& User, |
Party/SocialParty.h | ||
bool ContainsUser
(
const USocialUser& User |
Party/SocialParty.h | ||
virtual void DisconnectParty() |
Party/SocialParty.h | ||
FChatRoomId GetChatRoomId() |
Party/SocialParty.h | ||
int32 GetNumPartyMembers() |
Party/SocialParty.h | ||
EPartyState GetOssPartyPreviousState() |
Party/SocialParty.h | ||
EPartyState GetOssPartyState() |
Party/SocialParty.h | ||
MemberT & GetOwningLocalMember() |
Party/SocialParty.h | ||
ULocalPlayer * GetOwningLocalPlayerPtr() |
Party/SocialParty.h | ||
const FUniqueNetIdRepl & GetOwningLocalUserId() |
Party/SocialParty.h | ||
const FOnlinePartyId & GetPartyId() |
Party/SocialParty.h | ||
MemberT * GetPartyLeader() |
Party/SocialParty.h | ||
const FUniqueNetIdRepl & GetPartyLeaderId() |
Party/SocialParty.h | ||
int32 GetPartyMaxSize() |
Party/SocialParty.h | ||
MemberT * GetPartyMember
(
const FUniqueNetIdRepl& MemberId |
Party/SocialParty.h | ||
TArray< MemberT * > GetPartyMembers() |
Party/SocialParty.h | ||
const FOnlinePartyTypeId & GetPartyTypeId() |
Party/SocialParty.h | ||
const FPartyPrivacySettings & GetPrivacySettings() |
Party/SocialParty.h | ||
FPartyJoinDenialReason GetPublicJoinability() |
Party/SocialParty.h | ||
const FPartyRepData & GetRepData() |
Party/SocialParty.h | ||
SocialManagerT & GetSocialManager() |
Party/SocialParty.h | ||
bool IsCurrentlyCrossplaying() |
Party/SocialParty.h | ||
bool IsCurrentlyLeaving() |
Party/SocialParty.h | ||
bool IsJoinInProgeressRequestActive() |
Party/SocialParty.h | ||
bool IsLeavingParty() |
Party/SocialParty.h | ||
bool IsLocalPlayerPartyLeader() |
Party/SocialParty.h | ||
bool IsNetDriverFromReservationBeacon
(
const UNetDriver* InNetDriver |
Is the specified net driver for our reservation beacon? | Party/SocialParty.h | |
bool IsPartyFull() |
Party/SocialParty.h | ||
bool IsPartyFunctionalityDegraded() |
Party/SocialParty.h | ||
bool IsPartyLeader
(
const ULocalPlayer& LocalPlayer |
Party/SocialParty.h | ||
bool IsPartyLeaderLocal() |
Party/SocialParty.h | ||
bool IsPersistentParty() |
Party/SocialParty.h | ||
virtual void JoinSessionCompleteAnalytics
(
const FSessionId& SessionId, |
Party/SocialParty.h | ||
virtual void LeaveParty
(
const FOnLeavePartyAttemptComplete& OnLeaveAttemptComplete |
Party/SocialParty.h | ||
FOnInitializationCompletePreNotify & OnInitializationCompletePreNotify() |
Party/SocialParty.h | ||
FOnInviteSent & OnInviteSent() |
Party/SocialParty.h | ||
FOnPartyConfigurationChanged & OnPartyConfigurationChanged() |
Party/SocialParty.h | ||
FDisconnectPartyEvent & OnPartyDisconnected() |
Party/SocialParty.h | ||
FOnPartyFunctionalityDegradedChanged & OnPartyFunctionalityDegradedChanged() |
Party/SocialParty.h | ||
FLeavePartyEvent & OnPartyLeaveBegin() |
Party/SocialParty.h | ||
FLeavePartyEvent & OnPartyLeft() |
Party/SocialParty.h | ||
FOnPartyMemberConnectionStatusChanged & OnPartyMemberConnectionStatusChanged() |
Party/SocialParty.h | ||
FOnPartyMemberCreated & OnPartyMemberCreated() |
Party/SocialParty.h | ||
FOnPartyMemberLeft & OnPartyMemberLeft() |
Party/SocialParty.h | ||
FOnPartyStateChanged & OnPartyStateChanged() |
Party/SocialParty.h | ||
void RefreshPublicJoinability() |
Re-evaluates whether this party is joinable by anyone and, if not, establishes the reason why | Party/SocialParty.h | |
virtual void RemoveLocalMember
(
const FUniqueNetIdRepl& LocalUserId, |
Party/SocialParty.h | ||
void RequestJoinInProgress
(
const UPartyMember& TargetMember, |
Party/SocialParty.h | ||
void ResetPrivacySettings() |
Party/SocialParty.h | ||
void SetPartyMaxSize
(
int32 NewSize |
Party/SocialParty.h | ||
virtual bool ShouldAlwaysJoinPlatformSession
(
const FSessionId& SessionId |
Party/SocialParty.h | ||
FString ToDebugString() |
Party/SocialParty.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AllowJoinInProgressToMember() |
Party/SocialParty.h | ||
bool ApplyCrossplayRestriction
(
FPartyJoinApproval& JoinApproval, |
Party/SocialParty.h | ||
virtual ESocialPartyInviteFailureReason CanInviteUserInternal
(
const USocialUser& User, |
Virtual versions of the package-scoped "CanX" methods above, as a virtual declared within package scoping cannot link (exported public, imported protected) | Party/SocialParty.h | |
virtual bool CanKickMember
(
const ULocalPlayer& PerformingPlayer, |
Party/SocialParty.h | ||
virtual bool CanKickMemberInternal
(
const ULocalPlayer& PerformingPlayer, |
Party/SocialParty.h | ||
bool CanPromoteMember
(
const ULocalPlayer& PerformingPlayer, |
Party/SocialParty.h | ||
virtual bool CanPromoteMemberInternal
(
const ULocalPlayer& PerformingPlayer, |
Party/SocialParty.h | ||
void CleanupReservationBeacon() |
Party/SocialParty.h | ||
void CleanupSpectatorBeacon() |
Create a spectator beacon and connect to the server to get approval for new spectators | Party/SocialParty.h | |
void ConnectToReservationBeacon() |
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 | Party/SocialParty.h | |
APartyBeaconClient * CreateReservationBeaconClient() |
Party/SocialParty.h | ||
ASpectatorBeaconClient * CreateSpectatorBeaconClient() |
Party/SocialParty.h | ||
virtual FPartyJoinDenialReason DetermineCurrentJoinability() |
Determines the reason why, if at all, this party is currently flat-out unjoinable | Party/SocialParty.h | |
virtual FPartyJoinApproval EvaluateJoinRequest
(
const TArray< IOnlinePartyUserPendingJoinRequestInfoConstRef >& Players, |
Determines the joinability of this party for a group of users requesting to join | Party/SocialParty.h | |
FPartyConfiguration & GetCurrentConfiguration() |
Party/SocialParty.h | ||
virtual TSubclassOf< UPartyMember > GetDesiredMemberClass
(
bool bLocalPlayer |
Override in child classes to specify the type of UPartyMember to create | Party/SocialParty.h | |
virtual FPartyPrivacySettings GetDesiredPrivacySettings() |
Party/SocialParty.h | ||
FName GetGameSessionName() |
Party/SocialParty.h | ||
| Override in child classes to provide extra invite metadata. | Party/SocialParty.h | ||
virtual TArray< UPartyMember * > GetLocalPartyMembersForJoinInProgress() |
The list of party members to send the request for joining in progress. | Party/SocialParty.h | |
FPartyRepData & GetMutableRepData() |
Party/SocialParty.h | ||
APartyBeaconClient * GetReservationBeaconClient() |
Party/SocialParty.h | ||
ASpectatorBeaconClient * GetSpectatorBeaconClient() |
Party/SocialParty.h | ||
virtual void HandlePartyStateChanged
(
const FUniqueNetId& LocalUserId, |
Party/SocialParty.h | ||
virtual void HandlePartySystemStateChange
(
EPartySystemState NewState |
Party/SocialParty.h | ||
virtual void HandlePrivacySettingsChanged
(
const FPartyPrivacySettings& NewPrivacySettings |
Party/SocialParty.h | ||
bool HasUserBeenInvited
(
const USocialUser& User |
User/member-specific actions that are best exposed on the individuals themselves, but best handled by the actual party. | Party/SocialParty.h | |
virtual bool InitializeBeaconEncryptionData
(
AOnlineBeaconClient& BeaconClient, |
Override in child classes to provide encryption data for party beacon connections. | Party/SocialParty.h | |
void InitializeParty
(
const TSharedRef< const FOnlineParty >& InOssParty |
Party/SocialParty.h | ||
virtual void InitializePartyInternal() |
Party/SocialParty.h | ||
virtual void InitializePartyRepData () |
Only called when a new party is being created by the local player and they are responsible for the rep data. | Party/SocialParty.h | |
bool IsInitialized() |
Party/SocialParty.h | ||
bool IsInRestrictedGameSession() |
Party/SocialParty.h | ||
bool IsInviteRateLimited
(
const USocialUser& User, |
Party/SocialParty.h | ||
bool IsMissingPlatformSession() |
Party/SocialParty.h | ||
virtual void OnInviteSentInternal
(
ESocialSubsystem SubsystemType, |
Party/SocialParty.h | ||
virtual void OnInviteSentInternal
(
ESocialSubsystem SubsystemType, |
Party/SocialParty.h | ||
virtual void OnInviteSentInternal
(
ESocialSubsystem SubsystemType, |
Party/SocialParty.h | ||
virtual void OnLeftPartyInternal
(
EMemberExitedReason Reason |
Party/SocialParty.h | ||
virtual void OnLocalPlayerIsLeaderChanged
(
bool bIsLeader |
Party/SocialParty.h | ||
virtual void OnMemberCreatedInternal
(
UPartyMember& NewMember |
Party/SocialParty.h | ||
void SetIsMissingPlatformSession
(
bool bInIsMissingPlatformSession |
Party/SocialParty.h | ||
void TryFinishInitialization() |
Party/SocialParty.h | ||
bool TryInviteUser
(
const USocialUser& UserToInvite, |
Party/SocialParty.h | ||
virtual bool TryKickMember
(
const ULocalPlayer& PerformingPlayer, |
Party/SocialParty.h | ||
bool TryPromoteMember
(
const ULocalPlayer& PerformingPlayer, |
Party/SocialParty.h | ||
void UpdatePartyConfig
(
bool bResetAccessKey |
Apply local party configuration to the OSS party, optionally resetting the access key to the party in the process | Party/SocialParty.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FPartyPrivacySettings GetPrivacySettingsForConfig
(
const FPartyConfiguration& PartyConfig |
Party/SocialParty.h | ||
static bool IsJoiningDuringLoadEnabled() |
Party/SocialParty.h |