game-sdk.d.ts 611 B

123456789101112131415161718192021222324252627
  1. interface GameSDKResult {
  2. ok: true
  3. rank: number
  4. }
  5. interface GameSDKError {
  6. ok: false
  7. error: string
  8. }
  9. type GameSDKSubmitResult = GameSDKResult | GameSDKError
  10. interface IGameSDK {
  11. /** This game's id string */
  12. gameId: string
  13. /** Current player's display name */
  14. getPlayerName(): string
  15. /**
  16. * Submit the final score for the current round.
  17. *
  18. * Call this when the game has clearly ended, not on every frame or every point gain.
  19. * On success, rank is the player's current leaderboard rank.
  20. */
  21. submit(score: number): Promise<GameSDKSubmitResult>
  22. }
  23. declare const GameSDK: IGameSDK