highscores

Documentation

Overview

Package highscores implements the Termacade high scores viewer.

Index

• func FetchRecording(ctx context.Context, code string) (*arcade.Recording, error)
• type Entry
  • func FetchScores(ctx context.Context, game arcade.Game, mode Mode, page int) ([]Entry, error)
• type HighScores
  • func (hs *HighScores) Run(ctx context.Context) error
• type Mode
  • func (i Mode) String() string
• type RecordingViewer
  • func (v *RecordingViewer) Run(ctx context.Context) error

Functions

func FetchRecording

func FetchRecording(ctx context.Context, code string) (*arcade.Recording, error)

FetchRecording downloads a high scores recording.

Types

type Entry

type Entry struct {
	Code   string `json:"c"`
	Score  int64  `json:"s"`
	Player string `json:"p"`
}

Entry is a single item in the high scores list.

func FetchScores

func FetchScores(ctx context.Context, game arcade.Game, mode Mode, page int) ([]Entry, error)

FetchScores downloads a page of high scores data from the server.

type HighScores

type HighScores struct {
	Camera gfx.Camera
	CRT    crt.CRT

	Game  arcade.Game
	Mode  Mode
	Page  int
	Index int
	// contains filtered or unexported fields
}

HighScores is the high scores viewer.

func (*HighScores) Run

func (hs *HighScores) Run(ctx context.Context) error

Run displays the high scores viewer.

type Mode

type Mode uint8

Mode is a high scores filtering mode.

const (
	Recent    Mode = 'r'
	Weekly    Mode = 'w'
	Quarterly Mode = 'q'
	AllTime   Mode = 'a'
)

Constants for Mode.

func (Mode) String

func (i Mode) String() string

type RecordingViewer

type RecordingViewer struct {
	Code string
}

RecordingViewer displays a game recording.

func (*RecordingViewer) Run

func (v *RecordingViewer) Run(ctx context.Context) error

Run plays the recording.