beamable-sdk / services / GetLeaderboardParams

Interface: GetLeaderboardParams

Defined in: src/services/LeaderboardsService.ts:16

Properties

focus?

optional focus: string | bigint

Defined in: src/services/LeaderboardsService.ts:29

Player (gamertag) to center the leaderboard view on.

---

from?

optional from: number

Defined in: src/services/LeaderboardsService.ts:22

Start rank of the leaderboard view.

Remarks

This is ignored when focus is set

---

id

id: string

Defined in: src/services/LeaderboardsService.ts:18

The ID of the leaderboard to fetch.

---

includeFriends?

optional includeFriends: boolean

Defined in: src/services/LeaderboardsService.ts:36

Whether to include friends in the leaderboard.

---

includeGuilds?

optional includeGuilds: boolean

Defined in: src/services/LeaderboardsService.ts:38

Whether to include group members in the leaderboard.

---

max?

optional max: number

Defined in: src/services/LeaderboardsService.ts:27

Maximum number of ranks to return in the leaderboard view.

Remarks

When focus is set, includes the focused player plus up to max/2 entries before and after. If one side has fewer entries, it’s truncated.

---

outlier?

optional outlier: string | bigint

Defined in: src/services/LeaderboardsService.ts:34

Player (gamertag) to use as an outlier in the leaderboard view.

Remarks

This is used to include a specific player in the leaderboard view.