Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces
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
| Type | Name | Description | |
|---|---|---|---|
| FOnFillPartyJoinRequestData | OnFillPartyJoinRequestDataDelegates | Notification when a player wants to know if the party is in a joinable state Subscriber is expected to call RespondToQueryJoinability | |
| FOnPartyAnalyticsEvent | OnPartyAnalyticsEventDelegates | Notification when an analytics event needs to be recorded Subscriber is expected to record the event | |
| FOnPartyConfigChanged | OnPartyConfigChangedDelegates | Notification when party data is updated | |
| FOnPartyDataReceived | OnPartyDataReceivedDelegates | Notification when party data is updated | |
| FOnPartyExited | OnPartyExitedDelegates | Notification of when a party is exited | |
| FOnPartyInviteReceivedEx | OnPartyInviteReceivedExDelegates | Notification when a new invite is received | |
| FOnPartyInviteRemovedEx | OnPartyInviteRemovedExDelegates | Notification when an invite has been removed | |
| FOnPartyInviteRequestReceived | OnPartyInviteRequestReceivedDelegates | Notification when a request for an invite has been received | |
| FOnPartyInviteResponseReceived | OnPartyInviteResponseReceivedDelegates | Notification when an invitation response is received | |
| FOnPartyInvitesChanged | OnPartyInvitesChangedDelegates | Notification when an invite list has changed for a party | |
| FOnPartyJoined | OnPartyJoinedDelegates | List of all subscribe-able notifications | |
| FOnPartyJoinRequestReceived | OnPartyJoinRequestReceivedDelegates | Notification when a new reservation request is received Subscriber is expected to call ApproveJoinRequest | |
| FOnPartyMemberDataReceived | OnPartyMemberDataReceivedDelegates | Notification when party member data is updated | |
| FOnPartyMemberExited | OnPartyMemberExitedDelegates | Notification when a member exits a party | |
| FOnPartyMemberJoined | OnPartyMemberJoinedDelegates | Notification when a member joins the party | |
| FOnPartyMemberPromoted | OnPartyMemberPromotedDelegates | Notification when a member is promoted in a party | |
| FOnPartyPromotionLockoutChanged | OnPartyPromotionLockoutChangedDelegates | Notification when player promotion is locked out. | |
| FOnPartyRequestToJoinReceived | OnPartyRequestToJoinReceivedDelegates | Notification when a new party join request is received | |
| FOnPartyRequestToJoinRemoved | OnPartyRequestToJoinRemovedDelegates | Notification when a new party join request is removed | |
| FOnPartyStateChanged | OnPartyStateChangedDelegates | Notification when a party's state has changed | |
| FOnPartySystemStateChange | OnPartySystemStateChangeDelegates | Notification of party system state change | |
| FOnQueryPartyJoinabilityReceived | OnQueryPartyJoinabilityReceivedDelegates | Notification when a player wants to know if the party is in a joinable state Subscriber is expected to call RespondToQueryJoinability |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| FDelegateHandle | AddOnFillPartyJoinRequestDataDelegate_Handle
(
const FOnFillPartyJoinRequestDataDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyAnalyticsEventDelegate_Handle
(
const FOnPartyAnalyticsEventDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyConfigChangedDelegate_Handle
(
const FOnPartyConfigChangedDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyDataReceivedDelegate_Handle
(
const FOnPartyDataReceivedDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyExitedDelegate_Handle
(
const FOnPartyExitedDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyInviteReceivedExDelegate_Handle
(
const FOnPartyInviteReceivedExDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyInviteRemovedExDelegate_Handle
(
const FOnPartyInviteRemovedExDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyInviteRequestReceivedDelegate_Handle
(
const FOnPartyInviteRequestReceivedDelegate& Delegate |
||
| FDelegateHandle | |||
| FDelegateHandle | AddOnPartyInvitesChangedDelegate_Handle
(
const FOnPartyInvitesChangedDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyJoinedDelegate_Handle
(
const FOnPartyJoinedDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyJoinRequestReceivedDelegate_Handle
(
const FOnPartyJoinRequestReceivedDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyMemberDataReceivedDelegate_Handle
(
const FOnPartyMemberDataReceivedDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyMemberExitedDelegate_Handle
(
const FOnPartyMemberExitedDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyMemberJoinedDelegate_Handle
(
const FOnPartyMemberJoinedDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyMemberPromotedDelegate_Handle
(
const FOnPartyMemberPromotedDelegate& Delegate |
||
| FDelegateHandle | |||
| FDelegateHandle | AddOnPartyRequestToJoinReceivedDelegate_Handle
(
const FOnPartyRequestToJoinReceivedDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyRequestToJoinRemovedDelegate_Handle
(
const FOnPartyRequestToJoinRemovedDelegate& Delegate |
||
| FDelegateHandle | AddOnPartyStateChangedDelegate_Handle
(
const FOnPartyStateChangedDelegate& Delegate |
||
| FDelegateHandle | AddOnPartySystemStateChangeDelegate_Handle
(
const FOnPartySystemStateChangeDelegate& Delegate |
||
| FDelegateHandle | |||
| bool | ApproveJoinRequest
(
const FUniqueNetId& LocalUserId, |
Approve a request to join a party | |
| void | CancelInvitation
(
const FUniqueNetId& LocalUserId, |
Cancel an invitation sent to a user | |
| void | CleanupParties
(
const FUniqueNetId& LocalUserId, |
Cleanup party state. | |
| void | ClearInvitations
(
const FUniqueNetId& LocalUserId, |
Clear invitations from a user because the invitations were handled by the application | |
| void | |||
| void | ClearOnFillPartyJoinRequestDataDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyAnalyticsEventDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyConfigChangedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyDataReceivedDelegates
(
void* Object |
||
| void | ClearOnPartyExitedDelegate_Handle
(
FDelegateHandle& Handle |
||
| void | ClearOnPartyExitedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyInviteReceivedExDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyInviteRemovedExDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyInviteRequestReceivedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyInviteResponseReceivedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyInvitesChangedDelegates
(
void* Object |
||
| void | ClearOnPartyJoinedDelegate_Handle
(
FDelegateHandle& Handle |
||
| void | ClearOnPartyJoinedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyJoinRequestReceivedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyMemberDataReceivedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyMemberExitedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyMemberJoinedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyMemberPromotedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyPromotionLockoutChangedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyRequestToJoinReceivedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyRequestToJoinRemovedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartyStateChangedDelegates
(
void* Object |
||
| void | |||
| void | ClearOnPartySystemStateChangeDelegates
(
void* Object |
||
| void | |||
| void | ClearOnQueryPartyJoinabilityReceivedDelegates
(
void* Object |
||
| void | ClearRequestToJoinParty
(
const FUniqueNetId& LocalUserId, |
Clear a received request to join your party | |
| IOnlinePartyJoinInfoConstPtr | Checks to see if there is a pending command line invite and consumes it | ||
| bool | CreateParty
(
const FUniqueNetId& LocalUserId, |
Create a new party | |
| void | Dump out party state for all known parties | ||
| IOnlinePartyJoinInfoConstPtr | GetAdvertisedParty
(
const FUniqueNetId& LocalUserId, |
Get the join info of the specified user and party type | |
| bool | GetJoinedParties
(
const FUniqueNetId& LocalUserId, |
Get a list of currently joined parties for the user | |
| FOnlinePartyConstPtr | GetParty
(
const FUniqueNetId& LocalUserId, |
Get info associated with a party | |
| FOnlinePartyConstPtr | GetParty
(
const FUniqueNetId& LocalUserId, |
Get info associated with a party | |
| FOnlinePartyDataConstPtr | GetPartyData
(
const FUniqueNetId& LocalUserId, |
Get current cached data associated with a party FOnPartyDataReceived notification called whenever this data changes | |
| FOnlinePartyMemberConstPtr | GetPartyMember
(
const FUniqueNetId& LocalUserId, |
Get a party member by id | |
| uint32 | GetPartyMemberCount
(
const FUniqueNetId& LocalUserId, |
Returns the number of players in a given party | |
| FOnlinePartyDataConstPtr | GetPartyMemberData
(
const FUniqueNetId& LocalUserId, |
Get current cached data associated with a party member FOnPartyMemberDataReceived notification called whenever this data changes | |
| bool | GetPartyMembers
(
const FUniqueNetId& LocalUserId, |
Get list of current party members | |
| bool | GetPendingInvitedUsers
(
const FUniqueNetId& LocalUserId, |
Get list of users invited to a party that have not yet responded | |
| bool | GetPendingInvites
(
const FUniqueNetId& LocalUserId, |
Get a list of parties the user has been invited to | |
| bool | GetPendingJoinRequests
(
const FUniqueNetId& LocalUserId, |
Get list of users requesting to join the party | |
| bool | GetPendingRequestsToJoin
(
const FUniqueNetId& LocalUserId, |
Get a list of users requesting to join the party. | |
| const FOnlinePartyTypeId | |||
| bool | IsMemberLeader
(
const FUniqueNetId& LocalUserId, |
Returns true if the user specified by MemberId is the leader of the party specified by PartyId | |
| bool | JoinParty
(
const FUniqueNetId& LocalUserId, |
Join an existing party | |
| bool | KickMember
(
const FUniqueNetId& LocalUserId, |
Kick a user from an existing party Only admin can kick a party member | |
| bool | LeaveParty
(
const FUniqueNetId& LocalUserId, |
Leave an existing party All existing party members notified of member leaving (see FOnPartyMemberLeft) | |
| bool | LeaveParty
(
const FUniqueNetId& LocalUserId, |
Leave an existing party All existing party members notified of member leaving (see FOnPartyMemberLeft) | |
| IOnlinePartyJoinInfoConstPtr | MakeJoinInfo
(
const FUniqueNetId& LocalUserId, |
Returns the join info for current party | |
| IOnlinePartyJoinInfoConstPtr | MakeJoinInfoFromJson
(
const FString& JoinInfoJson |
Returns a valid join info object from a json blob | |
| IOnlinePartyJoinInfoConstPtr | MakeJoinInfoFromToken
(
const FString& Token |
Creates a IOnlinePartyJoinInfo object from a command line token | |
| FString | MakeJoinInfoJson
(
const FUniqueNetId& LocalUserId, |
Returns the json version of a join info for a current party | |
| const FOnlinePartyTypeId | MakePartyTypeId
(
const FOnlinePartyTypeId::TInternalType InTypeId |
||
| FString | MakeTokenFromJoinInfo
(
const IOnlinePartyJoinInfo& JoinInfo |
Creates a command line token from a IOnlinePartyJoinInfo object | |
| bool | PromoteMember
(
const FUniqueNetId& LocalUserId, |
Promote a user from an existing party to be admin All existing party members notified of promoted member (see FOnPartyMemberPromoted) | |
| void | QueryPartyJoinability
(
const FUniqueNetId& LocalUserId, |
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 | |
| bool | RejectInvitation
(
const FUniqueNetId& LocalUserId, |
Reject an invite to a party | |
| bool | RejoinParty
(
const FUniqueNetId& LocalUserId, |
Attempt to rejoin a former party | |
| void | RequestToJoinParty
(
const FUniqueNetId& LocalUserId, |
Request to join an existing party | |
| void | RespondToQueryJoinability
(
const FUniqueNetId& LocalUserId, |
Respond to a query joinability request. | |
| void | RestoreInvites
(
const FUniqueNetId& LocalUserId, |
Restore party invites. | |
| void | RestoreParties
(
const FUniqueNetId& LocalUserId, |
Restore party memberships. | |
| bool | SendInvitation
(
const FUniqueNetId& LocalUserId, |
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 | |
| void | TriggerOnFillPartyJoinRequestDataDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyAnalyticsEventDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyConfigChangedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyDataReceivedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyExitedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyInviteReceivedExDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyInviteRemovedExDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyInviteRequestReceivedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyInviteResponseReceivedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyInvitesChangedDelegates
(
const FUniqueNetId& Param1 |
||
| void | TriggerOnPartyJoinedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyJoinRequestReceivedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyMemberDataReceivedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyMemberExitedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyMemberJoinedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyMemberPromotedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyPromotionLockoutChangedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyRequestToJoinReceivedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyRequestToJoinRemovedDelegates
(
const FUniqueNetId& Param1, |
||
| void | TriggerOnPartyStateChangedDelegates
(
const FUniqueNetId& Param1, |
||
| void | |||
| void | TriggerOnQueryPartyJoinabilityReceivedDelegates
(
const FUniqueNetId& Param1, |
||
| bool | UpdateParty
(
const FUniqueNetId& LocalUserId, |
Update an existing party with new configuration | |
| bool | UpdatePartyData
(
const FUniqueNetId& LocalUserId, |
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) | |
| bool | UpdatePartyMemberData
(
const FUniqueNetId& LocalUserId, |
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 |