Class CardManager<T>

constructor

• new CardManager<T>(game, settings): CardManager<T>

• Type Parameters

  • T

  Parameters

  • game: Game

    the BGA game class, usually it will be this

  • settings: CardManagerSettings<T>

  Returns CardManager<T>

animationManager

game

addStock

• addStock(stock): void

• Parameters

  • stock: CardStock<T>

  Returns void

animationsActive

• animationsActive(): boolean

• Returns if the animations are active. Animation aren't active when the window is not visible (document.visibilityState === 'hidden'), or game.instantaneousMode is true.

  Returns boolean

  if the animations are active.

createCardElement

• createCardElement(card, visible?): HTMLDivElement

• Parameters

  • card: T

  • visible: boolean = true

  Returns HTMLDivElement

flipCard

• flipCard(card, settings?): void

• Flips the card.

  Parameters

  • card: T

    the card informations

  • Optional settings: FlipCardSettings

    the flip params (to update the card in current stock)

  Returns void

getCardElement

• getCardElement(card): HTMLElement

• Parameters

  • card: T

    the card informations

  Returns HTMLElement

  the HTML element of an existing card

getCardHeight

• getCardHeight(): number

• Returns number

  the card height set in the settings (undefined if unset)

getCardStock

• getCardStock(card): CardStock<T>

• Returns the stock containing the card.

  Parameters

  • card: T

    the card informations

  Returns CardStock<T>

  the stock containing the card

getCardWidth

• getCardWidth(): number

• Returns number

  the card with set in the settings (undefined if unset)

getFakeCardGenerator

• getFakeCardGenerator(): ((deckId) => T)

• Returns ((deckId) => T)

  • • (deckId): T

    • Parameters

      • deckId: string

      Returns T

getId

• getId(card): string

• Parameters

  • card: T

    the card informations

  Returns string

  the id for a card

getSelectableCardClass

• getSelectableCardClass(): string

• Returns string

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

getSelectedCardClass

• getSelectedCardClass(): string

• Returns string

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

getUnselectableCardClass

• getUnselectableCardClass(): string

• Returns string

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

isCardVisible

• isCardVisible(card): boolean

• Return if the card passed as parameter is suppose to be visible or not. Use isCardVisible from settings if set, else will check if card.type is defined

  Parameters

  • card: T

    the card informations

  Returns boolean

  the visiblility of the card (true means front side should be displayed)

removeCard

• removeCard(card, settings?): Promise<boolean>

• Remove a card.

  Parameters

  • card: T

    the card to remove

  • Optional settings: RemoveCardSettings

    a RemoveCardSettings object

  Returns Promise<boolean>

removeStock

• removeStock(stock): void

• Parameters

  • stock: CardStock<T>

  Returns void

setCardVisible

• setCardVisible(card, visible?, settings?): void

• Set the card to its front (visible) or back (not visible) side.

  Parameters

  • card: T

    the card informations

  • Optional visible: boolean

    if the card is set to visible face. If unset, will use isCardVisible(card)

  • Optional settings: FlipCardSettings

    the flip params (to update the card in current stock)

  Returns void

updateCardInformations

• updateCardInformations(card, settings?): void

• Update the card informations. Used when a card with just an id (back shown) should be revealed, with all data needed to populate the front.

  Parameters

  • card: T

    the card informations

  • Optional settings: Omit<FlipCardSettings, "updateData">

  Returns void