Description

Function library that allows access to the Omni Leaderboard Service via Blueprint.

#include <OmniLeaderboardService.h>

Inherits UBlueprintFunctionLibrary.

Methods
static void	OmniLeaderboardGet (UObject *WorldContext, const FString &InLeaderboardName, FLeaderboardGetDynamicDelegate InLeaderboardGetCallback)
	Returns an array of UOmniLeaderboard objects for the provided name.

static void	OmniLeaderboardGetEntries (UObject *WorldContext, const FString &InLeaderboardName, int32 PageSize, int32 PageIndex, EOmniLeaderboardFilterType Filter, EOmniLeaderboardStartAt StartAt, FLeaderboardGetEntriesDynamicDelegate InLeaderboardGetEntriesCallback)
	Returns an array of UOmniLeaderboardEntry objects for the provided name.

static void	OmniLeaderboardGetEntriesAfterRank (UObject *WorldContext, const FString &InLeaderboardName, int32 PageSize, int32 PageIndex, int64 AfterRank, FLeaderboardGetEntriesDynamicDelegate InLeaderboardGetEntriesAfterRankCallback)
	Retrieves a paged list of entries from the given leaderboard, starting at a specific rank.

static void	OmniLeaderboardGetEntriesByIds (UObject *WorldContext, const FString &LeaderboardName, int32 PageSize, int32 PageIndex, EOmniLeaderboardStartAt StartAt, const TArray< FString > &UserIds, FLeaderboardGetEntriesDynamicDelegate InLeaderboardGetEntriesByIdsCallback)
	Retrieves a paged list of entries from the given leaderboard, containing only the specified users.

static void	OmniLeaderboardWriteEntry (UObject *WorldContext, const FString &InLeaderboardName, const int32 Score, const FString &ExtraData, const bool ForceUpdate, FLeaderboardWriteEntryDynamicDelegate InLeaderboardWriteEntryCallback)
	Writes a new entry to a leaderboard, tied to the current user.

static void	OmniLeaderboardWriteEntryWithSupplementaryMetric (UObject *WorldContext, const FString &InLeaderboardName, const int32 Score, const int32 SupplementaryMetric, const FString &ExtraData, const bool ForceUpdate, FLeaderboardWriteEntryDynamicDelegate InLeaderboardWriteEntryCallback)
	Writes a new entry to a leaderboard, tied to the current user.

Methods

◆ OmniLeaderboardGet()

static void UOmniLeaderboardsFunctions::OmniLeaderboardGet	(	UObject *	WorldContext,
		const FString &	InLeaderboardName,
		FLeaderboardGetDynamicDelegate	InLeaderboardGetCallback
	)

static

Returns an array of UOmniLeaderboard objects for the provided name.

Returns an array of UOmniLeaderboard objects for the provided name and executes callback with the array.

Parameters

WorldContext	Reference to the world context.
InLeaderboardName	Name of the leaderboard.
InLeaderboardGetCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, TArray<ULeaderboard*>& LeaderboardArray (empty in error cases) are passed as parameters.

◆ OmniLeaderboardGetEntries()

static void UOmniLeaderboardsFunctions::OmniLeaderboardGetEntries	(	UObject *	WorldContext,
		const FString &	InLeaderboardName,
		int32	PageSize,
		int32	PageIndex,
		EOmniLeaderboardFilterType	Filter,
		EOmniLeaderboardStartAt	StartAt,
		FLeaderboardGetEntriesDynamicDelegate	InLeaderboardGetEntriesCallback
	)

static

Returns an array of UOmniLeaderboardEntry objects for the provided name.

Returns an array of UOmniLeaderboardEntry objects for the provided name and executes callback with the array.

Parameters

WorldContext	Reference to the world context.
InLeaderboardName	Name of the leaderboard.
PageSize	Number of entries per page.
PageIndex	Index of the page to retrieve.
Filter	User relation filter.
StartAt	Start position.
InLeaderboardGetEntriesCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, TArray<UOmniLeaderboardEntry*>& LeaderboardArray (nullptr in error cases) are passed as parameters.

◆ OmniLeaderboardGetEntriesAfterRank()

static void UOmniLeaderboardsFunctions::OmniLeaderboardGetEntriesAfterRank	(	UObject *	WorldContext,
		const FString &	InLeaderboardName,
		int32	PageSize,
		int32	PageIndex,
		int64	AfterRank,
		FLeaderboardGetEntriesDynamicDelegate	InLeaderboardGetEntriesAfterRankCallback
	)

static

Retrieves a paged list of entries from the given leaderboard, starting at a specific rank.

Returns an array of UOmniLeaderboardEntry objects for the provided parameters and executes callback with the array.

Parameters

WorldContext	Reference to the world context.
InLeaderboardName	Name of the leaderboard.
PageSize	Number of entries per page.
PageIndex	Index of the page to retrieve.
AfterRank	The rank where the list will start.
InLeaderboardGetEntriesAfterRankCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, TArray<UOmniLeaderboardEntry*>& LeaderboardArray (nullptr in error cases) are passed as parameters.

◆ OmniLeaderboardGetEntriesByIds()

static void UOmniLeaderboardsFunctions::OmniLeaderboardGetEntriesByIds	(	UObject *	WorldContext,
		const FString &	LeaderboardName,
		int32	PageSize,
		int32	PageIndex,
		EOmniLeaderboardStartAt	StartAt,
		const TArray< FString > &	UserIds,
		FLeaderboardGetEntriesDynamicDelegate	InLeaderboardGetEntriesByIdsCallback
	)

static

Retrieves a paged list of entries from the given leaderboard, containing only the specified users.

Returns an array of UOmniLeaderboardEntry objects for the provided parameters and executes callback with the array.

Parameters

WorldContext	Reference to the world context.
LeaderboardName	Name of the leaderboard.
PageSize	Number of entries per page.
PageIndex	Index of the page to retrieve.
StartAt	Defines the starting point of the first page of the list.
UserIds	The list of user IDs to retrieve entries for.
InLeaderboardGetEntriesByIdsCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, TArray<UOmniLeaderboardEntry*>& LeaderboardArray (nullptr in error cases) are passed as parameters.

◆ OmniLeaderboardWriteEntry()

static void UOmniLeaderboardsFunctions::OmniLeaderboardWriteEntry	(	UObject *	WorldContext,
		const FString &	InLeaderboardName,
		const int32	Score,
		const FString &	ExtraData,
		const bool	ForceUpdate,
		FLeaderboardWriteEntryDynamicDelegate	InLeaderboardWriteEntryCallback
	)

static

Writes a new entry to a leaderboard, tied to the current user.

Parameters

WorldContext	Reference to the world context.
InLeaderboardName	The API Name of the desired leaderboard.
Score	The score to associate with this entry.
ExtraData	Any additional required information.
ForceUpdate	If true, will update the user's score even if the new score is lower than the previous value.
InLeaderboardWriteEntryCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, `bool bWasUpdated` are passed as parameters.

◆ OmniLeaderboardWriteEntryWithSupplementaryMetric()

static void UOmniLeaderboardsFunctions::OmniLeaderboardWriteEntryWithSupplementaryMetric	(	UObject *	WorldContext,
		const FString &	InLeaderboardName,
		const int32	Score,
		const int32	SupplementaryMetric,
		const FString &	ExtraData,
		const bool	ForceUpdate,
		FLeaderboardWriteEntryDynamicDelegate	InLeaderboardWriteEntryCallback
	)

static

Writes a new entry to a leaderboard, tied to the current user.

Parameters

WorldContext	Reference to the world context.
InLeaderboardName	The API Name of the desired leaderboard.
Score	The score to associate with this entry.
SupplementaryMetric	An additional value used as a tie-breaker.
ExtraData	Any additional required information.
ForceUpdate	If true, will update the user's score even if the new score is lower than the previous value.
InLeaderboardWriteEntryCallback	A callback that will be executed when the service has retrieved the information. `bool bIsError`, `const FString& ErrorMessage`, `bool bWasUpdated` are passed as parameters.