Event Leaderboards #

Read more about the Event Leaderboards system in Hiro here.

Get an event leaderboard #

Get a specified event leaderboard defined for the game.

1
2
3
4
5
6

const request : EventLeaderboardGet = {
    id: "leaderboard_1"
};

const eventLeaderboard = await hiroClient.eventLeaderboardGet(session, request);
console.log(eventLeaderboard);

Update event leaderboard record #

Update an event leaderboard record for a user.

1
2
3
4
5
6
7
8

const request : EventLeaderboardUpdate = {
    id: "leaderboard_1",
    score: 100,
    subscore: 10
};

const eventLeaderboard = await hiroClient.eventLeaderboardUpdate(session, request);
console.log(eventLeaderboard);

Claim event leaderboard reward #

Claim an event leaderboard reward for a user.

1
2
3
4
5
6

const request : EventLeaderboardClaim = {
    id: "leaderboard_1"
};

const eventLeaderboard = await hiroClient.eventLeaderboardClaim(session, request);
console.log(eventLeaderboard);

Roll a new cohort #

Roll a new cohort for the specified event leaderboard.

1
2
3
4
5
6

const request : EventLeaderboardRoll = {
    id: "leaderboard_1"
};

const eventLeaderboard = await hiroClient.eventLeaderboardRoll(session, request);
console.log(eventLeaderboard);