leaderboard

Documentation

Overview

Package leaderboard starts a Gopher Run leaderboard server.

Index

• func AddScore(ctx context.Context, client *firestore.Client, d ScoreData) (string, error)
• type ScoreData
  • func TopScores(ctx context.Context, client *firestore.Client) ([]ScoreData, error)

Functions

func AddScore

func AddScore(ctx context.Context, client *firestore.Client, d ScoreData) (string, error)

AddScore adds a score to the leaderboard database and returns information about whether it updated an existing score.

Types

type ScoreData

type ScoreData struct {
	Name     string  `json:"name"`
	Team     string  `json:"team"`
	Coins    int     `json:"coins"`
	Distance float32 `json:"distance"`
	Combo    float32 `json:"combo"`
}

ScoreData is a player's score.

func TopScores

func TopScores(ctx context.Context, client *firestore.Client) ([]ScoreData, error)

TopScores returns the top 10 scores in the leaderboard.