Class CardManager<T>

constructor

• new CardManager<T>(settings: CardManagerSettings<T>): CardManager<T>

  Type Parameters

  • T

  Parameters

  • settings: CardManagerSettings<T>

    a CardManagerSettings object

  Returns CardManager<T>

animationManager

addStock

• addStock(stock: CardStock<T>): void

  Parameters

  • stock: CardStock<T>

  Returns void

createCardElement

• createCardElement(
      card: T,
      initialSide?: "auto" | "front" | "back",
  ): HTMLDivElement

  Parameters

  • card: T
  • initialSide: "auto" | "front" | "back" = 'auto'

  Returns HTMLDivElement

flipCard

• flipCard(card: T, settings?: FlipCardSettings): void

  Flips the card.

  Parameters

  • card: T

    the card informations
  • Optionalsettings: FlipCardSettings

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

  Returns void

getCardBorderRadius

• getCardBorderRadius(): string

  Returns string

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

getCardClickEventFilter

• getCardClickEventFilter(): CardClickEventFilter

  Returns CardClickEventFilter

  the filtering to apply on card click events. Default 'selectable'.

getCardElement

• getCardElement(card: T): HTMLElement

  Parameters

  • card: T

    the card informations

  Returns HTMLElement

  the HTML element of an existing card

getCardElementId

• getCardElementId(card: T): string

  Parameters

  • card: T

    the card informations

  Returns string

  the id for a card element

getCardHeight

• getCardHeight(): number

  Returns number

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

getCardRotation

• getCardRotation(card: T): number

  Return the card rotation. Use getCardRotation from settings if set, else will return 0

  Parameters

  • card: T

    the card informations

  Returns number

  the card rotation

getCardSideElements

• getCardSideElements(card: T): HTMLElement[]

  Parameters

  • card: T

    the card informations

  Returns HTMLElement[]

  the HTML element of the faces of the card

getCardSideElementsFromCardElement

• getCardSideElementsFromCardElement(element: HTMLElement): HTMLElement[]

  Parameters

  • element: HTMLElement

    the HTML element of the card

  Returns HTMLElement[]

  the HTML element of the faces of the card

getCardStock

• getCardStock(card: T): 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: string) => T

  Returns (deckId: string) => T

getId

• getId(card: T): string | number

  Parameters

  • card: T

    the card informations

  Returns string | number

  the id for a card

getLastPlayedCardStyle

• getLastPlayedCardStyle(): SelectionStyle

  Returns SelectionStyle

  the style to apply to the last played card. Default to class 'bga-cards_last-played-card'.

getSelectableCardStyle

• getSelectableCardStyle(): SelectionStyle

  Returns SelectionStyle

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

getSelectableSlotStyle

• getSelectableSlotStyle(): SelectionStyle

  Returns SelectionStyle

  the style to apply to selectable slots. Default to class 'bga-cards_selectable-slot'.

getSelectedCardStyle

• getSelectedCardStyle(): SelectionStyle

  Returns SelectionStyle

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

getSelectedSlotStyle

• getSelectedSlotStyle(): SelectionStyle

  Returns SelectionStyle

  the style to apply to selected slots. Default to class 'bga-cards_selected-slot'.

getType

• getType(): string

  Returns string

  the type of the cards, either set in the settings or by using a default one if there is only 1 type.

getUnselectableCardStyle

• getUnselectableCardStyle(): SelectionStyle

  Returns SelectionStyle

  the style to apply to unselectable cards. Default to class 'bga-cards_unselectable-card'.

getUnselectableSlotStyle

• getUnselectableSlotStyle(): SelectionStyle

  Returns SelectionStyle

  the style to apply to unselectable slots. Default to class 'bga-cards_unselectable-slot'.

isCardVisible

• isCardVisible(card: T): 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)

placeCard

• placeCard(card: T): Promise<boolean>

  Place a card based on the autoPlace settings of each stock.

  Parameters

  • card: T

  Returns Promise<boolean>

placeCards

• placeCards(cards: T[]): Promise<Promise<boolean>[]>

  Place some cards based on the autoPlace settings of each stock.

  Parameters

  • cards: T[]

  Returns Promise<Promise<boolean>[]>

removeCard

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

  Remove a card.

  Parameters

  • card: T

    the card to remove
  • Optionalsettings: RemoveCardSettings

    a RemoveCardSettings object

  Returns Promise<boolean>

removeStock

• removeStock(stock: CardStock<T>): void

  Parameters

  • stock: CardStock<T>

  Returns void

setCardVisible

• setCardVisible(card: T, visible?: boolean, settings?: FlipCardSettings): void

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

  Parameters

  • card: T

    the card informations
  • Optionalvisible: boolean

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

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

  Returns void

setLastPlayedCard

• setLastPlayedCard(card: T, color?: string, cardClass?: string): void

  Mark the last play card. Remove the other last play card classes.

  Parameters

  • card: T

    the card to mark as last played
  • Optionalcolor: string

    the color to use to mark the last played card, usually the player color
  • OptionalcardClass: string

    a class applied on this type of cards, to limit removal to these type of cards.

  Returns void

setLastPlayedCards

• setLastPlayedCards(cards: T[], color?: string, cardClass?: string): void

  Mark the last play cards. Remove the other last play card classes.

  Parameters

  • cards: T[]

    the cards to mark as last played
  • Optionalcolor: string

    the color to use to mark the last played card, usually the player color
  • OptionalcardClass: string

    a class applied on this type of cards, to limit removal to these type of cards.

  Returns void

updateCardInformations

• updateCardInformations(
      card: T,
      settings?: Omit<FlipCardSettings, "updateData">,
  ): 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
  • Optionalsettings: Omit<FlipCardSettings, "updateData">

  Returns void