lobbies

Documentation

Index

• Variables
• func NewCancellableTimer(d time.Duration) *cancellableTimer
• func NewLobbiesRouter() http.Handler
• type ByScore
  • func (a ByScore) Len() int
  • func (a ByScore) Less(i, j int) bool
  • func (a ByScore) Swap(i, j int)
• type ClientID
  • func NewClientID() (ClientID, error)
• type Lobby
• type LobbySettingsData
• type LobbyState
  • func (state LobbyState) View() *template.Template
• type OnFinishData
• type User
• type ViewData

Variables

var AnswerView = common.ParseTmplWithFuncs("templates/views/answer-view.html")

var ChooseUsernameView = common.ParseTmplWithFuncs("templates/views/choose-username-view.html")

Views are the templates that are rendered for the different states of the lobby All of them require ViewData as the data to render

var LobbiesTmpl = tmplParseWithBase("templates/lobbies/lobbies.html")

var LobbyErrorAlertTmpl = LobbyTmpl.Lookup("error-alert")

var LobbySettingsTmpl = WaitingRoomView.Lookup("lobby-settings")

This template is used to render the lobby settings inside waitingRoomView

var LobbyTmpl = tmplParseWithBase("templates/lobbies/lobby.html")

var QuestionView = common.ParseTmplWithFuncs("templates/views/question-view.html")

var WaitingRoomView = common.ParseTmplWithFuncs("templates/views/waiting-room-view.html")

Functions

func NewCancellableTimer

func NewCancellableTimer(d time.Duration) *cancellableTimer

func NewLobbiesRouter

func NewLobbiesRouter() http.Handler

Returns a handler for routes starting with /lobbies

Types

type ByScore

type ByScore []*User

ByScore implements sort.Interface for []*user based on the Score field User for calculating leaderboard

func (ByScore) Len

func (a ByScore) Len() int

func (ByScore) Less

func (a ByScore) Less(i, j int) bool

func (ByScore) Swap

func (a ByScore) Swap(i, j int)

type ClientID

type ClientID string

func NewClientID

func NewClientID() (ClientID, error)

type Lobby

type Lobby struct {
	CreatedAt       time.Time
	StartedAt       time.Time
	FinishedAt      time.Time
	Quiz            models.Quiz
	Host            *User
	Pin             string
	TimePerQuestion time.Duration // Time for players to answer a question
	TimeForReading  time.Duration // Time to read the question before answering is allowed
	Players         map[ClientID]*User
	State           LobbyState

	CurrentQuestionStartTime time.Time
	CurrentQuestionTimeout   time.Time
	ReadingTimeout           time.Time
	CurrentQuestionIdx       int
	CurrentQuestion          *models.Question
	PlayersAnswering         int     // Number of players who haven't submitted an answer
	Leaderboard              []*User // Players sorted by score
	// contains filtered or unexported fields
}

Lobby is a actively running game session

type LobbySettingsData

type LobbySettingsData struct {
	Quizzes []models.QuizMetadata
	Lobby   *Lobby
}

type LobbyState

type LobbyState int

const (
	LsWaitingForPlayers LobbyState = iota
	LsQuestion
	LsAnswer
)

func (LobbyState) View

func (state LobbyState) View() *template.Template

View returns the view template for the given state

type OnFinishData

type OnFinishData struct {
	PastGameID uint
	ViewData
}

type User

type User struct {
	Conn                 *websocket.Conn
	ClientID             ClientID
	Username             string
	SubmittedAnswerIdx   int
	AnswerSubmissionTime time.Time
	Score                int
	NewPoints            int
}

type ViewData

type ViewData struct {
	Lobby *Lobby
	User  *User
}