LaunchBoxContributors
On this page

ILeaderboardCapability14.1

Interface in Unbroken.LaunchBox.Plugins.Capabilities.Leaderboards

C#
public interface ILeaderboardCapability : IPluginComponentMetadata
Reads player rankings independently of achievement, profile, and game-data capabilities.

Remarks

Implement on an existing managed component. The host uses the same activation and shared connection-change notifications. Reads must not initiate sign-in or submit scores.

Inheritance and interfaces

Properties

  • LeaderboardSourceIdGets the stable logical leaderboard source ID, independent of the plugin package.

LeaderboardSourceId

C#
string LeaderboardSourceId { get; }
Gets the stable logical leaderboard source ID, independent of the plugin package.

Remarks

Game IDs use the same namespace as other capabilities sharing this logical source ID. Different game-ID namespaces require separate logical source IDs.

Methods

GetLeaderboardAsync

C#
Task<IReadOnlyList<LeaderboardEntry>> GetLeaderboardAsync(
    LeaderboardRequest request,
    CancellationToken cancellationToken
)
Retrieves the selected board in provider ranking order.
request
The game, period, and player selection.
cancellationToken
Cancels retrieval.

Returns

The leading entries, or the current player's entry when requested. An empty list means a successful empty result. Providers may return a bounded leading subset; this is not a complete player directory. Throw on failure or account changes, and throw NotSupportedException for unsupported selections.