Functions
Const closeLeaderboardView
Const displayLeaderboard
- displayLeaderboard(runtimeScene: RuntimeScene, leaderboardId: string, displayLoader: boolean): Promise<void>
Parameters
leaderboardId: string
displayLoader: boolean
Returns Promise<void>
Const formatPlayerName
- formatPlayerName(rawName?: null | string): string
Parameters
Optional rawName: null | string
Returns string
Const getLastSaveError
- getLastSaveError(leaderboardId?: string): null | string
Parameters
Optional leaderboardId: string
Returns null | string
Const hasBeenSaved
- hasBeenSaved(leaderboardId?: string): boolean
Parameters
Optional leaderboardId: string
Returns boolean
Const hasPlayerJustClosedLeaderboardView
- hasPlayerJustClosedLeaderboardView(): boolean
Const hasSavingErrored
- hasSavingErrored(leaderboardId?: string): boolean
Parameters
Optional leaderboardId: string
Returns boolean
Const isLeaderboardViewErrored
- isLeaderboardViewErrored(): boolean
Const isLeaderboardViewLoaded
- isLeaderboardViewLoaded(): boolean
Const isLeaderboardViewLoading
- isLeaderboardViewLoading(): boolean
Const isSaving
- isSaving(leaderboardId?: string): boolean
Parameters
Optional leaderboardId: string
Returns boolean
Const saveConnectedPlayerScore
Parameters
leaderboardId: string
score: number
Const savePlayerScore
- savePlayerScore(runtimeScene: RuntimeScene, leaderboardId: string, score: number, playerName: string): PromiseTask<void>
Parameters
leaderboardId: string
score: number
playerName: string
Const setPreferSendConnectedPlayerScore
- setPreferSendConnectedPlayerScore(runtimeScene: RuntimeScene, enable: boolean): void
Returns true if the player has just closed the leaderboard view.