Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
Interface for reading data from a leaderboard service
| Name | FOnlineLeaderboardRead |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineStats.h |
| Include Path | #include "OnlineStats.h" |
Syntax
class FOnlineLeaderboardRead
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FOnlineLeaderboardRead() |
OnlineStats.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ColumnMetadata | TArray< FColumnMetaData > | Column metadata for this leaderboard | OnlineStats.h | |
| LeaderboardName | FNameDeprecationWrapper | Name of the leaderboard read | OnlineStats.h | |
| ReadState | EOnlineAsyncTaskState::Type | Indicates an error reading data occurred while processing | OnlineStats.h | |
| Rows | TArray< FOnlineStatsRow > | Array of ranked users retrieved (not necessarily sorted yet) | OnlineStats.h | |
| SortedColumn | FNameDeprecationWrapper | Column this leaderboard is sorted by | OnlineStats.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FOnlineStatsRow * FindPlayerRecord
(
const FUniqueNetId& UserId |
Retrieve a single record from the leaderboard for a given user | OnlineStats.h | |
FString ToLogString() |
OnlineStats.h |