callbreak

package

v0.0.0-...-b534549 Latest Latest Go to latest Published: Aug 21, 2023 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/prasantadh/callbreak-go

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func GetValidMoves(game *CallBreak) ([]deck.Card, error)
func RegisterStrategy(name string, f func() Strategy) error
func VerifyStrategy(name string) error
type Assistant
- func (p *Assistant) Assist()
type CallBreak
- func New() *CallBreak
- func (game *CallBreak) AddPlayer(config PlayerConfig) (PlayerId, error)
- func (game *CallBreak) Break(token Token, card deck.Card) error
- func (game *CallBreak) Call(token Token, call Score) error
- func (game *CallBreak) Next() int
- func (game *CallBreak) Query(token Token) (*CallBreak, error)
- func (game *CallBreak) Turn(token *Token) int
type Config
type Hand
- func (h *Hand) HasPlayable(cards ...deck.Card) bool
- func (h *Hand) HasSuit(suit deck.Suit) bool
- func (h *Hand) IsValid() bool
- func (h *Hand) Playables() []deck.Card
- func (h *Hand) Sort()
- func (h Hand) String() string
type PlayerConfig
type PlayerId
type Round
type Score
type Stage
type Strategy
- func GetStrategy(name string) (Strategy, error)
type Token
type Trick
- func (t *Trick) Add(card deck.Card)
- func (t *Trick) LeadCard() deck.Card
- func (t *Trick) LeadRank() deck.Rank
- func (t *Trick) LeadSuit() deck.Suit
- func (t Trick) SuitWinner(suit deck.Suit) int
- func (t Trick) Winner() int

Constants ¶

View Source

const (
	NCards   = 52
	NPlayers = 4
	NRounds  = 5
	NTricks  = NCards / NPlayers

	AssistMinTimeout = 50 * time.Millisecond
	AssistMaxTimeout = 30 * time.Second
)

Variables ¶

This section is empty.

Functions ¶

func GetValidMoves ¶

func GetValidMoves(game *CallBreak) ([]deck.Card, error)

return a slice containing cards that can be played by the player with next turn in the ongoing trick

func RegisterStrategy ¶

func RegisterStrategy(name string, f func() Strategy) error

func VerifyStrategy ¶

func VerifyStrategy(name string) error

Types ¶

type Assistant ¶

type Assistant struct {
	// contains filtered or unexported fields
}

func (*Assistant) Assist ¶

func (p *Assistant) Assist()

type CallBreak ¶

type CallBreak struct {
	// TODO: think about have a token that provides access to all data in game
	Players      [NPlayers]PlayerId `json:"players"`
	Rounds       [NRounds]Round     `json:"rounds"`
	Stage        Stage              `json:"stage"`
	TotalPlayers int                `json:"totalplayers"`
	RoundNumber  int                `json:"roundnumber"`
	// contains filtered or unexported fields
}

CallBreak implements the callbreak game

func New ¶

func New() *CallBreak

func (*CallBreak) AddPlayer ¶

func (game *CallBreak) AddPlayer(config PlayerConfig) (PlayerId, error)

add a player to the game. returns an authentication token on success else return error on failure

func (*CallBreak) Break ¶

func (game *CallBreak) Break(token Token, card deck.Card) error

the next player in line playes the card c

func (*CallBreak) Call ¶

func (game *CallBreak) Call(token Token, call Score) error

func (*CallBreak) Next ¶

func (game *CallBreak) Next() int

func (*CallBreak) Query ¶

func (game *CallBreak) Query(token Token) (*CallBreak, error)

Get the current state of the game as visible to a token

func (*CallBreak) Turn ¶

func (game *CallBreak) Turn(token *Token) int

returns the turn in the game of the given token. [0-3] on success, NPlayers on failure

type Config ¶

type Config struct {
	Debug   bool `json:"debug,omitempty"`
	Players []PlayerConfig
}

type Hand ¶

type Hand [NTricks]deck.Card

func (*Hand) HasPlayable ¶

func (h *Hand) HasPlayable(cards ...deck.Card) bool

func (*Hand) HasSuit ¶

func (h *Hand) HasSuit(suit deck.Suit) bool

func (*Hand) IsValid ¶

func (h *Hand) IsValid() bool

func (*Hand) Playables ¶

func (h *Hand) Playables() []deck.Card

func (*Hand) Sort ¶

func (h *Hand) Sort()

sort by suit, Hukum -> itta -> chidi -> paan for the same suit, sort by rank descending

func (Hand) String ¶

func (h Hand) String() string

type PlayerConfig ¶

type PlayerConfig struct {
	Name     string        `json:"name"`
	Strategy string        `json:"strategy"`
	Timeout  time.Duration `json:"timeout"`
}

type PlayerId ¶

type PlayerId struct {
	Name  string `json:"name"`
	Token `json:"token"`
}

type Round ¶

type Round struct {
	Calls       [NPlayers]Score
	Scores      [NPlayers]Score
	Hands       [NPlayers]Hand
	Tricks      [NTricks]Trick
	TrickNumber int // current Trick number
}

type Score ¶

type Score int

type Stage ¶

type Stage int

track the current state of the game

const (
	NOTFULL Stage = iota
	DEALT
	CALLED
	DONE
)

type Strategy ¶

type Strategy interface {
	Call(*CallBreak) (Score, error)
	Break(*CallBreak) (deck.Card, error)
}

func GetStrategy ¶

func GetStrategy(name string) (Strategy, error)

type Token ¶

type Token string

type Trick ¶

type Trick struct {
	Cards [NPlayers]deck.Card
	Lead  int // the card position that is 1st in this trick
	Size  int // number of cards played so far in this trick
}

func (*Trick) Add ¶

func (t *Trick) Add(card deck.Card)

func (*Trick) LeadCard ¶

func (t *Trick) LeadCard() deck.Card

func (*Trick) LeadRank ¶

func (t *Trick) LeadRank() deck.Rank

func (*Trick) LeadSuit ¶

func (t *Trick) LeadSuit() deck.Suit

func (Trick) SuitWinner ¶

func (t Trick) SuitWinner(suit deck.Suit) int

returns index of the winning card of a trick but only considers cards of a given suit -1 if no card of the suit exist

func (Trick) Winner ¶

func (t Trick) Winner() int

returns the index of the winning card in a given trick

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL