Loading...
Searching...
No Matches
FOnlineStatisticAccelByte Class Reference

#include <OnlineStatisticInterfaceAccelByte.h>

Inheritance diagram for FOnlineStatisticAccelByte:

Public Member Functions

bool ListUserStatItems (int32 LocalUserNum, const TArray< FString > &StatCodes, const TArray< FString > &Tags, const FString &AdditionalKey, bool bAlwaysRequestToService)
 DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM (MAX_LOCAL_PLAYERS, OnListUserStatItemsCompleted, bool, const TArray< FAccelByteModelsFetchUser > &, const FString &)
 DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM (MAX_LOCAL_PLAYERS, OnUserStatItemsResetCompleted, bool, const TArray< FAccelByteModelsUpdateUserStatItemsResponse > &, const FString &)
 DEFINE_ONLINE_DELEGATE_ONE_PARAM (OnUserStatItemsDeleteCompleted, const FOnlineError &)
bool GetListUserStatItems (int32 LocalUserNum, TArray< TSharedRef< FAccelByteModelsFetchUser > > &OutUsers)
TSharedPtr< const FOnlineStatsUserStats > GetAllListUserStatItemFromCache (const FUniqueNetIdRef StatsUserId) const
void QueryStats (const FUniqueNetIdRef LocalUserId, const FUniqueNetIdRef StatsUser, const TArray< FString > &StatNames, const FOnlineStatsQueryUserStatsComplete &Delegate)
virtual void QueryStats (int32 LocalUserNum, const FUniqueNetIdRef StatsUser, const TArray< FString > &StatNames, const FOnlineStatsQueryUserStatsComplete &Delegate)
virtual void QueryStats (int32 LocalUserNum, const FUniqueNetIdRef StatsUser, const FOnlineStatsQueryUserStatsComplete &Delegate)
virtual void QueryStats (int32 LocalUserNum, const TArray< FUniqueNetIdRef > &StatsUsers, const TArray< FString > &StatNames, const FOnlineStatsQueryUsersStatsComplete &Delegate)
virtual void CreateStats (const int32 LocalUserNum, const FUniqueNetIdRef StatsUser, const TArray< FString > &StatNames, const FOnlineStatsCreateStatsComplete &Delegate)
virtual void EmplaceStats (const TSharedPtr< const FOnlineStatsUserStats > &InUserStats)
virtual void EmplaceStats (const TArray< TSharedPtr< const FOnlineStatsUserStats > > &InUsersStats)
virtual void RemoveStats (const FUniqueNetIdRef StatsUserId, const FString &StatsCode)
virtual void ResetStats (const int32 LocalUserNum, const FUniqueNetIdRef StatsUserId)
virtual void UpdateStats (const int32 LocalUserNum, const TArray< FOnlineStatsUserUpdatedStats > &BulkUpdateMultipleUserStatItems, const FOnUpdateMultipleUserStatItemsComplete &Delegate)
virtual void UpdateStats (const FUniqueNetIdRef LocalUserId, const TArray< FOnlineStatsUserUpdatedStats > &UpdatedUserStats, const FOnUpdateMultipleUserStatItemsComplete &Delegate)
virtual void DeleteStats (const int32 LocalUserNum, const FUniqueNetIdRef StatsUserId, const FString &StatsCode, const FString &AdditionalKey)
virtual void QueryStats (const FUniqueNetIdRef LocalUserId, const FUniqueNetIdRef StatsUser, const FOnlineStatsQueryUserStatsComplete &Delegate) override
virtual void QueryStats (const FUniqueNetIdRef LocalUserId, const TArray< FUniqueNetIdRef > &StatsUsers, const TArray< FString > &StatsNames, const FOnlineStatsQueryUsersStatsComplete &Delegate) override
virtual TSharedPtr< const FOnlineStatsUserStats > GetStats (const FUniqueNetIdRef StatsUserId) const override
virtual void UpdateStats (const FUniqueNetIdRef LocalUserId, const TArray< FOnlineStatsUserUpdatedStats > &UpdatedUserStats, const FOnlineStatsUpdateStatsComplete &Delegate) override
virtual void ResetStats (const FUniqueNetIdRef StatsUserId) override
virtual void QueryStats (const int32 LocalUserNum, const FUniqueNetIdRef StatsUser, const TArray< FString > &StatsNames, const TArray< FString > &Tags, const FOnlineStatsQueryUserStatsComplete &Delegate, EAccelByteStatisticSortBy SortBy=EAccelByteStatisticSortBy::NONE)

Static Public Member Functions

static EAccelByteStatisticUpdateStrategy ConvertUpdateStrategy (FOnlineStatUpdate::EOnlineStatModificationType Strategy)

Protected Member Functions

 FOnlineStatisticAccelByte ()

Protected Attributes

FOnlineSubsystemAccelByteWPtr AccelByteSubsystem = nullptr

Detailed Description

Implementation of Statistic service from AccelByte services

Constructor & Destructor Documentation

◆ FOnlineStatisticAccelByte()

FOnlineStatisticAccelByte::FOnlineStatisticAccelByte ( )
inlineprotected

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

Member Function Documentation

◆ ConvertUpdateStrategy()

EAccelByteStatisticUpdateStrategy FOnlineStatisticAccelByte::ConvertUpdateStrategy ( FOnlineStatUpdate::EOnlineStatModificationType Strategy)
static

Convert Unreal built-in enum to Accelbyte enum for statistic update strategy

Parameters
Strategythe strategy to update the statistic

◆ CreateStats()

void FOnlineStatisticAccelByte::CreateStats ( const int32 LocalUserNum,
const FUniqueNetIdRef StatsUser,
const TArray< FString > & StatNames,
const FOnlineStatsCreateStatsComplete & Delegate )
virtual

Create a one or more user's stats. Only for request by Game Server

Parameters
LocalUserNumIndex of user(server) that is attempting to create the stats
StatsUserUser to create stats for
StatNamesStats to create stats for all specified users
DelegateCalled when the user's stats have finished being created, or when we fail to create the user's stats

◆ DEFINE_ONLINE_DELEGATE_ONE_PARAM()

FOnlineStatisticAccelByte::DEFINE_ONLINE_DELEGATE_ONE_PARAM ( OnUserStatItemsDeleteCompleted ,
const FOnlineError &  )

Delegate fired when we delete one statistic for a player.

Parameters
ResultStateThe Result of statistic deletion process

◆ DeleteStats()

void FOnlineStatisticAccelByte::DeleteStats ( const int32 LocalUserNum,
const FUniqueNetIdRef StatsUserId,
const FString & StatsCode,
const FString & AdditionalKey )
virtual

Delete one statistic for one user. This request only for Game Server

Parameters
LocalUserNumIndex of user(server) that is attempting to delete the stats.
StatsUserIdUser to delete stat for.
StatsCodeThe stats id to remove.
AdditionalKeyThe AdditionalKey relate to statistic.

◆ EmplaceStats() [1/2]

void FOnlineStatisticAccelByte::EmplaceStats ( const TArray< TSharedPtr< const FOnlineStatsUserStats > > & InUsersStats)
virtual

Emplace user's cached stats object

Parameters
UsersStatsThe stats to emplace

◆ EmplaceStats() [2/2]

void FOnlineStatisticAccelByte::EmplaceStats ( const TSharedPtr< const FOnlineStatsUserStats > & InUserStats)
virtual

Emplace a user's cached stats object

Parameters
UserStatsThe stats to emplace

◆ QueryStats() [1/5]

void FOnlineStatisticAccelByte::QueryStats ( const FUniqueNetIdRef LocalUserId,
const FUniqueNetIdRef StatsUser,
const TArray< FString > & StatNames,
const FOnlineStatsQueryUserStatsComplete & Delegate )

Query a specific user's stats

Parameters
LocalUserIdUser to query as (if applicable)
StatsUserUser to get stats for
StatNamesStats to get stats for all specified users
DelegateCalled when the user's stats have finished being requested and are now available, or when we fail to retrieve the user's stats

◆ QueryStats() [2/5]

void FOnlineStatisticAccelByte::QueryStats ( const int32 LocalUserNum,
const FUniqueNetIdRef StatsUser,
const TArray< FString > & StatsNames,
const TArray< FString > & Tags,
const FOnlineStatsQueryUserStatsComplete & Delegate,
EAccelByteStatisticSortBy SortBy = EAccelByteStatisticSortBy::NONE )
virtual

Query a user's stats with tags

Parameters
LocalUserNumIndex of user(or server) to query as
StatsUserUser to get stats for
StatsNamesStats to get stats for all specified users
TagsTags
DelegateCalled when the user's stats have finished being requested and are now available, or when we fail to retrieve the user's stats

◆ QueryStats() [3/5]

void FOnlineStatisticAccelByte::QueryStats ( int32 LocalUserNum,
const FUniqueNetIdRef StatsUser,
const FOnlineStatsQueryUserStatsComplete & Delegate )
virtual

Query a specific user's stats

Parameters
LocalUserNumIndex of user(or server) to query as
StatsUserUser to get stats for
DelegateCalled when the user's stats have finished being requested and are now available, or when we fail to retrieve the user's stats

◆ QueryStats() [4/5]

void FOnlineStatisticAccelByte::QueryStats ( int32 LocalUserNum,
const FUniqueNetIdRef StatsUser,
const TArray< FString > & StatNames,
const FOnlineStatsQueryUserStatsComplete & Delegate )
virtual

Query a specific user's stats

Parameters
LocalUserNumIndex of user(or server) to query as
StatsUserUser to get stats for
StatNamesStats to get stats for all specified users
DelegateCalled when the user's stats have finished being requested and are now available, or when we fail to retrieve the user's stats

◆ QueryStats() [5/5]

void FOnlineStatisticAccelByte::QueryStats ( int32 LocalUserNum,
const TArray< FUniqueNetIdRef > & StatsUsers,
const TArray< FString > & StatNames,
const FOnlineStatsQueryUsersStatsComplete & Delegate )
virtual

Query a one or more user's stats

Parameters
LocalUserNumIndex of user(or server) to query as
StatsUsersUsers to get stats for
StatNamesStats to get stats for all specified users
DelegateCalled when the user's stats have finished being requested and are now available, or when we fail to retrieve the user's stats

◆ RemoveStats()

void FOnlineStatisticAccelByte::RemoveStats ( const FUniqueNetIdRef StatsUserId,
const FString & StatsCode )
virtual

Remove user's cached stats object

Parameters
StatsUserIdUser to remove stats for
StatsCodeThe stats id to remove

◆ ResetStats()

void FOnlineStatisticAccelByte::ResetStats ( const int32 LocalUserNum,
const FUniqueNetIdRef StatsUserId )
virtual

Reset all user statistics.

Parameters
LocalUserNumIndex of user(server) that is attempting to create the stats
StatsUserIdUser to reset stats for

◆ UpdateStats() [1/2]

void FOnlineStatisticAccelByte::UpdateStats ( const FUniqueNetIdRef LocalUserId,
const TArray< FOnlineStatsUserUpdatedStats > & UpdatedUserStats,
const FOnUpdateMultipleUserStatItemsComplete & Delegate )
virtual

Update multiple statistics for a user. This request only for Game Client This endpoint extends from UpdateStats(const FUniqueNetIdRef LocalUserId, const TArray<FOnlineStatsUserUpdatedStats>& UpdatedUserStats, const FOnlineStatsUpdateStatsComplete& Delegate) Which is providing the messages in 'Details' field after receiving the response.

Parameters
LocalUserIdUser to query as (if applicable)
UpdatedUserStatsArray of Updated Statistics.
DelegateCalled when the statistics have finished being updated, or when we fail to update the stats

◆ UpdateStats() [2/2]

void FOnlineStatisticAccelByte::UpdateStats ( const int32 LocalUserNum,
const TArray< FOnlineStatsUserUpdatedStats > & BulkUpdateMultipleUserStatItems,
const FOnUpdateMultipleUserStatItemsComplete & Delegate )
virtual

Update multiple statistics for multiple users. This request only for Game Server

Parameters
LocalUserNumIndex of user(server) that is attempting to update the stats.
BulkUpdateMultipleUserStatItemsUpdated Statistics.
DelegateCalled when the statistics have finished being updated, or when we fail to update the stats

Member Data Documentation

◆ AccelByteSubsystem

FOnlineSubsystemAccelByteWPtr FOnlineStatisticAccelByte::AccelByteSubsystem = nullptr
protected

Instance of the subsystem that created this interface