FOnlinePartySystemAccelByte Class Reference

Inheritance diagram for FOnlinePartySystemAccelByte:

Public Member Functions
virtual void	RestoreParties (const FUniqueNetId &LocalUserId, const FOnRestorePartiesComplete &CompletionDelegate) override
virtual void	RestoreInvites (const FUniqueNetId &LocalUserId, const FOnRestoreInvitesComplete &CompletionDelegate) override
virtual void	CleanupParties (const FUniqueNetId &LocalUserId, const FOnCleanupPartiesComplete &CompletionDelegate) override
virtual bool	CreateParty (const FUniqueNetId &LocalUserId, const FOnlinePartyTypeId PartyTypeId, const FPartyConfiguration &PartyConfig, const FOnCreatePartyComplete &Delegate=FOnCreatePartyComplete()) override
virtual bool	UpdateParty (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FPartyConfiguration &PartyConfig, bool bShouldRegenerateReservationKey=false, const FOnUpdatePartyComplete &Delegate=FOnUpdatePartyComplete()) override
virtual bool	JoinParty (const FUniqueNetId &LocalUserId, const IOnlinePartyJoinInfo &OnlinePartyJoinInfo, const FOnJoinPartyComplete &Delegate=FOnJoinPartyComplete()) override
virtual bool	LeaveParty (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, bool bSynchronizeLeave, const FOnLeavePartyComplete &Delegate=FOnLeavePartyComplete()) override
virtual bool	ApproveJoinRequest (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FUniqueNetId &RecipientId, bool bIsApproved, int32 DeniedResultCode=0) override
virtual bool	JIPFromWithinParty (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FUniqueNetId &PartyLeaderId) override
virtual bool	ApproveJIPRequest (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FUniqueNetId &RecipientId, bool bIsApproved, int32 DeniedResultCode=0) override
virtual void	QueryPartyJoinability (const FUniqueNetId &LocalUserId, const IOnlinePartyJoinInfo &OnlinePartyJoinInfo, const FOnQueryPartyJoinabilityComplete &Delegate=FOnQueryPartyJoinabilityComplete()) override
virtual void	RespondToQueryJoinability (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FUniqueNetId &RecipientId, bool bCanJoin, int32 DeniedResultCode=0) override
virtual bool	SendInvitation (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FPartyInvitationRecipient &Recipient, const FOnSendPartyInvitationComplete &Delegate=FOnSendPartyInvitationComplete()) override
virtual bool	RejectInvitation (const FUniqueNetId &LocalUserId, const FUniqueNetId &SenderId) override
virtual void	ClearInvitations (const FUniqueNetId &LocalUserId, const FUniqueNetId &SenderId, const FOnlinePartyId *PartyId=nullptr) override
virtual bool	KickMember (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FUniqueNetId &TargetMemberId, const FOnKickPartyMemberComplete &Delegate=FOnKickPartyMemberComplete()) override
virtual bool	PromoteMember (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FUniqueNetId &TargetMemberId, const FOnPromotePartyMemberComplete &Delegate=FOnPromotePartyMemberComplete()) override
virtual bool	IsMemberLeader (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FUniqueNetId &MemberId) const override
virtual uint32	GetPartyMemberCount (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId) const override
virtual FOnlinePartyConstPtr	GetParty (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId) const override
virtual FOnlinePartyConstPtr	GetParty (const FUniqueNetId &LocalUserId, const FOnlinePartyTypeId &PartyTypeId) const override
virtual FOnlinePartyMemberConstPtr	GetPartyMember (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FUniqueNetId &MemberId) const override
virtual IOnlinePartyJoinInfoConstPtr	GetAdvertisedParty (const FUniqueNetId &LocalUserId, const FUniqueNetId &UserId, const FOnlinePartyTypeId PartyTypeId) const override
virtual bool	GetJoinedParties (const FUniqueNetId &LocalUserId, TArray< TSharedRef< const FOnlinePartyId > > &OutPartyIdArray) const override
virtual bool	GetPartyMembers (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, TArray< FOnlinePartyMemberConstRef > &OutPartyMembersArray) const override
virtual bool	GetPendingInvites (const FUniqueNetId &LocalUserId, TArray< IOnlinePartyJoinInfoConstRef > &OutPendingInvitesArray) const override
virtual bool	GetPendingJoinRequests (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, TArray< IOnlinePartyPendingJoinRequestInfoConstRef > &OutPendingJoinRequestArray) const override
virtual bool	GetPendingInvitedUsers (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, TArray< TSharedRef< const FUniqueNetId > > &OutPendingInvitedUserArray) const override
virtual FString	MakeJoinInfoJson (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId) override
virtual IOnlinePartyJoinInfoConstPtr	MakeJoinInfoFromJson (const FString &JoinInfoJson) override
virtual FString	MakeTokenFromJoinInfo (const IOnlinePartyJoinInfo &JoinInfo) const override
virtual IOnlinePartyJoinInfoConstPtr	MakeJoinInfoFromToken (const FString &Token) const override
virtual IOnlinePartyJoinInfoConstPtr	ConsumePendingCommandLineInvite () override
virtual void	DumpPartyState () override
virtual bool	UpdatePartyData (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FName &Namespace, const FOnlinePartyData &PartyData) override
virtual FOnlinePartyDataConstPtr	GetPartyData (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FName &Namespace) const override
virtual FOnlinePartyDataConstPtr	GetPartyMemberData (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FUniqueNetId &MemberId, const FName &Namespace) const override
virtual bool	UpdatePartyMemberData (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FName &Namespace, const FOnlinePartyData &PartyMemberData) override
virtual void	QueryPartyJoinability (const FUniqueNetId &LocalUserId, const IOnlinePartyJoinInfo &OnlinePartyJoinInfo, const FOnQueryPartyJoinabilityCompleteEx &Delegate=FOnQueryPartyJoinabilityCompleteEx()) override
virtual void	RespondToQueryJoinability (const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId, const FUniqueNetId &RecipientId, bool bCanJoin, int32 DeniedResultCode, FOnlinePartyDataConstPtr PartyData) override
virtual bool	IsPlayerInParty (const FUniqueNetId &UserId, const FOnlinePartyId &PartyId)
virtual bool	IsPlayerInAnyParty (const FUniqueNetId &UserId)
int32	GetCurrentPartyMemberCount (const FUniqueNetId &UserId)
TSharedPtr< const FOnlinePartyId >	GetFirstPartyIdForUser (const FUniqueNetId &UserId)
bool	GetPartyCode (FString &Output, const FUniqueNetId &LocalUserId, const FOnlinePartyId &PartyId)

Static Public Member Functions
static const FOnlinePartyTypeId	GetAccelBytePartyTypeId ()

Protected Member Functions
	FOnlinePartySystemAccelByte ()

Protected Attributes
FOnlineSubsystemAccelByteWPtr	AccelByteSubsystem = nullptr
FUserIDToPartiesMap	UserIdToPartiesMap
FCriticalSection	UserIdToPartiesMapLock
FUserIdToPartyInvitesMap	UserIdToPartyInvitesMap
TArray< FOnPartyJoinedDelegate >	OnPartyJoinedPendingTasks
FOnCreatePartyComplete	OnCreatePartyBeforeJoinCustomGameComplete
bool	bIsAcceptingCustomGameInvitation = false

Constructor & Destructor Documentation

FOnlinePartySystemAccelByte()

FOnlinePartySystemAccelByte::FOnlinePartySystemAccelByte ( )

inlineprotected

Hidden default constructor, the constructor that takes in a subsystem instance should be used instead.

Member Function Documentation

GetAccelBytePartyTypeId()

const FOnlinePartyTypeId FOnlinePartySystemAccelByte::GetAccelBytePartyTypeId ( )

inlinestatic

Returns

party type id for the primary party - the primary party is the party that will be addressable via the social panel

GetCurrentPartyMemberCount()

int32 FOnlinePartySystemAccelByte::GetCurrentPartyMemberCount

(

const FUniqueNetId &

UserId

)

Convenience method to get the current party member count for the player's current party

Returns

an integer representing the amount of players in the user's party, or -1 if not in a party

GetFirstPartyIdForUser()

TSharedPtr< const FOnlinePartyId > FOnlinePartySystemAccelByte::GetFirstPartyIdForUser

(

const FUniqueNetId &

UserId

)

Convenience method to get first party for user.

GetPartyCode()

bool FOnlinePartySystemAccelByte::GetPartyCode	(	FString &	Output,
		const FUniqueNetId &	LocalUserId,
		const FOnlinePartyId &	PartyId )

Get a PartyCode from the created party for invitation and joining purpose Related to JoinParty function that requires const FString& InPartyCode

Parameters

Output	Reference to the returned result if operation is success/true.
LocalUserId
PartyId

Returns

if the operation is success.

IsPlayerInAnyParty()

bool FOnlinePartySystemAccelByte::IsPlayerInAnyParty ( const FUniqueNetId & UserId )

virtual

Convenience method to check if the current user is the member of any party currently

IsPlayerInParty()

bool FOnlinePartySystemAccelByte::IsPlayerInParty ( const FUniqueNetId & UserId, const FOnlinePartyId & PartyId )

virtual

Convenience method for async tasks to check if the user passed in is currently in a party with the specified ID

Member Data Documentation

AccelByteSubsystem

FOnlineSubsystemAccelByteWPtr FOnlinePartySystemAccelByte::AccelByteSubsystem = nullptr

protected

Instance of the subsystem that created this interface

OnPartyJoinedPendingTasks

TArray<FOnPartyJoinedDelegate> FOnlinePartySystemAccelByte::OnPartyJoinedPendingTasks

protected

Store an array of delegates to execute when party join complete

UserIdToPartiesMap

FUserIDToPartiesMap FOnlinePartySystemAccelByte::UserIdToPartiesMap

protected

Map of user IDs to a map of party IDs and their associated party objects

UserIdToPartiesMapLock

FCriticalSection FOnlinePartySystemAccelByte::UserIdToPartiesMapLock

protected

Use this lock to prevent racing condition when accessing the UserIdToPartiesMap

UserIdToPartyInvitesMap

FUserIdToPartyInvitesMap FOnlinePartySystemAccelByte::UserIdToPartyInvitesMap

protected

Map of user IDs associated with an array of party invites