Class Hand

Represents a group of cards assigned to an IPlayer

Hierarchy

CardPile
- Hand

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Hand(cards?: ICard[]): Hand

Overrides CardPile.constructor
- Defined in src/models/cardCollection/hand.model.ts:13
Parameters
- Default value cards: ICard[] = []
Returns Hand

Properties

name

name: string = "Hand"

suitOrder

suitOrder: Suit[] = [Suit.Clubs, Suit.Spades, Suit.Diamonds, Suit.Hearts]

Methods

addCard

addCard(card: ICard): this

Implementation of IHand.addCard

Inherited from CardCollection.addCard
- Defined in src/models/cardCollection/cardCollection.model.ts:30
Parameters
- card: ICard
Returns this

addCards

addCards(cards: ICard[]): this

Implementation of IHand.addCards

Inherited from CardCollection.addCards
- Defined in src/models/cardCollection/cardCollection.model.ts:34
Parameters
- cards: ICard[]
Returns this

addCardsToBottom

addCardsToBottom(cards: ICard[]): void

Implementation of IHand.addCardsToBottom

Inherited from CardPile.addCardsToBottom
- Defined in src/models/cardCollection/cardPile.model.ts:17
Parameters
- cards: ICard[]
Returns void

cardAtIndex

cardAtIndex(index: number): ICard

Implementation of IHand.cardAtIndex

Inherited from CardCollection.cardAtIndex
- Defined in src/models/cardCollection/cardCollection.model.ts:120
Parameters
- index: number
Returns ICard

getCards

getCards(): ICard[]

Implementation of IHand.getCards

Inherited from CardCollection.getCards
- Defined in src/models/cardCollection/cardCollection.model.ts:74
Returns ICard[]

getCount

getCount(): number

Implementation of IHand.getCount

Inherited from CardCollection.getCount
- Defined in src/models/cardCollection/cardCollection.model.ts:98
Returns number

hasCard

hasCard(card: ICard): boolean

Implementation of IHand.hasCard

Inherited from CardCollection.hasCard
- Defined in src/models/cardCollection/cardCollection.model.ts:83
Parameters
- card: ICard
Returns boolean

hasCards

hasCards(cards: ICard[]): boolean

Implementation of IHand.hasCards

Inherited from CardCollection.hasCards
- Defined in src/models/cardCollection/cardCollection.model.ts:87
Parameters
- cards: ICard[]
Returns boolean

indexOfCard

indexOfCard(card: ICard): number

Implementation of IHand.indexOfCard

Inherited from CardCollection.indexOfCard
- Defined in src/models/cardCollection/cardCollection.model.ts:110
Parameters
- card: ICard
Returns number

isEmpty

isEmpty(): boolean

Implementation of IHand.isEmpty

Inherited from CardCollection.isEmpty
- Defined in src/models/cardCollection/cardCollection.model.ts:102
Returns boolean

playCard

playCard(card: ICard): void

Implementation of IHand.playCard
- Defined in src/models/cardCollection/hand.model.ts:25
Performs action of removing a card from player hand.

Throws error if ICard played is not in player's hand.

Parameters
- card: ICard
  
  Card being played
Returns void

removeCards

removeCards(cards: ICard[]): this

Implementation of IHand.removeCards

Inherited from CardCollection.removeCards
- Defined in src/models/cardCollection/cardCollection.model.ts:39
Parameters
- cards: ICard[]
Returns this

setCards

setCards(cards: ICard[]): this

Inherited from CardCollection.setCards
- Defined in src/models/cardCollection/cardCollection.model.ts:78
Parameters
- cards: ICard[]
Returns this

shuffle

shuffle(): void

Implementation of IHand.shuffle

Inherited from CardCollection.shuffle
- Defined in src/models/cardCollection/cardCollection.model.ts:106
Returns void

sortCards

sortCards(cardRank: IRankSet): this

Implementation of IHand.sortCards
- Defined in src/models/cardCollection/hand.model.ts:33
Order cards in Hand by Rank and Suit

see

Hand.suitOrder

Parameters
- cardRank: IRankSet
Returns this

takeCard

takeCard(): ICard

Implementation of IHand.takeCard

Inherited from CardCollection.takeCard
- Defined in src/models/cardCollection/cardCollection.model.ts:51
Returns ICard

takeCardFromBottom

takeCardFromBottom(): ICard

Implementation of IHand.takeCardFromBottom

Inherited from CardPile.takeCardFromBottom
- Defined in src/models/cardCollection/cardPile.model.ts:21
Returns ICard

takeCards

takeCards(amount: number): ICard[]

Implementation of IHand.takeCards

Inherited from CardCollection.takeCards
- Defined in src/models/cardCollection/cardCollection.model.ts:62
Remove cards from hand.

Parameters
- amount: number
  
  Amount of cards to remove from Hand. If less than 1, all cards are taken.
Returns ICard[]

takeCardsFromBottom

takeCardsFromBottom(amount: number): ICard[]

Implementation of IHand.takeCardsFromBottom

Inherited from CardPile.takeCardsFromBottom
- Defined in src/models/cardCollection/cardPile.model.ts:28
Parameters
- amount: number
Returns ICard[]

Generated using TypeDoc