Loading...
Searching...
No Matches
FOnlinePartyAccelByte Class Reference

#include <OnlinePartyInterfaceAccelByte.h>

Inheritance diagram for FOnlinePartyAccelByte:

Public Member Functions

 FOnlinePartyAccelByte (const TSharedRef< FOnlinePartySystemAccelByte, ESPMode::ThreadSafe > &InOwningInterface, const FString &InPartyId, const FString &InInviteToken, const FPartyConfiguration &InPartyConfiguration, const TSharedRef< const FUniqueNetIdAccelByteUser > &InLeaderId, const TSharedRef< FOnlinePartyData > &InPartyData=MakeShared< FOnlinePartyData >(), const FOnlinePartyTypeId InPartyTypeId=FOnlinePartyTypeId(static_cast< uint32 >(EAccelBytePartyType::PRIMARY_PARTY)))
virtual bool CanLocalUserInvite (const FUniqueNetId &LocalUserId) const override
virtual bool IsJoinable () const override
virtual TSharedRef< const FPartyConfiguration > GetConfiguration () const override
const uint32 GetMemberCount () const
void AddPlayerCrossplayPreferenceAndPlatform (const TSharedRef< const FUniqueNetIdAccelByteUser > &LocalUserId)
void RemovePlayerCrossplayPreferenceAndPlatform (const TSharedRef< const FUniqueNetIdAccelByteUser > &LocalUserId, const TSharedRef< const FUniqueNetIdAccelByteUser > &UserToRemove)
void AddPlayerAcceptedTicketId (const TSharedRef< const FUniqueNetIdAccelByteUser > &LocalUserId, const FString &TicketId, const FString &MatchId)
void RemovePlayerAcceptedTicketId (const TSharedRef< const FUniqueNetIdAccelByteUser > &LocalUserId)
void AddMember (const TSharedRef< const FUniqueNetIdAccelByteUser > &LocalUserId, const TSharedRef< FOnlinePartyMemberAccelByte > &Member)
void AddUserToInvitedPlayers (const TSharedRef< const FUniqueNetIdAccelByteUser > &LocalUserId, const TSharedRef< const FUniqueNetIdAccelByteUser > &InviterUserId, const TSharedRef< const FUniqueNetIdAccelByteUser > &InvitedUserId)
TSharedPtr< const FOnlinePartyMemberAccelByteGetMember (const TSharedRef< const FUniqueNetIdAccelByteUser > &UserId) const
bool RemoveMember (const TSharedRef< const FUniqueNetIdAccelByteUser > &LocalUserId, const TSharedRef< const FUniqueNetIdAccelByteUser > &RemovedUserId, const EMemberExitedReason &ExitReason)
void RemoveInvite (const TSharedRef< const FUniqueNetIdAccelByteUser > &LocalUserId, const TSharedRef< const FUniqueNetIdAccelByteUser > &InvitedUserId, const EPartyInvitationRemovedReason &PartyInviteRemoveReason)
TArray< FOnlinePartyMemberConstRef > GetAllMembers () const
TArray< TSharedRef< const FUniqueNetId > > GetAllPendingInvitedUsers () const
TSharedRef< const FOnlinePartyData > GetPartyData () const
void SetPartyData (TSharedRef< FOnlinePartyData > PartyData)
void SetPartyCode (const FString &PartyCode)
bool IsCrossplayParty ()
TArray< FString > GetUniquePlatformsForParty ()

Static Public Member Functions

static TSharedRef< FOnlinePartyAccelByteCreatePartyFromPartyInfo (const TSharedRef< const FUniqueNetIdAccelByteUser > LocalUserId, const TSharedRef< FOnlinePartySystemAccelByte, ESPMode::ThreadSafe > PartyInterface, const FAccelByteModelsInfoPartyResponse &PartyInfo, const TArray< FAccelByteUserInfoRef > &PartyMemberInfo, const TSharedRef< FOnlinePartyData > &InPartyData=MakeShared< FOnlinePartyData >(), const FString &PartyCode=TEXT(""), const FAccelByteModelsBulkUserStatusNotif &InPartyMemberStatus=FAccelByteModelsBulkUserStatusNotif())

Public Attributes

PACKAGE_SCOPE : static TSharedRef<FOnlinePartyAccelByte> CreatePartyFromPartyInfo(const TSharedRef<const FUniqueNetIdAccelByteUser> LocalUserId
PACKAGE_SCOPE const TSharedRef< FOnlinePartySystemAccelByte, ESPMode::ThreadSafe > PartyInterface
PACKAGE_SCOPE const TSharedRef< FOnlinePartySystemAccelByte, ESPMode::ThreadSafe > const FAccelByteModelsPartyJoinResponse & PartyInfo
PACKAGE_SCOPE const TSharedRef< FOnlinePartySystemAccelByte, ESPMode::ThreadSafe > const FAccelByteModelsPartyJoinResponse const TArray< FAccelByteUserInfoRef > & PartyMemberInfo
PACKAGE_SCOPE const TSharedRef< FOnlinePartySystemAccelByte, ESPMode::ThreadSafe > const FAccelByteModelsPartyJoinResponse const TArray< FAccelByteUserInfoRef > const TSharedRef< FOnlinePartyData > & InPartyData = MakeShared<FOnlinePartyData>()
PACKAGE_SCOPE const TSharedRef< FOnlinePartySystemAccelByte, ESPMode::ThreadSafe > const FAccelByteModelsPartyJoinResponse const TArray< FAccelByteUserInfoRef > const TSharedRef< FOnlinePartyData > const FString & PartyCode =TEXT("")
PACKAGE_SCOPE const TSharedRef< FOnlinePartySystemAccelByte, ESPMode::ThreadSafe > const FAccelByteModelsPartyJoinResponse const TArray< FAccelByteUserInfoRef > const TSharedRef< FOnlinePartyData > const FString const FAccelByteModelsBulkUserStatusNotif & InPartyMemberStatus = FAccelByteModelsBulkUserStatusNotif())

Friends

class FOnlinePartySystemAccelByte

Detailed Description

Representation of a party on the AccelByte backend

Member Function Documentation

◆ AddMember()

void FOnlinePartyAccelByte::AddMember ( const TSharedRef< const FUniqueNetIdAccelByteUser > & LocalUserId,
const TSharedRef< FOnlinePartyMemberAccelByte > & Member )

Internal method for interface and async tasks to add members to this party object

◆ AddPlayerAcceptedTicketId()

void FOnlinePartyAccelByte::AddPlayerAcceptedTicketId ( const TSharedRef< const FUniqueNetIdAccelByteUser > & LocalUserId,
const FString & TicketId,
const FString & MatchId )

#TICKETID Adds the specified Leader TicketID to the party's storage.

◆ AddPlayerCrossplayPreferenceAndPlatform()

void FOnlinePartyAccelByte::AddPlayerCrossplayPreferenceAndPlatform ( const TSharedRef< const FUniqueNetIdAccelByteUser > & LocalUserId)

#SG Adds the specified user's crossplay preference and platform to the party's storage.

◆ AddUserToInvitedPlayers()

void FOnlinePartyAccelByte::AddUserToInvitedPlayers ( const TSharedRef< const FUniqueNetIdAccelByteUser > & LocalUserId,
const TSharedRef< const FUniqueNetIdAccelByteUser > & InviterUserId,
const TSharedRef< const FUniqueNetIdAccelByteUser > & InvitedUserId )

Internal method for interface and async tasks to add players that have been invited to this party

◆ CreatePartyFromPartyInfo()

TSharedRef< FOnlinePartyAccelByte > FOnlinePartyAccelByte::CreatePartyFromPartyInfo ( const TSharedRef< const FUniqueNetIdAccelByteUser > LocalUserId,
const TSharedRef< FOnlinePartySystemAccelByte, ESPMode::ThreadSafe > PartyInterface,
const FAccelByteModelsInfoPartyResponse & PartyInfo,
const TArray< FAccelByteUserInfoRef > & PartyMemberInfo,
const TSharedRef< FOnlinePartyData > & InPartyData = MakeShared<FOnlinePartyData>(),
const FString & PartyCode = TEXT(""),
const FAccelByteModelsBulkUserStatusNotif & InPartyMemberStatus = FAccelByteModelsBulkUserStatusNotif() )
static

Internal method to construct a party instance from an AccelByte party info structure as well as a map of user IDs to display names for each member of the party.

◆ GetAllMembers()

TArray< FOnlinePartyMemberConstRef > FOnlinePartyAccelByte::GetAllMembers ( ) const

Internal method for getting an array of all current party members

◆ GetAllPendingInvitedUsers()

TArray< TSharedRef< const FUniqueNetId > > FOnlinePartyAccelByte::GetAllPendingInvitedUsers ( ) const

Internal method for getting an array of user IDs for all players with currently pending invites

◆ GetMember()

TSharedPtr< const FOnlinePartyMemberAccelByte > FOnlinePartyAccelByte::GetMember ( const TSharedRef< const FUniqueNetIdAccelByteUser > & UserId) const

Method internally for interface and other tasks to get a member of this party by their ID

◆ GetMemberCount()

const uint32 FOnlinePartyAccelByte::GetMemberCount ( ) const

Method to get the amount of members that are currently in this party;

◆ GetPartyData()

TSharedRef< const FOnlinePartyData > FOnlinePartyAccelByte::GetPartyData ( ) const

Internal method for getting a reference to our party data

◆ GetUniquePlatformsForParty()

TArray< FString > FOnlinePartyAccelByte::GetUniquePlatformsForParty ( )

Gets an array of the unique platforms that each party member is on

◆ IsCrossplayParty()

bool FOnlinePartyAccelByte::IsCrossplayParty ( )

Check whether this party is a crossplay enabled party or not. This will check the preferences of all members to see if their crossplay flag is enabled.

Returns
true if all members have crossplay enabled, false otherwise

◆ RemoveInvite()

void FOnlinePartyAccelByte::RemoveInvite ( const TSharedRef< const FUniqueNetIdAccelByteUser > & LocalUserId,
const TSharedRef< const FUniqueNetIdAccelByteUser > & InvitedUserId,
const EPartyInvitationRemovedReason & PartyInviteRemoveReason )

Internal method to remove a party invite by the invited user ID

◆ RemoveMember()

bool FOnlinePartyAccelByte::RemoveMember ( const TSharedRef< const FUniqueNetIdAccelByteUser > & LocalUserId,
const TSharedRef< const FUniqueNetIdAccelByteUser > & RemovedUserId,
const EMemberExitedReason & ExitReason )

Internal method to remove a party member from a party, usually used in notifications or on kick

◆ RemovePlayerAcceptedTicketId()

void FOnlinePartyAccelByte::RemovePlayerAcceptedTicketId ( const TSharedRef< const FUniqueNetIdAccelByteUser > & LocalUserId)

#TICKETID Removes the specified Leader TicketID from the party's storage.

◆ RemovePlayerCrossplayPreferenceAndPlatform()

void FOnlinePartyAccelByte::RemovePlayerCrossplayPreferenceAndPlatform ( const TSharedRef< const FUniqueNetIdAccelByteUser > & LocalUserId,
const TSharedRef< const FUniqueNetIdAccelByteUser > & UserToRemove )

#SG Removes the specified user's crossplay preference and platform from the party's storage.

◆ SetPartyCode()

void FOnlinePartyAccelByte::SetPartyCode ( const FString & PartyCode)

Internal method to set party code associated with this party instance

◆ SetPartyData()

void FOnlinePartyAccelByte::SetPartyData ( TSharedRef< FOnlinePartyData > PartyData)

Internal method to update party data