Class Leaderboard

Index

Methods

create submit remove clear size byIdEntry rankOf top around list saveLocal loadLocal uploadRemote syncRemote setOrder getOrder dispose

Methods

`Static`create

create(opts?: LeaderboardOptions): Leaderboard
Parameters
- opts: LeaderboardOptions = {}
Returns Leaderboard
- Defined in runtime/leaderboard.ts:94

submit

submit(entry: LeaderboardSubmission): boolean
Parameters
- entry: LeaderboardSubmission
Returns boolean
- Defined in runtime/leaderboard.ts:100

remove

remove(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/leaderboard.ts:120

clear

clear(): void
Returns void
- Defined in runtime/leaderboard.ts:125

size

size(): number
Returns number
- Defined in runtime/leaderboard.ts:130

byIdEntry

byIdEntry(id: string): ScoreEntry | null
Parameters
- id: string
Returns ScoreEntry | null
- Defined in runtime/leaderboard.ts:134

rankOf

rankOf(id: string): number
Parameters
- id: string
Returns number
- Defined in runtime/leaderboard.ts:149

top

top(n: number): ScoreEntry[]
Parameters
- n: number
Returns ScoreEntry[]
- Defined in runtime/leaderboard.ts:159

around

around(id: string, before: number, after: number): ScoreEntry[]
Parameters
- id: string
- before: number
- after: number
Returns ScoreEntry[]
- Defined in runtime/leaderboard.ts:167

list

list(): ScoreEntry[]
Returns ScoreEntry[]
- Defined in runtime/leaderboard.ts:182

saveLocal

saveLocal(): void
Returns void
- Defined in runtime/leaderboard.ts:187

loadLocal

loadLocal(): void
Returns void
- Defined in runtime/leaderboard.ts:192

uploadRemote

uploadRemote(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in runtime/leaderboard.ts:218

syncRemote

syncRemote(): Promise<void>
Returns Promise<void>
- Defined in runtime/leaderboard.ts:225

setOrder

setOrder(order: LeaderboardOrder): void
Parameters
- order: LeaderboardOrder
Returns void
- Defined in runtime/leaderboard.ts:240

getOrder

getOrder(): LeaderboardOrder
Returns LeaderboardOrder
- Defined in runtime/leaderboard.ts:246

dispose

dispose(): void
Returns void
- Defined in runtime/leaderboard.ts:248