Interface DeckSettings<T>

interface DeckSettings<T> {
    autoRemovePreviousCards?: boolean;
    autoUpdateCardNumber?: boolean;
    cardNumber?: number;
    counter?: DeckCounter;
    fakeCardGenerator?: ((deckId) => T);
    shadowDirection?: SideOrAngle;
    thicknesses?: number[];
    topCard?: T;
}

Type Parameters

  • T

Properties

autoRemovePreviousCards? autoUpdateCardNumber? cardNumber? counter? fakeCardGenerator? shadowDirection? thicknesses? topCard?

Properties

Optional autoRemovePreviousCards

autoRemovePreviousCards?: boolean

Indicate if the cards under the new top card must be removed (to forbid players to check the content of the deck with Inspect). Default true.

Optional autoUpdateCardNumber

autoUpdateCardNumber?: boolean

Indicate if the card count is automatically updated when a card is added or removed.

Optional cardNumber

cardNumber?: number

Indicate the current number of cards in the deck (default 0).

Optional counter

counter?: DeckCounter

Show a card counter on the deck. Not visible if unset.

Optional fakeCardGenerator

fakeCardGenerator?: ((deckId) => T)

A generator of fake cards, to generate decks top card automatically. Default is manager fakeCardGenerator method.

Type declaration

    • (deckId): T

    • A generator of fake cards, to generate decks top card automatically. Default is manager fakeCardGenerator method.

      Parameters

      • deckId: string

        the deck id

      Returns T

      the fake card to be generated (usually, only informations to show back side)

Param: deckId

the deck id

Returns

the fake card to be generated (usually, only informations to show back side)

Optional shadowDirection

shadowDirection?: SideOrAngle

Shadow direction. Default 'bottom-right'.

Optional thicknesses

thicknesses?: number[]

Indicate the thresholds to add 1px to the thickness of the pile. Default [0, 2, 5, 10, 20, 30].

Optional topCard

topCard?: T

Indicate the current top card.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc