Interface ILeaderboard

Provides interface to read data from a leaderboard stored on game server.

Namespace: VoxelBusters.EssentialKit

Assembly: cs.temp.dll.dll

Syntax

public interface ILeaderboard

Remarks

\note Your game must authenticate the local user before using any features.

Properties

Id

An unique string used to identify the leaderboard across all the supported platforms. (read-only)

Declaration

string Id { get; }

Property Value

Type	Description
System.String

LoadScoresQuerySize

The value indicates maximum entries that has to be fetched from search.

Declaration

int LoadScoresQuerySize { get; set; }

Property Value

Type	Description
System.Int32

LocalPlayerScore

Returns the IScore earned by the local player. (read-only)

Declaration

IScore LocalPlayerScore { get; }

Property Value

Type	Description
IScore

Remarks

\note This property is invalid until a call to load scores is completed.

PlatformId

An unique used to identify the leaderboard in the current platform. (read-only)

Declaration

string PlatformId { get; }

Property Value

Type	Description
System.String

PlayerScope

A filter used to restrict the search to a subset of the players on game server.

Declaration

LeaderboardPlayerScope PlayerScope { get; set; }

Property Value

Type	Description
LeaderboardPlayerScope

TimeScope

A filter used to restrict the search to scores that were posted within a specific period of time.

Declaration

LeaderboardTimeScope TimeScope { get; set; }

Property Value

Type	Description
LeaderboardTimeScope

Title

A localized title for the leaderboard. (read-only)

Declaration

string Title { get; }

Property Value

Type	Description
System.String

Methods

LoadImage(EventCallback<TextureData>)

Loads the image.

Declaration

void LoadImage(EventCallback<TextureData> callback)

Parameters

Type	Name	Description
EventCallback<TextureData>	callback	Callback method that will be invoked after operation is completed.

LoadNext(EventCallback<LeaderboardLoadScoresResult>)

Loads next set of scores.

Declaration

void LoadNext(EventCallback<LeaderboardLoadScoresResult> callback)

Parameters

Type	Name	Description
EventCallback<LeaderboardLoadScoresResult>	callback	Callback method that will be invoked after operation is completed.

LoadPlayerCenteredScores(EventCallback<LeaderboardLoadScoresResult>)

Loads player-centered set of scores.

Declaration

void LoadPlayerCenteredScores(EventCallback<LeaderboardLoadScoresResult> callback)

Parameters

Type	Name	Description
EventCallback<LeaderboardLoadScoresResult>	callback	Callback method that will be invoked after operation is completed.

LoadPrevious(EventCallback<LeaderboardLoadScoresResult>)

Loads previous set of scores.

Declaration

void LoadPrevious(EventCallback<LeaderboardLoadScoresResult> callback)

Parameters

Type	Name	Description
EventCallback<LeaderboardLoadScoresResult>	callback	Callback method that will be invoked after operation is completed.

LoadTopScores(EventCallback<LeaderboardLoadScoresResult>)

Loads the top set of scores.

Declaration

void LoadTopScores(EventCallback<LeaderboardLoadScoresResult> callback)

Parameters

Type	Name	Description
EventCallback<LeaderboardLoadScoresResult>	callback	Callback method that will be invoked after operation is completed.