FOnlineLeaderboardAccelByte Class Reference

Inheritance diagram for FOnlineLeaderboardAccelByte:

Public Member Functions
virtual bool	ReadLeaderboardsCycle (TArray< FUniqueNetIdRef > const &Players, FOnlineLeaderboardReadRef &ReadObject, FString const &CycleId)
virtual bool	ReadLeaderboardsForFriendsCycle (int32 LocalUserNum, FOnlineLeaderboardReadRef &ReadObject, FString const &CycleId)
virtual bool	ReadLeaderboards (TArray< FUniqueNetIdRef > const &Players, FOnlineLeaderboardReadRef &ReadObject) override
virtual bool	ReadLeaderboardsForFriends (int32 LocalUserNum, FOnlineLeaderboardReadRef &ReadObject) override
virtual bool	ReadLeaderboardsAroundRank (int32 Rank, uint32 Range, FOnlineLeaderboardReadRef &ReadObject) override
	Query leaderboard ranks around a pivoted rank.
virtual bool	ReadLeaderboardCycleAroundRank (int32 Rank, uint32 Range, FString const &CycleId, FOnlineLeaderboardReadRef &ReadObject)
	Query leaderboard ranks around a pivoted rank.
virtual bool	ReadLeaderboardsAroundUser (FUniqueNetIdRef Player, uint32 Range, FOnlineLeaderboardReadRef &ReadObject) override
	Query leaderboard ranks in the range a specific user rank.
virtual bool	ReadLeaderboardCycleAroundUser (FUniqueNetIdRef Player, uint32 Range, FString const &CycleId, FOnlineLeaderboardReadRef &ReadObject)
	Query leaderboard ranks in the range a specific user rank.
virtual void	FreeStats (FOnlineLeaderboardRead &ReadObject) override
virtual bool	WriteLeaderboards (FName const &SessionName, FUniqueNetId const &Player, FOnlineLeaderboardWrite &WriteObject) override
virtual bool	FlushLeaderboards (FName const &SessionName) override
virtual bool	WriteOnlinePlayerRatings (FName const &SessionName, int32 LeaderboardId, TArray< FOnlinePlayerScore > const &PlayerScores) override

Static Public Member Functions
static bool	GetFromSubsystem (const IOnlineSubsystem *Subsystem, TSharedPtr< FOnlineLeaderboardAccelByte, ESPMode::ThreadSafe > &OutInterfaceInstance)
static bool	GetFromWorld (const UWorld *World, TSharedPtr< FOnlineLeaderboardAccelByte, ESPMode::ThreadSafe > &OutInterfaceInstance)

Protected Member Functions
	FOnlineLeaderboardAccelByte ()

Protected Attributes
FOnlineSubsystemAccelByteWPtr	AccelByteSubsystem = nullptr

Constructor & Destructor Documentation

FOnlineLeaderboardAccelByte()

FOnlineLeaderboardAccelByte::FOnlineLeaderboardAccelByte ( )

inlineprotected

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

Member Function Documentation

FlushLeaderboards()

bool FOnlineLeaderboardAccelByte::FlushLeaderboards ( FName const & SessionName )

overridevirtual

Is not supported.

FreeStats()

void FOnlineLeaderboardAccelByte::FreeStats ( FOnlineLeaderboardRead & ReadObject )

overridevirtual

Is not supported.

GetFromSubsystem()

bool FOnlineLeaderboardAccelByte::GetFromSubsystem ( const IOnlineSubsystem * Subsystem, TSharedPtr< FOnlineLeaderboardAccelByte, ESPMode::ThreadSafe > & OutInterfaceInstance )

static

Convenience method to get an instance of this interface from the subsystem passed in.

Parameters

Subsystem	Subsystem instance that we wish to get this interface from
OutInterfaceInstance	Instance of the interface that we got from the subsystem, or nullptr if not found

Returns

boolean that is true if we could get an instance of the interface, false otherwise

GetFromWorld()

bool FOnlineLeaderboardAccelByte::GetFromWorld ( const UWorld * World, TSharedPtr< FOnlineLeaderboardAccelByte, ESPMode::ThreadSafe > & OutInterfaceInstance )

static

Convenience method to get an instance of this interface from the subsystem associated with the world passed in.

Parameters

World	World instance that we wish to get the interface from
OutInterfaceInstance	Instance of the interface that we got from the subsystem, or nullptr if not found

Returns

boolean that is true if we could get an instance of the interface, false otherwise

ReadLeaderboardCycleAroundRank()

bool FOnlineLeaderboardAccelByte::ReadLeaderboardCycleAroundRank ( int32 Rank, uint32 Range, FString const & CycleId, FOnlineLeaderboardReadRef & ReadObject )

virtual

Query leaderboard ranks around a pivoted rank.

This endpoint will fetch a set amount of ranks based on the pivoted rank and the range. Note:

1. This endpoint only gives Cycle type leaderboard.

Parameters

Rank	A rank you want to pivot at.
Range	The number of ranks to be retrieved below and above the pivoted rank.
CycleId	The cycle of the leaderboard to retrieve the ranks at.
ReadObject	This will contain the request and results when the operation completes.

Returns

ReadLeaderboardCycleAroundUser()

bool FOnlineLeaderboardAccelByte::ReadLeaderboardCycleAroundUser ( FUniqueNetIdRef Player, uint32 Range, FString const & CycleId, FOnlineLeaderboardReadRef & ReadObject )

virtual

Query leaderboard ranks in the range a specific user rank.

This endpoint will fetch a set amount of ranks closed to a specific user rank. Note:

1. This endpoint only gives Cycle type leaderboard.

Parameters

Player	The pivoted player
Range	The amount of rank to be retrieved. This means the OSS will fetch ranks below and above the user rank in the amount of the range.
CycleId	The cycle of the leaderboard to retrieve the ranks at.
ReadObject	This will contain the request and results when the operation completes.

ReadLeaderboards()

bool FOnlineLeaderboardAccelByte::ReadLeaderboards ( TArray< FUniqueNetIdRef > const & Players, FOnlineLeaderboardReadRef & ReadObject )

overridevirtual

Query multiple ranks for multiple users. This request only for Game Client. Note:

1. This endpoint only gives All Time type leaderboard.
2. Please use 'AllTime_Point' to name the point column.

Parameters

Players	Array of user to get rank for
ReadObject	This will contain the request and results when the operation completes.

ReadLeaderboardsAroundRank()

bool FOnlineLeaderboardAccelByte::ReadLeaderboardsAroundRank ( int32 Rank, uint32 Range, FOnlineLeaderboardReadRef & ReadObject )

overridevirtual

Query leaderboard ranks around a pivoted rank.

This endpoint will fetch a set amount of ranks based on the pivoted rank and the range. Note:

1. This endpoint only gives All Time type leaderboard.

Parameters

Rank	A rank you want to pivot at.
Range	The number of ranks to be retrieved below and above the pivoted rank.
ReadObject	This will contain the request and results when the operation completes.

ReadLeaderboardsAroundUser()

bool FOnlineLeaderboardAccelByte::ReadLeaderboardsAroundUser ( FUniqueNetIdRef Player, uint32 Range, FOnlineLeaderboardReadRef & ReadObject )

overridevirtual

Query leaderboard ranks in the range a specific user rank.

This endpoint will fetch a set amount of ranks closed to a specific user rank. Note:

1. This endpoint only gives All Time type leaderboard.

Parameters

Player	The pivoted player
Range	The amount of rank to be retrieved. This means the OSS will fetch ranks below and above the user rank in the amount of the range.
ReadObject	This will contain the request and results when the operation completes.

ReadLeaderboardsCycle()

bool FOnlineLeaderboardAccelByte::ReadLeaderboardsCycle ( TArray< FUniqueNetIdRef > const & Players, FOnlineLeaderboardReadRef & ReadObject, FString const & CycleId )

virtual

Query multiple ranks for multiple users. This request only for Game Client. Note:

1. This endpoint only gives Cycle type leaderboard.
2. Please use 'Cycle_Point' to name the point column.

Parameters

Players	Array of user to get rank for
ReadObject	This will contain the request and results when the operation completes.
CycleId	The cycle id that player want to know.

ReadLeaderboardsForFriends()

bool FOnlineLeaderboardAccelByte::ReadLeaderboardsForFriends ( int32 LocalUserNum, FOnlineLeaderboardReadRef & ReadObject )

overridevirtual

Query all user friends' ranks. This request only for Game Client. Note:

1. This endpoint only gives All Time type leaderboard.
2. Please use 'AllTime_Point' to name the point column.

Parameters

LocalUserNum	Index of user that is attempting to query the rank.
ReadObject	This will contain the request and results when the operation completes.

ReadLeaderboardsForFriendsCycle()

bool FOnlineLeaderboardAccelByte::ReadLeaderboardsForFriendsCycle ( int32 LocalUserNum, FOnlineLeaderboardReadRef & ReadObject, FString const & CycleId )

virtual

Query all user friends' ranks. This request only for Game Client. Note:

1. This endpoint only gives Cycle type leaderboard.
2. Please use 'Cycle_Point' to name the point column.

Parameters

LocalUserNum	Index of user that is attempting to query the rank.
ReadObject	This will contain the request and results when the operation completes.
CycleId	The cycle id that player want to know.

WriteLeaderboards()

bool FOnlineLeaderboardAccelByte::WriteLeaderboards ( FName const & SessionName, FUniqueNetId const & Player, FOnlineLeaderboardWrite & WriteObject )

overridevirtual

Is not supported.

WriteOnlinePlayerRatings()

bool FOnlineLeaderboardAccelByte::WriteOnlinePlayerRatings ( FName const & SessionName, int32 LeaderboardId, TArray< FOnlinePlayerScore > const & PlayerScores )

overridevirtual

Is not supported.

Member Data Documentation

AccelByteSubsystem

FOnlineSubsystemAccelByteWPtr FOnlineLeaderboardAccelByte::AccelByteSubsystem = nullptr

protected

Instance of the subsystem that created this interface