Skip to main content
Version: 4.24

Online Party Subsystem

This API reference documents what methods and events are supported by Online Subsystem Blueprints. For full documentation on this API, refer to the Unreal Engine documentation.

Need to use a method or event that's not currently supported? Please reach out to support.

Supported Events#

EventSupported?Unreal Engine DocsParameters
OnPartyJoined‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
OnPartyExited‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
OnPartyStateChanged‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
EPartyState State
EPartyState PreviousState
OnPartyJIP‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
bool Success
OnPartyPromotionLockoutChanged‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const bool bLockoutState
OnPartyConfigChanged DetailsOnPartyConfigChangedConst 
const FUniqueNetId& LocalUserId
const FOnlinePartyId& PartyId
const FPartyConfiguration& PartyConfig
OnPartyDataReceived DetailsOnPartyDataReceivedConst 
const FUniqueNetId& LocalUserId
const FOnlinePartyId& PartyId
const FOnlinePartyData& PartyData
OnPartyMemberPromoted‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& NewLeaderId
OnPartyMemberExited‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& MemberId
const EMemberExitedReason Reason
OnPartyMemberJoined‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& MemberId
OnPartyMemberDataReceived DetailsOnPartyMemberDataReceivedConst 
const FUniqueNetId& LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& MemberId
const FOnlinePartyData& PartyData
OnPartyInvitesChanged‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
OnPartyInviteRequestReceived‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& SenderId
const FUniqueNetId& RequestForId
OnPartyInviteReceived‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& SenderId
OnPartyInviteRemoved Detailsconst FUniqueNetId& LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& SenderId
EPartyInvitationRemovedReason Reason
OnPartyInviteResponseReceived Detailsconst FUniqueNetId& LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& SenderId
const EInvitationResponse Response
OnPartyJoinRequestReceived‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& SenderId
const FString& Platform
const FOnlinePartyData& PartyData
OnPartyJIPRequestReceived‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& SenderId
OnQueryPartyJoinabilityReceived‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& SenderId
const FString& Platform
const FOnlinePartyData& PartyData
OnFillPartyJoinRequestData‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
FOnlinePartyData& PartyData
OnPartyAnalyticsEvent Detailsconst FUniqueNetId& LocalUserId
const FString& EventName
const TArray<FAnalyticsEventAttribute>& Attributes
OnPartySystemStateChange DetailsEPartySystemState NewState

Supported Functions#

FunctionSupported?Unreal Engine DocsParameters
RestoreParties‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†LocalUserId
RestoreInvites‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†LocalUserId
CleanupParties‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†LocalUserId
CreateParty‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyTypeId PartyTypeId
const FPartyConfiguration& PartyConfig
UpdateParty‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FPartyConfiguration& PartyConfig
bool bShouldRegenerateReservationKey
JoinParty‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†LocalUserId
const IOnlinePartyJoinInfo& OnlinePartyJoinInfo
JIPFromWithinParty‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& PartyLeaderId
QueryPartyJoinability‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†LocalUserId
const IOnlinePartyJoinInfo& OnlinePartyJoinInfo
RejoinParty‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FOnlinePartyTypeId& PartyTypeId
const TArray<TSharedRef<const FUniqueNetId>>& FormerMembers
LeaveParty„ÄįDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
LeaveParty‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
bool bSynchronizeLeave
ApproveJoinRequest‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& RecipientId
bool bIsApproved
int32 DeniedResultCode
ApproveJIPRequest‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& RecipientId
bool bIsApproved
int32 DeniedResultCode
RespondToQueryJoinability‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& RecipientId
bool bCanJoin
int32 DeniedResultCode
SendInvitation‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FPartyInvitationRecipient& Recipient
RejectInvitation‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FUniqueNetId& SenderId
ClearInvitations Detailsconst FUniqueNetId& LocalUserId
const FUniqueNetId& SenderId
const FOnlinePartyId* PartyId
KickMember‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& TargetMemberId
PromoteMember‚úĒ¬†ūüēĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& TargetMemberId
UpdatePartyData‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FOnlinePartyData& PartyData
UpdatePartyMemberData‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FOnlinePartyData& PartyMemberData
IsMemberLeader‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& MemberId
GetPartyMemberCount‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
GetParty‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
GetParty„ÄįDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyTypeId& PartyTypeId
GetPartyMember‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& MemberId
GetPartyData‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
GetPartyMemberData‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
const FUniqueNetId& MemberId
GetAdvertisedParty Detailsconst FUniqueNetId& LocalUserId
const FUniqueNetId& UserId
const FOnlinePartyTypeId PartyTypeId
GetJoinedParties‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
TArray<TSharedRef<const FOnlinePartyId>>& OutPartyIdArray
GetPartyMembers‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
TArray<FOnlinePartyMemberConstRef>& OutPartyMembersArray
GetPartyMembers Detailsconst FUniqueNetId& LocalUserId
const FOnlinePartyId& PartyId
TArray<TSharedRef<FOnlinePartyMember>>& OutPartyMembersArray
GetPendingInvites‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
TArray<IOnlinePartyJoinInfoConstRef>& OutPendingInvitesArray
GetPendingInvites Detailsconst FUniqueNetId& LocalUserId
TArray<TSharedRef<IOnlinePartyJoinInfo>>& OutPendingInvitesArray
GetPendingJoinRequests Detailsconst FUniqueNetId& LocalUserId
const FOnlinePartyId& PartyId
TArray<IOnlinePartyPendingJoinRequestInfoConstRef>& OutPendingJoinRequestArray
GetPendingJoinRequests Detailsconst FUniqueNetId& LocalUserId
const FOnlinePartyId& PartyId
TArray<TSharedRef<IOnlinePartyPendingJoinRequestInfo>>& OutPendingJoinRequestArray
GetPendingInvitedUsers‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
TArray<TSharedRef<const FUniqueNetId>>& OutPendingInvitedUserArray
MakeJoinInfoJson‚úĒDetailsconst FUniqueNetId&¬†LocalUserId
const FOnlinePartyId& PartyId
MakeJoinInfoFromJson Detailsconst FString& JoinInfoJson
MakeTokenFromJoinInfo‚úĒDetailsconst IOnlinePartyJoinInfo&¬†JoinInfo
MakeJoinInfoFromToken Detailsconst FString& Token
ConsumePendingCommandLineInvite Details
DumpPartyState‚úĒDetails