Interface CardManagerSettings<T>

interface CardManagerSettings<T> {
    animationManager?: AnimationManager;
    cardHeight?: number;
    cardWidth?: number;
    fakeCardGenerator?: ((deckId) => T);
    getId?: ((card) => string);
    isCardVisible?: ((card) => boolean);
    selectableCardClass?: string;
    selectedCardClass?: string;
    setupBackDiv?: ((card, element) => void);
    setupDiv?: ((card, element) => void);
    setupFrontDiv?: ((card, element) => void);
    unselectableCardClass?: string;
}

Type Parameters

  • T

Properties

animationManager? cardHeight? cardWidth? fakeCardGenerator? getId? isCardVisible? selectableCardClass? selectedCardClass? setupBackDiv? setupDiv? setupFrontDiv? unselectableCardClass?

Properties

Optional animationManager

animationManager?: AnimationManager

The animation manager used in the game. If not provided, a new one will be instanciated for this card manager. Useful if you use AnimationManager outside of card manager, to avoid double instanciation.

Optional cardHeight

cardHeight?: number

Indicate the height of a card (in px). Used for Deck stocks.

Optional cardWidth

cardWidth?: number

Indicate the width of a card (in px). Used for Deck stocks.

Optional fakeCardGenerator

fakeCardGenerator?: ((deckId) => T)

A generator of fake cards, to generate decks top card automatically. Default is generating an empty card, with only id set.

Type declaration

    • (deckId): T

    • A generator of fake cards, to generate decks top card automatically. Default is generating an empty card, with only id set.

      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 getId

getId?: ((card) => string)

Define the id that will be set to each card div. It must generate a unique id for each different card, so it's often linked to card id. If you use different cards types that couldhave the same ids, you must define this method to make it different for each type (for example : getId: (card) => 'other-card-type-' + card.id).

Default: the id will be set to card-${card.id}.

Type declaration

    • (card): string

    • Define the id that will be set to each card div. It must generate a unique id for each different card, so it's often linked to card id. If you use different cards types that couldhave the same ids, you must define this method to make it different for each type (for example : getId: (card) => 'other-card-type-' + card.id).

      Default: the id will be set to card-${card.id}.

      Parameters

      • card: T

        the card informations

      Returns string

      the id for a card

Param: card

the card informations

Returns

the id for a card

Optional isCardVisible

isCardVisible?: ((card) => boolean)

A function to determine if the card should show front side or back side, based on the informations of the card object. If you only manage visible cards, set it to () => true. Default is card.type is truthy.

Type declaration

    • (card): boolean

    • A function to determine if the card should show front side or back side, based on the informations of the card object. If you only manage visible cards, set it to () => true. Default is card.type is truthy.

      Parameters

      • card: T

        the card informations

      Returns boolean

      true if front side should be visible

Param: card

the card informations

Returns

true if front side should be visible

Optional selectableCardClass

selectableCardClass?: string

The class to apply to selectable cards. Default 'bga-cards_selectable-card'.

Optional selectedCardClass

selectedCardClass?: string

The class to apply to selected cards. Default 'bga-cards_selected-card'.

Optional setupBackDiv

setupBackDiv?: ((card, element) => void)

Allow to populate the back div of the card. You can set classes or dataset to show the correct card face. You can also add some translated text on the card at this moment.

Type declaration

    • (card, element): void

    • Allow to populate the back div of the card. You can set classes or dataset to show the correct card face. You can also add some translated text on the card at this moment.

      Parameters

      • card: T

        the card informations

      • element: HTMLDivElement

        the card back Div element. You can add a class, change dataset, set background for the back side

      Returns void

      the id for a card

Param: card

the card informations

Param: element

the card back Div element. You can add a class, change dataset, set background for the back side

Returns

the id for a card

Optional setupDiv

setupDiv?: ((card, element) => void)

Allow to populate the main div of the card. You can set classes or dataset, if it's informations shared by both sides.

Type declaration

    • (card, element): void

    • Allow to populate the main div of the card. You can set classes or dataset, if it's informations shared by both sides.

      Parameters

      • card: T

        the card informations

      • element: HTMLDivElement

        the card main Div element. You can add a class (to set width/height), change dataset, ... based on the card informations. There should be no visual informations on it, as it will be set on front/back Divs.

      Returns void

      the id for a card

Param: card

the card informations

Param: element

the card main Div element. You can add a class (to set width/height), change dataset, ... based on the card informations. There should be no visual informations on it, as it will be set on front/back Divs.

Returns

the id for a card

Optional setupFrontDiv

setupFrontDiv?: ((card, element) => void)

Allow to populate the front div of the card. You can set classes or dataset to show the correct card face. You can also add some translated text on the card at this moment.

Type declaration

    • (card, element): void

    • Allow to populate the front div of the card. You can set classes or dataset to show the correct card face. You can also add some translated text on the card at this moment.

      Parameters

      • card: T

        the card informations

      • element: HTMLDivElement

        the card front Div element. You can add a class, change dataset, set background for the back side

      Returns void

      the id for a card

Param: card

the card informations

Param: element

the card front Div element. You can add a class, change dataset, set background for the back side

Returns

the id for a card

Optional unselectableCardClass

unselectableCardClass?: string

The class to apply to selectable cards. Default 'bga-cards_disabled-card'.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc