Leaderboard

API References for Leaderboard Service

Explore the list of API functions available in TypeScript for managing leaderboards and player scores, including detailed descriptions and usage examples.

To use service functions, first ensure that the service is activated before. You can see services by opening "Service Hub" From the game's dashboard header.

Get Available Leaderboards​

Retrieves a list of leaderboards based on the provided parameters.

DynamicPixels.Services.Leaderboards.GetLeaderboards(): Promise<Leaderboard[]>

Get Users Scores​

Obtains scores for individual users as specified by the input parameters.

DynamicPixels.Services.Leaderboards.GetUsersScores(input: GetScoresParams): Promise<UserScore[]>

Get Parties Scores​

Fetches scores for different parties (e.g., teams or groups) according to the given parameters.

DynamicPixels.Services.Leaderboards.GetPartiesScores(input: GetScoresParams): Promise<PartyScore[]>

Get Friends Scores​

Gathers scores specifically for friends of the current user.

DynamicPixels.Services.Leaderboards.GetFriendsScores(input: GetMyFriendsScoresParams): Promise<UserScore[]>

Get My Score​

Retrieves the score of the current user based on the input parameters.

DynamicPixels.Services.Leaderboards.GetMyScore(input: GetMyScoreParams): Promise<UserScore>

Submit New Score​

Submits a user's score and returns the result.

DynamicPixels.Services.Leaderboards.SubmitScore(input: SubmitScoreParams): Promise<Score>