IOnlinePartySystem

Interface definition for the online party services Allows for forming a party and communicating with party members

Windows
MacOS
Linux

References

Module

OnlineSubsystem

Header

/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlinePartyInterface.h

Include

#include "Interfaces/OnlinePartyInterface.h"

Syntax

class IOnlinePartySystem

Remarks

Interface definition for the online party services Allows for forming a party and communicating with party members

Variables

Name Description

Public variable

FOnFillPartyJoi ...

 

OnFillPartyJoinRequestDataDelegates

Notification when a player wants to know if the party is in a joinable state Subscriber is expected to call RespondToQueryJoinability

Public variable

FOnPartyAnalyti ...

 

OnPartyAnalyticsEventDelegates

Notification when an analytics event needs to be recorded Subscriber is expected to record the event

Public variable

FOnPartyConfigC ...

 

OnPartyConfigChangedDelegates

Notification when party data is updated

Public variable

FOnPartyDataRec ...

 

OnPartyDataReceivedDelegates

Notification when party data is updated

Public variable

FOnPartyExited

 

OnPartyExitedDelegates

Notification of when a party is exited

Public variable

FOnPartyInviteR ...

 

OnPartyInviteReceivedDelegates

Notification when a new invite is received

Public variable

FOnPartyInviteR ...

 

OnPartyInviteRemovedDelegates

Notification when an invite has been removed

Public variable

FOnPartyInviteR ...

 

OnPartyInviteRequestReceivedDelegates

Notification when a request for an invite has been received

Public variable

FOnPartyInviteR ...

 

OnPartyInviteResponseReceivedDelegates

Notification when an invitation response is received

Public variable

FOnPartyInvites ...

 

OnPartyInvitesChangedDelegates

Notification when an invite list has changed for a party

Public variable

FOnPartyJIP

 

OnPartyJIPDelegates

Notification of when a player had been approved to Join In Progress

Public variable

FOnPartyJIPRequ ...

 

OnPartyJIPRequestReceivedDelegates

Notification when a new reservation request is received Subscriber is expected to call ApproveJoinRequest

Public variable

FOnPartyJoined

 

OnPartyJoinedDelegates

List of all subscribe-able notifications

Public variable

FOnPartyJoinReq ...

 

OnPartyJoinRequestReceivedDelegates

Notification when a new reservation request is received Subscriber is expected to call ApproveJoinRequest

Public variable

FOnPartyMemberD ...

 

OnPartyMemberDataReceivedDelegates

Notification when party member data is updated

Public variable

FOnPartyMemberE ...

 

OnPartyMemberExitedDelegates

Notification when a member exits a party

Public variable

FOnPartyMemberJ ...

 

OnPartyMemberJoinedDelegates

Notification when a member joins the party

Public variable

FOnPartyMemberP ...

 

OnPartyMemberPromotedDelegates

Notification when a member is promoted in a party

Public variable

FOnPartyPromoti ...

 

OnPartyPromotionLockoutChangedDelegates

Notification when player promotion is locked out.

Public variable

FOnPartyStateCh ...

 

OnPartyStateChangedDelegates

Notification when a party's state has changed

Public variable

FOnPartySystemS ...

 

OnPartySystemStateChangeDelegates

Notification of party system state change

Public variable

FOnQueryPartyJo ...

 

OnQueryPartyJoinabilityReceivedDelegates

Notification when a player wants to know if the party is in a joinable state Subscriber is expected to call RespondToQueryJoinability

Constructors

Name Description

Protected function

IOnlinePartySystem()

Destructors

Name Description

Public function Virtual

~IOnlinePartySystem()

Functions

Name Description

Public function Virtual

FDelegateHan ...

 

AddOnFillPartyJoinRequestDataDelegate_Handle

(
    const FOnFillPartyJoinRequestDataDe ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyAnalyticsEventDelegate_Handle

(
    const FOnPartyAnalyticsEventDelegat ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyConfigChangedDelegate_Handle

(
    const FOnPartyConfigChangedDelegate ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyDataReceivedDelegate_Handle

(
    const FOnPartyDataReceivedDelegate ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyExitedDelegate_Handle

(
    const FOnPartyExitedDelegate & Dele...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyInviteReceivedDelegate_Handle

(
    const FOnPartyInviteReceivedDelegat ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyInviteRemovedDelegate_Handle

(
    const FOnPartyInviteRemovedDelegate ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyInviteRequestReceivedDelegate_Handle

(
    const FOnPartyInviteRequestReceived ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyInviteResponseReceivedDelegate_Handle

(
    const FOnPartyInviteResponseReceive ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyInvitesChangedDelegate_Handle

(
    const FOnPartyInvitesChangedDelegat ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyJIPDelegate_Handle

(
    const FOnPartyJIPDelegate & Delegat...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyJIPRequestReceivedDelegate_Handle

(
    const FOnPartyJIPRequestReceivedDel ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyJoinedDelegate_Handle

(
    const FOnPartyJoinedDelegate & Dele...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyJoinRequestReceivedDelegate_Handle

(
    const FOnPartyJoinRequestReceivedDe ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyMemberDataReceivedDelegate_Handle

(
    const FOnPartyMemberDataReceivedDel ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyMemberExitedDelegate_Handle

(
    const FOnPartyMemberExitedDelegate ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyMemberJoinedDelegate_Handle

(
    const FOnPartyMemberJoinedDelegate ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyMemberPromotedDelegate_Handle

(
    const FOnPartyMemberPromotedDelegat ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyPromotionLockoutChangedDelegate_Handle

(
    const FOnPartyPromotionLockoutChang ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartyStateChangedDelegate_Handle

(
    const FOnPartyStateChangedDelegate ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPartySystemStateChangeDelegate_Handle

(
    const FOnPartySystemStateChangeDele ...
)

Public function Virtual

FDelegateHan ...

 

AddOnQueryPartyJoinabilityReceivedDelegate_Handle

(
    const FOnQueryPartyJoinabilityRecei ...
)

Public function

bool

 

ApproveJIPRequest

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FUniqueNetId & RecipientId,
    bool bIsApproved,
    int32 DeniedResultCode
)

Approve a request to join the JIP match a party is in.

Public function

bool

 

ApproveJoinRequest

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FUniqueNetId & RecipientId,
    bool bIsApproved,
    int32 DeniedResultCode
)

Approve a request to join a party

Public function

void

 

CleanupParties

(
    const FUniqueNetId & LocalUserId,
    const FOnCleanupPartiesComplete & C...
)

Cleanup party state.

Public function

void

 

ClearInvitations

(
    const FUniqueNetId & LocalUserId,
    const FUniqueNetId & SenderId,
    const FOnlinePartyId * PartyId
)

Clear invitations from a user because the invitations were handled by the application

Public function Virtual

void

 

ClearOnFillPartyJoinRequestDataDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnFillPartyJoinRequestDataDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyAnalyticsEventDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyAnalyticsEventDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyConfigChangedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyConfigChangedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyDataReceivedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyDataReceivedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyExitedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyExitedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyInviteReceivedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyInviteReceivedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyInviteRemovedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyInviteRemovedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyInviteRequestReceivedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyInviteRequestReceivedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyInviteResponseReceivedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyInviteResponseReceivedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyInvitesChangedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyInvitesChangedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyJIPDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyJIPDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyJIPRequestReceivedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyJIPRequestReceivedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyJoinedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyJoinedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyJoinRequestReceivedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyJoinRequestReceivedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyMemberDataReceivedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyMemberDataReceivedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyMemberExitedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyMemberExitedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyMemberJoinedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyMemberJoinedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyMemberPromotedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyMemberPromotedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyPromotionLockoutChangedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyPromotionLockoutChangedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartyStateChangedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartyStateChangedDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnPartySystemStateChangeDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPartySystemStateChangeDelegates

(
    void * Object
)

Public function Virtual

void

 

ClearOnQueryPartyJoinabilityReceivedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnQueryPartyJoinabilityReceivedDelegates

(
    void * Object
)

Public function

IOnlineParty ...

 

ConsumePendingCommandLineInvite()

Checks to see if there is a pending command line invite and consumes it

Public function

bool

 

CreateParty

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyTypeId PartyTypeI...,
    const FPartyConfiguration & PartyCo...,
    const FOnCreatePartyComplete & Dele...
)

Create a new party

Public function

void

 

DumpPartyState()

Dump out party state for all known parties

Public function Const

IOnlineParty ...

 

GetAdvertisedParty

(
    const FUniqueNetId & LocalUserId,
    const FUniqueNetId & UserId,
    const FOnlinePartyTypeId PartyTypeI...
)

Get the join info of the specified user and party type

Public function Const

bool

 

GetJoinedParties

(
    const FUniqueNetId & LocalUserId,
    TArray < TSharedRef < const FOnlinePa ...
)

Get a list of currently joined parties for the user

Public function Const

FOnlineParty ...

 

GetParty

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyTypeId & PartyTyp...
)

Get info associated with a party

Public function Const

FOnlineParty ...

 

GetParty

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId
)

Get info associated with a party

Public function Const

FOnlineParty ...

 

GetPartyData

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FName & Namespace
)

Get current cached data associated with a party FOnPartyDataReceived notification called whenever this data changes

Public function Const

FOnlineParty ...

 

GetPartyMember

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FUniqueNetId & MemberId
)

Get a party member by id

Public function Const

uint32

 

GetPartyMemberCount

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId
)

Returns the number of players in a given party

Public function Const

FOnlineParty ...

 

GetPartyMemberData

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FUniqueNetId & MemberId,
    const FName & Namespace
)

Get current cached data associated with a party member FOnPartyMemberDataReceived notification called whenever this data changes

Public function Const

bool

 

GetPartyMembers

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    TArray < FOnlinePartyMemberConstRef ...
)

Get list of current party members

Public function Const

bool

 

GetPendingInvitedUsers

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    TArray < TSharedRef < const FUniqueNe ...
)

Get list of users invited to a party that have not yet responded

Public function Const

bool

 

GetPendingInvites

(
    const FUniqueNetId & LocalUserId,
    TArray < IOnlinePartyJoinInfoConstRe ...
)

Get a list of parties the user has been invited to

Public function Const

bool

 

GetPendingJoinRequests

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    TArray < IOnlinePartyPendingJoinRequ ...
)

Get list of users requesting to join the party

Public function Static

const FOnlin ...

 

GetPrimaryPartyTypeId()

Public function Const

bool

 

IsMemberLeader

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FUniqueNetId & MemberId
)

Returns true if the user specified by MemberId is the leader of the party specified by PartyId

Public function

bool

 

JIPFromWithinParty

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FUniqueNetId & PartyLeaderId
)

Join an existing game session from within a party

Public function

bool

 

JoinParty

(
    const FUniqueNetId & LocalUserId,
    const IOnlinePartyJoinInfo & Online...,
    const FOnJoinPartyComplete & Delega...
)

Join an existing party

Public function

bool

 

KickMember

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FUniqueNetId & TargetMemberId,
    const FOnKickPartyMemberComplete & ...
)

Kick a user from an existing party Only admin can kick a party member

Public function

bool

 

LeaveParty

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FOnLeavePartyComplete & Deleg...
)

Leave an existing party All existing party members notified of member leaving (see FOnPartyMemberLeft)

Public function

bool

 

LeaveParty

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    bool bSynchronizeLeave,
    const FOnLeavePartyComplete & Deleg...
)

Leave an existing party All existing party members notified of member leaving (see FOnPartyMemberLeft)

Public function

IOnlineParty ...

 

MakeJoinInfoFromJson

(
    const FString & JoinInfoJson
)

Returns a valid join info object from a json blob

Public function Const

IOnlineParty ...

 

MakeJoinInfoFromToken

(
    const FString & Token
)

Creates a IOnlinePartyJoinInfo object from a command line token

Public function

FString

 

MakeJoinInfoJson

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId
)

Returns the json version of a join info for a current party

Public function Static

const FOnlin ...

 

MakePartyTypeId

(
    const FOnlinePartyTypeId::TInternal ...
)

Public function Const

FString

 

MakeTokenFromJoinInfo

(
    const IOnlinePartyJoinInfo & JoinIn...
)

Creates a command line token from a IOnlinePartyJoinInfo object

Public function

bool

 

PromoteMember

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FUniqueNetId & TargetMemberId,
    const FOnPromotePartyMemberComplete ...
)

Promote a user from an existing party to be admin All existing party members notified of promoted member (see FOnPartyMemberPromoted)

Public function

void

 

QueryPartyJoinability

(
    const FUniqueNetId & LocalUserId,
    const IOnlinePartyJoinInfo & Online...,
    const FOnQueryPartyJoinabilityCompl ...
)

Query a party to check it's current joinability Intended to be used before a call to LeaveParty (to leave your existing party, which would then be followed by JoinParty) Note that the party's joinability can change from moment to moment so a successful response for this does not guarantee a successful JoinParty

Public function

bool

 

RejectInvitation

(
    const FUniqueNetId & LocalUserId,
    const FUniqueNetId & SenderId
)

Reject an invite to a party

Public function

bool

 

RejoinParty

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FOnlinePartyTypeId & PartyTyp...,
    const TArray < TSharedRef < const FUn ...,
    const FOnJoinPartyComplete & Delega...
)

Attempt to rejoin a former party

Public function

void

 

RespondToQueryJoinability

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FUniqueNetId & RecipientId,
    bool bCanJoin,
    int32 DeniedResultCode
)

Respond to a query joinability request.

Public function

void

 

RestoreInvites

(
    const FUniqueNetId & LocalUserId,
    const FOnRestoreInvitesComplete & C...
)

Restore party invites.

Public function

void

 

RestoreParties

(
    const FUniqueNetId & LocalUserId,
    const FOnRestorePartiesComplete & C...
)

Restore party memberships.

Public function

bool

 

SendInvitation

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FPartyInvitationRecipient & R...,
    const FOnSendPartyInvitationComplet ...
)

Sends an invitation to a user that could not otherwise join a party if the player accepts the invite they will be sent the data needed to trigger a call to RequestReservation

Public function Virtual

void

 

TriggerOnFillPartyJoinRequestDataDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    FOnlinePartyData & Param3
)

Public function Virtual

void

 

TriggerOnPartyAnalyticsEventDelegates

(
    const FUniqueNetId & Param1,
    const FString & Param2,
    const TArray < FAnalyticsEventAttrib ...
)

Public function Virtual

void

 

TriggerOnPartyConfigChangedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const FPartyConfiguration & Param3
)

Public function Virtual

void

 

TriggerOnPartyDataReceivedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const FName & Param3,
    const FOnlinePartyData & Param4
)

Public function Virtual

void

 

TriggerOnPartyExitedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2
)

Public function Virtual

void

 

TriggerOnPartyInviteReceivedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const FUniqueNetId & Param3
)

Public function Virtual

void

 

TriggerOnPartyInviteRemovedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const FUniqueNetId & Param3,
    EPartyInvitationRemovedReason Param...
)

Public function Virtual

void

 

TriggerOnPartyInviteRequestReceivedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const FUniqueNetId & Param3,
    const FUniqueNetId & Param4
)

Public function Virtual

void

 

TriggerOnPartyInviteResponseReceivedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const FUniqueNetId & Param3,
    const EInvitationResponse Param4
)

Public function Virtual

void

 

TriggerOnPartyInvitesChangedDelegates

(
    const FUniqueNetId & Param1
)

Public function Virtual

void

 

TriggerOnPartyJIPDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    bool Param3
)

Public function Virtual

void

 

TriggerOnPartyJIPRequestReceivedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const FUniqueNetId & Param3
)

Public function Virtual

void

 

TriggerOnPartyJoinedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2
)

Public function Virtual

void

 

TriggerOnPartyJoinRequestReceivedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const IOnlinePartyPendingJoinReques ...
)

Public function Virtual

void

 

TriggerOnPartyMemberDataReceivedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const FUniqueNetId & Param3,
    const FName & Param4,
    const FOnlinePartyData & Param5
)

Public function Virtual

void

 

TriggerOnPartyMemberExitedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const FUniqueNetId & Param3,
    const EMemberExitedReason Param4
)

Public function Virtual

void

 

TriggerOnPartyMemberJoinedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const FUniqueNetId & Param3
)

Public function Virtual

void

 

TriggerOnPartyMemberPromotedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const FUniqueNetId & Param3
)

Public function Virtual

void

 

TriggerOnPartyPromotionLockoutChangedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const bool Param3
)

Public function Virtual

void

 

TriggerOnPartyStateChangedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    EPartyState Param3,
    EPartyState Param4
)

Public function Virtual

void

 

TriggerOnPartySystemStateChangeDelegates

(
    EPartySystemState Param1
)

Public function Virtual

void

 

TriggerOnQueryPartyJoinabilityReceivedDelegates

(
    const FUniqueNetId & Param1,
    const FOnlinePartyId & Param2,
    const IOnlinePartyPendingJoinReques ...
)

Public function

bool

 

UpdateParty

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FPartyConfiguration & PartyCo...,
    bool bShouldRegenerateReservationKe...,
    const FOnUpdatePartyComplete & Dele...
)

Update an existing party with new configuration

Public function

bool

 

UpdatePartyData

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FName & Namespace,
    const FOnlinePartyData & PartyData
)

Set party data and broadcast to all members Only current data can be set and no history of past party data is preserved Party members notified of new data (see FOnPartyDataReceived)

Public function

bool

 

UpdatePartyMemberData

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FName & Namespace,
    const FOnlinePartyData & PartyMembe...
)

Set party data for a single party member and broadcast to all members Only current data can be set and no history of past party member data is preserved Party members notified of new data (see FOnPartyMemberDataReceived)

Constants

Name

Description

PrimaryPartyTypeIdValue

Deprecated Functions

Name Description

Public function Virtual

FDelegateHan ...

 

AddOnPartyDataReceivedDelegate_Handle

(
    const FOnPartyDataReceivedConstDele ...
)

Use OnPartyDataReceived instead of OnPartyDataReceivedConst

Public function Virtual

FDelegateHan ...

 

AddOnPartyMemberDataReceivedDelegate_Handle

(
    const FOnPartyMemberDataReceivedCon ...
)

Use OnPartyMemberDataReceived instead of OnPartyMemberDataReceivedConst

Public function Virtual Const

FOnlineParty ...

 

GetPartyData

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId
)

Party data is separated by namespace. Use GetPartyData that has a Namespace parameter.

Public function Virtual Const

FOnlineParty ...

 

GetPartyMemberData

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FUniqueNetId & MemberId
)

Party data is separated by namespace. Use GetPartyMemberData that has a Namespace parameter.

Public function Virtual

bool

 

UpdatePartyData

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FOnlinePartyData & PartyData
)

Party data is separated by namespace. Use UpdatePartyData that has a Namespace parameter.

Public function Virtual

bool

 

UpdatePartyMemberData

(
    const FUniqueNetId & LocalUserId,
    const FOnlinePartyId & PartyId,
    const FOnlinePartyData & PartyMembe...
)

Party data is separated by namespace. Use UpdatePartyMemberData that has a Namespace parameter.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback