godeck

README

godeck

A Golang representation for a deck of cards, a shuffling algorithm, and ability to go to 2 or more decks of cards.

Documentation

Index

• type Card
  • func (c Card) String() string
• type Deck
  • func NewDeck(NumDecks int, Jokers bool, NumJokers int) *Deck
  • func (d *Deck) Deal() Card
• type DiscardPile
  • func NewDiscardPile() *DiscardPile
  • func (d *DiscardPile) AddCard(c Card)
  • func (d *DiscardPile) Peek() Card
  • func (d *DiscardPile) RemoveCard() Card
  • func (d *DiscardPile) Size() int
  • func (d *DiscardPile) TakeAll() []Card
• type PlayerHand
  • func (h *PlayerHand) AddCard(c Card)
  • func (h *PlayerHand) AddCards(cards []Card)
  • func (h *PlayerHand) RemoveCard(i int) Card

Types

type Card

type Card struct {
	Suit  string
	Value string
}

func (Card) String

func (c Card) String() string

type Deck

type Deck struct {
	Cards     []Card
	NumDecks  int
	Jokers    bool
	NumJokers int
}

func NewDeck

func NewDeck(NumDecks int, Jokers bool, NumJokers int) *Deck

func (*Deck) Deal

func (d *Deck) Deal() Card

type DiscardPile

type DiscardPile struct {
	Cards *arraystack.Stack
}

func NewDiscardPile

func NewDiscardPile() *DiscardPile

func (*DiscardPile) AddCard

func (d *DiscardPile) AddCard(c Card)

func (*DiscardPile) Peek

func (d *DiscardPile) Peek() Card

if nil is returned, the discard pile is empty

func (*DiscardPile) RemoveCard

func (d *DiscardPile) RemoveCard() Card

func (*DiscardPile) Size

func (d *DiscardPile) Size() int

func (*DiscardPile) TakeAll

func (d *DiscardPile) TakeAll() []Card

type PlayerHand

type PlayerHand struct {
	Cards []Card
}

func (*PlayerHand) AddCard

func (h *PlayerHand) AddCard(c Card)

func (*PlayerHand) AddCards

func (h *PlayerHand) AddCards(cards []Card)

func (*PlayerHand) RemoveCard

func (h *PlayerHand) RemoveCard(i int) Card