Class DiceManager

constructor

• new DiceManager(game, settings): DiceManager

• Parameters

  • game: Game

    the BGA game class, usually it will be this

  • settings: DiceManagerSettings

  Returns DiceManager

animationManager

game

addStock

• addStock(stock): void

• Parameters

  • stock: DiceStock

  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.

createDieElement

• createDieElement(die): HTMLDivElement

• Parameters

  • die: BgaDie

  Returns HTMLDivElement

getDieElement

• getDieElement(die): HTMLElement
• Parameters

  • die: BgaDie

    the die informations

  Returns HTMLElement

  the HTML element of an existing die

getDieStock

• getDieStock(die): DiceStock

• Returns the stock containing the die.

  Parameters

  • die: BgaDie

    the die informations

  Returns DiceStock

  the stock containing the die

getDieType

• getDieType(die): BgaDieType

• Parameters

  • die: BgaDie

  Returns BgaDieType

getId

• getId(die): string

• Parameters

  • die: BgaDie

  Returns string

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'.

getUnselectableDieClass

• getUnselectableDieClass(): string
• Returns string

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

removeDie

• removeDie(die): boolean

• Remove a die.

  Parameters

  • die: BgaDie

    the die to remove

  Returns boolean

setDieType

• setDieType(type, dieType): void

• Parameters

  • type: string | number

  • dieType: BgaDieType

  Returns void

updateDieInformations

• updateDieInformations(die, updateData?): void

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

  Parameters

  • die: BgaDie

    the die informations

  • Optional updateData: boolean

  Returns void