Class CardContainer<TCard>`Abstract`

Base class for general card containers, like decks and hands. We don't assume anything about how cards are stored.

Type Parameters

TCard extends Card

Hierarchy

GameObject
- CardContainer
  - LinearCardContainer

Implements

ICardReceiver<TCard>

Index

Constructors

Properties

_lastActionIndex hiddenName? name?

Accessors

cardDimensions count isEmpty localBounds

Methods

add addRange has onAdd onRemove onRemoveAll remove removeAll render

Constructors

constructor

new CardContainer<TCard>(CardType): CardContainer<TCard>
Base class for general card containers, like decks and hands.
Type Parameters
- TCard extends Card
Parameters
- CardType: CardType<TCard>
  
  Constructor for the type of card stored in this container. Used to find the card dimensions.
Returns CardContainer<TCard>

Overrides GameObject.constructor

Properties

_lastActionIndex

_lastActionIndex: number

`Optional` hiddenName

hiddenName?: string

Optional display name for this object when hidden.

`Optional` name

name?: string

Optional display name for this object.

Accessors

cardDimensions

get cardDimensions(): ICardDimensions
Gets the dimensions of the card type stored in this container.

Returns ICardDimensions

`Abstract` count

get count(): number
Gets the number of cards in this container.

Returns number

Implementation of ICardReceiver.count

isEmpty

get isEmpty(): boolean
If true, this container has no cards.

Returns boolean

localBounds

get localBounds(): Bounds
How much space does this object take up.

Returns Bounds

Inherited from GameObject.localBounds

Methods

add

add(card): void
Add a single card to the default place in this container.
Parameters
- card: TCard
  
  Card to add.
Returns void

Implementation of ICardReceiver.add

addRange

addRange(cards): void
Add a whole wad of cards to the default place in this container.
Parameters
- cards: Iterable<TCard> | TCard[]
  
  Cards to add.
Returns void

`Abstract` has

has(card): boolean
Parameters
- card: TCard
Returns boolean

`Protected` `Abstract` onAdd

onAdd(card): void
Called when a card is to be added to this container.
Parameters
- card: TCard
  
  Card to add.
Returns void

`Protected` `Abstract` onRemove

onRemove(card): void
Called when a card is to be removed from this container.
Parameters
- card: TCard
  
  Card to remove.
Returns void

`Protected` `Abstract` onRemoveAll

onRemoveAll(predicate?): TCard[]
Called when cards matching a predicate are to be removed.
Parameters
- Optional predicate: ((card) => boolean)
  
  Function that returns true for cards that should be removed.
  - - (card): boolean
    - Parameters
      
      card: TCard
      
      Returns boolean
Returns TCard[]

remove

remove(card): TCard
Remove a specific card from this container. The given card must actually be inside this container.
Parameters
- card: TCard
  
  Card to remove.
Returns TCard
The removed card.

removeAll

removeAll(): TCard[]
Remove all cards from this container.

Returns TCard[]
The removed cards.
removeAll(cards): TCard[]
Remove the given cards from this container.
Parameters
- cards: Iterable<TCard>
Returns TCard[]
The removed cards.
removeAll(predicate): TCard[]
Remove all cards matching a predicate from this container.
Parameters
- predicate: ((card) => boolean)
  
  Predicate to match for each card.
  - - (card): boolean
    - Parameters
      
      card: TCard
      
      Returns boolean
Returns TCard[]
The removed cards.

`Abstract` render

render(ctx): IView
Builds a view of this object from the perspective of a player.
Parameters
- ctx: RenderContext
  
  Information about where the object is in the scene, and who's viewing it.
Returns IView

Inherited from GameObject.render

Generated using TypeDoc