Class Hand<TCard>

Holds a wad of cards, where each card is displayed separately.

Type Parameters

Hierarchy

Constructors

constructor

Properties

_lastActionIndex alignment autoSort? defaultOrientation emptyOutlineStyle height hiddenName? name? outlineStyle promptOutlineStyle width

Accessors

cardDimensions count first isEmpty last localBounds selected unselected

Methods

[iterator] add addRange deal dealTotal draw drawRange getCard getOrientation getProperties getSelected has insert insertRange onAdd onRemove onRemoveAll remove removeAll render setCount setOrientation setSelected shuffle toggleSelected tryDeal

Constructors

constructor

  • Holds a wad of cards, where each card is displayed separately.

    Type Parameters

    Parameters

    • CardType: CardType<TCard>

      Constructor for the type of card stored in this container. Used to find the card dimensions.

    • width: number

      Maximum width of the area that hand cards are displayed in, in centimeters.

    • Optional options: IHandOptions<TCard>

      Optional configuration options.

    Returns Hand<TCard>

Properties

_lastActionIndex

_lastActionIndex: number

Readonly alignment

alignment: Alignment

How cards in a hand are positioned when there is free space.

Optional Readonly autoSort

autoSort?: CardComparer<TCard>

Comparison function to use to automatically sort added cards.

defaultOrientation

defaultOrientation: CardOrientation

Default orientation of cards added to this container.

emptyOutlineStyle

emptyOutlineStyle: OutlineStyle = OutlineStyle.DASHED

Readonly height

height: number

Height of the area that hand cards are displayed in, in centimeters. Matches the card height.

Optional hiddenName

hiddenName?: string

Optional display name for this object when hidden.

Optional name

name?: string

Optional display name for this object.

outlineStyle

outlineStyle: OutlineStyle = OutlineStyle.NONE

promptOutlineStyle

promptOutlineStyle: OutlineStyle = OutlineStyle.SOLID_FILLED

Readonly width

width: number

Maximum width of the area that hand cards are displayed in, in centimeters.

Accessors

cardDimensions

  • get cardDimensions(): ICardDimensions

  • Gets the dimensions of the card type stored in this container.

    Returns ICardDimensions

count

  • get count(): number

  • Gets the number of cards in this container.

    Returns number

first

  • get first(): TCard

  • Left-most card in the hand. The oldest added, and next to be drawn.

    Returns TCard

isEmpty

  • get isEmpty(): boolean

  • If true, this container has no cards.

    Returns boolean

last

  • get last(): TCard

  • Right-most card in the hand. The most recently added, and last to be drawn.

    Returns TCard

localBounds

  • get localBounds(): Bounds

  • How much space does this object take up.

    Returns Bounds

selected

  • get selected(): readonly TCard[]

  • Gets all cards in this container that are marked as selected.

    Returns readonly TCard[]

unselected

  • get unselected(): readonly TCard[]

  • Gets all cards in this container that aren't marked as selected.

    Returns readonly TCard[]

Methods

[iterator]

add

  • Add a single card to the default place in this container.

    Parameters

    • card: TCard

      Card to add.

    Returns void

addRange

  • Add a whole wad of cards to the default place in this container.

    Parameters

    • cards: TCard[] | Iterable<TCard>

      Cards to add.

    Returns void

deal

  • Deal up to the given number of cards to each target.

    Parameters

    • targets: ICardReceiver<TCard>[] | TCard[][]

      Recipients of the deal.

    • count: number = 1

      Maximum number of cards to deal to each recipient.

    • firstTargetIndex: number = 0

      Index of the first recipient in targets.

    Returns void

dealTotal

  • Deals up to the given total number of cards, divided between the given targets.

    Parameters

    • targets: ICardReceiver<TCard>[] | TCard[][]

      Recipients of the deal.

    • totalCount: number

      Maximum number of cards to deal in total.

    • Optional handLimit: number
    • firstTargetIndex: number = 0

      Index of the first recipient in targets.

    Returns void

draw

  • Take a single card from this container. The index of the card depends on the container type.

    Returns TCard

    Drawn card.

drawRange

  • Take a number of cards from this container. The index and order of the cards depend on the container type.

    Parameters

    • count: number

      Number of cards to draw.

    Returns TCard[]

    Drawn cards.

getCard

  • Gets a card by index.

    Parameters

    • index: number

      Index of the card to get, starting at 0 and strictly less than count.

    Returns TCard

    Retrieved card.

getOrientation

Protected getProperties

getSelected

  • Gets whether the given card is marked as selected.

    Parameters

    • index: number

      Index of the card to get.

    Returns boolean

    Selection state of the given card.

  • Gets whether the given card is marked as selected.

    Parameters

    • card: TCard

      Card to get.

    Returns boolean

    Selection state of the given card.

has

insert

  • Add a single card to the given place in this container.

    Parameters

    • index: number

      Where to insert the card, starting at 0.

    • card: TCard

      Card to add.

    Returns void

insertRange

  • Add a wad of cards to the given place in this container.

    Parameters

    • index: number

      Where to insert the cards, starting at 0.

    • cards: TCard[] | Iterable<TCard>

      Cards to add.

    Returns void

Protected onAdd

  • Called when a card is to be added to this container.

    Parameters

    • card: TCard

      Card to add.

    Returns void

Protected onRemove

  • Called when a card is to be removed from this container.

    Parameters

    • card: TCard

      Card to remove.

    Returns void

Protected onRemoveAll

  • 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 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

  • Remove all cards from this container.

    Returns TCard[]

    The removed cards.

  • Remove the given cards from this container.

    Parameters

    • cards: Iterable<TCard>

    Returns TCard[]

    The removed cards.

  • 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.

render

setCount

  • Adds or removes cards from this container until there are exactly the given number. Uses the given factory function to create new cards.

    Parameters

    • count: number

      Desired number of cards in this container.

    • factory: (() => TCard)

      Function to create new cards if we need them.

        • (): TCard

        • Returns TCard

    Returns void

setOrientation

  • Set all cards to the given orientation.

    Parameters

    Returns void

  • Sets whether the given card is face up or down.

    Parameters

    • index: number

      Index of the card to set.

    • orientation: CardOrientation

      Orientation to set the card to.

    Returns void

  • Sets whether the given card is face up or down.

    Parameters

    • card: TCard

      Card to set.

    • orientation: CardOrientation

      Orientation to set the card to.

    Returns void

setSelected

  • Set all cards to be either selected or deselected.

    Parameters

    • selected: boolean

      Selection state to set all cards to.

    Returns void

  • Sets whether the given card is marked as selected.

    Parameters

    • index: number

      Index of the card to set.

    • selected: boolean

      Selection state to set the card to.

    Returns void

  • Sets whether the given card is marked as selected.

    Parameters

    • card: TCard

      Card to set.

    • selected: boolean

      Selection state to set the card to.

    Returns void

shuffle

  • Shuffle all cards in this container.

    Returns void

  • Shuffle a range of cards in this container.

    Parameters

    • from: number

      Start of the range to shuffle, from 0.

    • to: number

      Exclusive end of the range to shuffle.

    Returns void

toggleSelected

  • Toggles the selection state of the given card.

    Parameters

    • index: number

      Index of the card to toggle.

    Returns boolean

  • Toggles the selection state of the given card.

    Parameters

    • card: TCard

    Returns boolean

tryDeal

  • If this container holds enough cards, deals the given number to each target and returns true. Otherwise nothing is dealt and returns false.

    Parameters

    • targets: ICardReceiver<TCard>[]

      Recipients of the deal.

    • count: number = 1

      Exact number of cards to deal to each recipient, if possible.

    Returns boolean

    True if the given number of cards were dealt, otherwise false.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc