Class ScoreSheet

Create a Score Sheet on an empty element. The Score sheet will not be visible by default, except if there are scores given in the settings.

Index

Constructors

Properties

animationDuration element settings

Methods

animationsActive buildTable createCornerCell createLabelCell createPlayerCell createScoreCell setScore setScores setVisible skipAnimations wait

Constructors

constructor

new ScoreSheet(element: HTMLElement, settings: ScoreSheetSettings): ScoreSheet
Creates the score sheet.
Parameters
- element: HTMLElement
  the element to place the sheet on
- settings: ScoreSheetSettings
  the score sheet settings
Returns ScoreSheet
- Defined in bga-score-sheet.ts:196

Properties

`Protected`animationDuration

animationDuration: number

The current animation duration.

`Protected`element

element: HTMLElement

the element to place the sheet on

`Protected`settings

settings: ScoreSheetSettings

the score sheet settings

Methods

animationsActive

animationsActive(): boolean
Returns boolean
- Defined in bga-score-sheet.ts:223

`Protected`buildTable

buildTable(): void
Returns void
- Defined in bga-score-sheet.ts:282

`Protected`createCornerCell

createCornerCell(): HTMLTableCellElement
Returns HTMLTableCellElement
- Defined in bga-score-sheet.ts:231

`Protected`createLabelCell

createLabelCell(entry: Entry): HTMLTableCellElement
Parameters
- entry: Entry
Returns HTMLTableCellElement
- Defined in bga-score-sheet.ts:258

`Protected`createPlayerCell

createPlayerCell(player: Player): HTMLTableCellElement
Parameters
- player: Player
Returns HTMLTableCellElement
- Defined in bga-score-sheet.ts:246

`Protected`createScoreCell

createScoreCell(entry: Entry, playerId: string | number): HTMLTableCellElement
Parameters
- entry: Entry
- playerId: string | number
Returns HTMLTableCellElement
- Defined in bga-score-sheet.ts:267

setScore

setScore(playerId: number, property: string, score: string | number): void
Sets the score on a cell, and trigger the callback if needed.
Parameters
- playerId: number
- property: string
- score: string | number
Returns void
- Defined in bga-score-sheet.ts:367

setScores

setScores(
playerScores: PlayerScores,
animationSettings?: AnimationSettings,
): Promise<void>
Triggers the animation of the scores. Makes the score sheet visible.
Parameters
- playerScores: PlayerScores
  the scores to display, with an entry for each player. The player entry is an associative array (entry property => score for this entry & this player).
- animationSettings: AnimationSettings = undefined
  the animation settings, or null if you don't want any animation.
Returns Promise<void>
- Defined in bga-score-sheet.ts:321

setVisible

setVisible(visible?: boolean): void
Define the visibility of the score sheet.
Parameters
- visible: boolean = true
Returns void
- Defined in bga-score-sheet.ts:399

skipAnimations

skipAnimations(): void
Skip the running animations. Can be triggered by a click on the Skip button, or programmatically.

Returns void
- Defined in bga-score-sheet.ts:391

wait

wait(delay: number): Promise<void>
Return a Promise that resolves at the end of a given number of ms.
Parameters
- delay: number
  the time to wait, in milliseconds
Returns Promise<void>
a promise when the timer ends
- Defined in bga-score-sheet.ts:380