FOnlineLeaderboardsOmni

Description

Implementation of the IOnlineLeaderboards interface for the OnlineSubsystem.

See also

IOnlineLeaderboards

#include <OnlineLeaderboardsOmni.h>

Inherits IOnlineLeaderboards.

Public Member Functions
virtual bool	ReadLeaderboards (const TArray< FUniqueNetIdRef > &Players, FOnlineLeaderboardReadRef &ReadObject) override
	Get entries from a leaderboard.
virtual bool	ReadLeaderboardsForFriends (int32 LocalUserNum, FOnlineLeaderboardReadRef &ReadObject) override
	Gets entries from a leaderboard, filtering to only include entries from friends of the logged-in user.
virtual bool	ReadLeaderboardsAroundRank (int32 Rank, uint32 Range, FOnlineLeaderboardReadRef &ReadObject) override
	Not Supported.
virtual bool	ReadLeaderboardsAroundUser (FUniqueNetIdRef Player, uint32 Range, FOnlineLeaderboardReadRef &ReadObject) override
	Not Supported.
virtual void	FreeStats (FOnlineLeaderboardRead &ReadObject) override
	Not Supported.
virtual bool	WriteLeaderboards (const FName &SessionName, const FUniqueNetId &Player, FOnlineLeaderboardWrite &WriteObject) override
	Writes an entry to the leaderboard for the currently logged-in user.
virtual bool	FlushLeaderboards (const FName &SessionName) override
	Executes OnLeaderboardFlushCompleteDelegate, as WriteLeaderboards implementation does not cache.
virtual bool	WriteOnlinePlayerRatings (const FName &SessionName, int32 LeaderboardId, const TArray< FOnlinePlayerScore > &PlayerScores) override
	Not Supported.

Methods

FlushLeaderboards()

virtual bool FOnlineLeaderboardsOmni::FlushLeaderboards ( const FName &  SessionName )

overridevirtual

Executes OnLeaderboardFlushCompleteDelegate, as WriteLeaderboards implementation does not cache.

Parameters

SessionName

Unused

Returns

True if request was successful, false otherwise.

ReadLeaderboards()

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

overridevirtual

Get entries from a leaderboard.

Will execute OnLeaderboardReadCompleteDelegate when finished.

Parameters

Players	Defines how entries are returned. If the ID of the logged in user is passed in, the results will be returned centered on the viewer, meaning their entry will be on the center of the first page. If this parameter is left empty, the entries will be returned starting at the very top of the leaderboard.
ReadObject	Used to set the name of the desired leaderboard.

Returns

True if request is successful, false otherwise.

ReadLeaderboardsAroundRank()

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

overridevirtual

Not Supported.

Returns false.

ReadLeaderboardsAroundUser()

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

overridevirtual

Not Supported.

Returns false.

ReadLeaderboardsForFriends()

virtual bool FOnlineLeaderboardsOmni::ReadLeaderboardsForFriends ( int32  LocalUserNum, FOnlineLeaderboardReadRef &  ReadObject  )

overridevirtual

Gets entries from a leaderboard, filtering to only include entries from friends of the logged-in user.

Will execute OnLeaderboardReadCompleteDelegate when finished.

Parameters

LocalUserNum	Unused
ReadObject	Used to set the name of the desired leaderboard.

Returns

True if request is successful, false otherwise.

WriteLeaderboards()

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

overridevirtual

Writes an entry to the leaderboard for the currently logged-in user.

Parameters

SessionName	Unused
Player	Id of the logged-in player to write the entry for
WriteObject	Object containing the leaderboard name and desired score

Returns

True if request was successful, false otherwise.

WriteOnlinePlayerRatings()

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

overridevirtual

Not Supported.

Returns false.