Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Party > Party > USocialParty

Light Theme

Dark Theme

USocialParty

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USocialParty

References

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

Syntax

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

Remarks

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

Variables

	Name	Description
FPartyDataRepli...	PartyDataReplicator	Child classes MUST call EstablishRepDataInstance() on this using their member rep data struct instance
TSubclassOf< AP...	ReservationBeaconClientClass	Reservation beacon class for getting server approval for new party members while in a game
TSubclassOf< AS...	SpectatorBeaconClientClass	Spectator beacon class for getting server approval for new spectators while in a game

Constructors

	Name	Description
	USocialParty()

Functions

	Name	Description
bool	ApplyCrossplayRestriction ( FPartyJoinApproval& JoinApproval, const FUserPlatform& Platform, const FOnlinePartyData& JoinData )
bool	CanInviteUser ( const USocialUser& User )
bool	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)
bool	CanKickMember ( const UPartyMember& PartyMember )
bool	CanKickMemberInternal ( const UPartyMember& PartyMember )
bool	CanPromoteMember ( const UPartyMember& PartyMember )
bool	CanPromoteMemberInternal ( const UPartyMember& PartyMember )
void	CleanupReservationBeacon()
void	CleanupSpectatorBeacon()
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
void	ConnectToSpectatorBeacon()	Create a spectator beacon and connect to the server to get approval for new spectators
bool	ContainsUser ( const USocialUser& User )
APartyBeacon...	CreateReservationBeaconClient()
ASpectatorBe...	CreateSpectatorBeaconClient()
FPartyJoinDe...	DetermineCurrentJoinability()	Determines the reason why, if at all, this party is currently flat-out unjoinable
void	DisconnectParty()
FPartyJoinAp...	EvaluateJIPRequest ( const FUniqueNetId& PlayerId )	Determines the joinability of the game a party is in for JoinInProgress
FPartyJoinAp...	EvaluateJoinRequest ( const TArray< IOnlinePartyUserPendi..., bool bFromJoinRequest )	Determines the joinability of this party for a group of users requesting to join
FChatRoomId	GetChatRoomId()
FPartyConfig...	GetCurrentConfiguration()
TSubclassOf<...	GetDesiredMemberClass ( bool bLocalPlayer )	Override in child classes to specify the type of UPartyMember to create
FPartyPrivac...	GetDesiredPrivacySettings()
FName	GetGameSessionName()
FPartyRepDat...	GetMutableRepData()
int32	GetNumPartyMembers()
EPartyState	GetOssPartyPreviousState()
EPartyState	GetOssPartyState()
MemberT &	GetOwningLocalMember()
ULocalPlayer...	GetOwningLocalPlayer()
const FUniqu...	GetOwningLocalUserId()
const FOnlin...	GetPartyId()
MemberT *...	GetPartyLeader()
const FUniqu...	GetPartyLeaderId()
int32	GetPartyMaxSize()
MemberT *...	GetPartyMember ( const FUniqueNetIdRepl& MemberId )
TArray< Memb...	GetPartyMembers()
const FOnlin...	GetPartyTypeId()
const FParty...	GetPrivacySettings()
FPartyJoinDe...	GetPublicJoinability()
const FParty...	GetRepData()
APartyBeacon...	GetReservationBeaconClient()
SocialManage...	GetSocialManager()
ASpectatorBe...	GetSpectatorBeaconClient()
void	HandlePartySystemStateChange ( EPartySystemState NewState )
void	HandlePrivacySettingsChanged ( const FPartyPrivacySettings& NewPr... )
bool	HasUserBeenInvited ( const USocialUser& User )	User/member-specific actions that are best exposed on the individuals themselves, but best handled by the actual party (thus the package scoping)
void	InitializeParty ( const TSharedRef< const FOnlinePart... )
void	InitializePartyInternal()
void	InitializePartyRepData()	Only called when a new party is being created by the local player and they are responsible for the rep data.
bool	IsCurrentlyCrossplaying()
bool	IsCurrentlyLeaving()
bool	IsInitialized()
bool	IsInRestrictedGameSession()
bool	IsJoiningDuringLoadEnabled()
bool	IsLeavingParty()
bool	IsLocalPlayerPartyLeader()
bool	IsNetDriverFromReservationBeacon ( const UNetDriver* InNetDriver )	Is the specified net driver for our reservation beacon?
bool	IsPartyFull()
bool	IsPartyFunctionalityDegraded()
bool	IsPartyLeader ( const ULocalPlayer& LocalPlayer )
bool	IsPartyLeaderLocal()
bool	IsPersistentParty()
void	LeaveParty ( const FOnLeavePartyAttemptComplete ... )
FOnInviteSen...	OnInviteSent()
void	OnInviteSentInternal ( ESocialSubsystem SubsystemType, const USocialUser& InvitedUser, bool bWasSuccessful )
void	OnLeftPartyInternal ( EMemberExitedReason Reason )
void	OnLocalPlayerIsLeaderChanged ( bool bIsLeader )
void	OnMemberCreatedInternal ( UPartyMember& NewMember )
FOnPartyConf...	OnPartyConfigurationChanged()
FDisconnectP...	OnPartyDisconnected()
FOnPartyFunc...	OnPartyFunctionalityDegradedChanged()
FOnPartyJIPA...	OnPartyJIPApproved()
FLeavePartyE...	OnPartyLeaveBegin()
FLeavePartyE...	OnPartyLeft()
FOnPartyMemb...	OnPartyMemberConnectionStatusChanged()
FOnPartyMemb...	OnPartyMemberCreated()
FOnPartyStat...	OnPartyStateChanged()
void	RefreshPublicJoinability()	Re-evaluates whether this party is joinable by anyone and, if not, establishes the reason why
void	RemoveLocalMember ( const FUniqueNetIdRepl& LocalUserI..., const FOnLeavePartyAttemptComplete ... )
void	SetIsMissingPlatformSession ( bool bInIsMissingPlatformSession )
void	SetPartyMaxSize ( int32 NewSize )
bool	ShouldCacheForRejoinOnDisconnect()
FString	ToDebugString()
void	TryFinishInitialization()
bool	TryInviteUser ( const USocialUser& UserToInvite )
bool	TryKickMember ( const UPartyMember& PartyMember )
bool	TryPromoteMember ( const UPartyMember& PartyMember )
void	UpdatePartyConfig ( bool bResetAccessKey )	Apply local party configuration to the OSS party, optionally resetting the access key to the party in the process

Classes

	Name	Description
	FDisconnectPartyEvent
	FLeavePartyEvent
	FOnInviteSent
	FOnPartyConfigurationChanged
	FOnPartyFunctionalityDegradedChanged
	FOnPartyJIPApproved
	FOnPartyMemberConnectionStatusChanged
	FOnPartyMemberCreated
	FOnPartyStateChanged

Typedefs

Name	Description
FOnLeavePartyAttemptComplete

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

Take our survey

Dismiss