Class DiceManager<T>

constructor

• new DiceManager<T>(settings: DiceManagerSettings<T>): DiceManager<T>

  Type Parameters

  • T

  Parameters

  • settings: DiceManagerSettings<T>

    a DiceManagerSettings object

  Returns DiceManager<T>

animationManager

addStock

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

  Parameters

  • stock: DiceStock<T>

  Returns void

createDieElement

• createDieElement(die: T): HTMLDivElement

  Parameters

  • die: T

  Returns HTMLDivElement

getBorderRadius

• getBorderRadius(): number

  Returns number

getDieClickEventFilter

• getDieClickEventFilter(): DieClickEventFilter

  Returns DieClickEventFilter

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

getDieElement

• getDieElement(die: T): HTMLElement

  Parameters

  • die: T

    the die informations

  Returns HTMLElement

  the HTML element of an existing die

getDieElementId

• getDieElementId(die: T): string

  Parameters

  • die: T

    the die informations

  Returns string

  the id for a die element

getDieFace

• getDieFace(die: T): number

  Return the die face. Default: the face will be set to die.face.

  Parameters

  • die: T

    the die informations

  Returns number

  the die face

getDieStock

• getDieStock(die: T): DiceStock<T>

  Returns the stock containing the die.

  Parameters

  • die: T

    the die informations

  Returns DiceStock<T>

  the stock containing the die

getFaces

• getFaces(): number

  Returns number

getId

• getId(die: T): string | number

  Parameters

  • die: T

    the die informations

  Returns string | number

  the id for a die

getPerspective

• getPerspective(): number

  Returns number

  the default perspective for all stocks.

getSelectableDieClass

• getSelectableDieClass(): string

  Returns string

  the class to apply to selectable dice. Default 'bga-dice_selectable-die'.

getSelectedDieClass

• getSelectedDieClass(): string

  Returns string

  the class to apply to selected dice. Default 'bga-dice_selected-die'.

getSize

• getSize(): number

  Returns number

getType

• getType(): string

  Returns string

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

getUnselectableDieClass

• getUnselectableDieClass(): string

  Returns string

  the class to apply to selectable dice. Default 'bga-dice_disabled-die'.

placeDice

• placeDice(dice: T[]): Promise<Promise<boolean>[]>

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

  Parameters

  • dice: T[]

  Returns Promise<Promise<boolean>[]>

placeDie

• placeDie(die: T): Promise<boolean>

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

  Parameters

  • die: T

  Returns Promise<boolean>

removeDie

• removeDie(die: T, settings?: RemoveDieSettings): Promise<boolean>

  Remove a die.

  Parameters

  • die: T

    the die to remove
  • Optionalsettings: RemoveDieSettings

    a RemoveDieSettings object

  Returns Promise<boolean>

updateDieInformations

• updateDieInformations(die: T, updateData?: boolean): void

  Update the die informations. Used when a change visible face.

  Parameters

  • die: T

    the die informations
  • OptionalupdateData: boolean

  Returns void