BgaScoreSheet - Revision history

Nalka: Fix typo in playerPanel score update snippet

2026-08-29T13:35:39Z

Fix typo in playerPanel score update snippet

← Older revision		Revision as of 15:35, 29 August 2026
Line 68:		Line 68:
	onScoreDisplayed: (property, playerId, score) => { // if you want to do something when a score is revealed		onScoreDisplayed: (property, playerId, score) => { // if you want to do something when a score is revealed
	if (property === 'total') {		if (property === 'total') {
	this.bga.playerPanels.getScoreCounter[playerId].setValue(score);		this.bga.playerPanels.getScoreCounter(playerId).setValue(Number(score));
	}		}
	},		},

2026-06-23T09:01:10Z

← Older revision		Revision as of 11:01, 23 June 2026
Line 15:		Line 15:
	const BgaScoreSheet = await importEsmLib('bga-score-sheet', '1.x');		const BgaScoreSheet = await importEsmLib('bga-score-sheet', '1.x');
	</pre>		</pre>
			This line should be placed on top of the JS file, before any class declaration.

	Legacy way:		Legacy way:

2026-02-13T10:26:24Z

← Older revision		Revision as of 12:26, 13 February 2026
Line 107:		Line 107:
	// on your end score state		// on your end score state
	function stEndScore(): void {		function stEndScore(): void {
	$this->notify->all('endScores', '', [ 'endScores' => $this->getEndScores() ]);		$this->bga->notify->all('endScores', '', [ 'endScores' => $this->getEndScores() ]);
	}		}

2026-02-11T11:03:44Z

Usage: this.bga.playerPanels.getScoreCounter

← Older revision		Revision as of 13:03, 11 February 2026
Line 67:		Line 67:
	onScoreDisplayed: (property, playerId, score) => { // if you want to do something when a score is revealed		onScoreDisplayed: (property, playerId, score) => { // if you want to do something when a score is revealed
	if (property === 'total') {		if (property === 'total') {
	this.bga.~~gameui~~.~~scoreCtrl~~[playerId].setValue(score);		this.bga.playerPanels.getScoreCounter[playerId].setValue(score);
	}		}
	},		},

2025-12-25T02:43:25Z

Usage

2025-12-25T02:40:11Z

Usage

← Older revision		Revision as of 04:40, 25 December 2025
Line 79:		Line 79:
	// setting scores will make the score sheet visible if it isn't already		// setting scores will make the score sheet visible if it isn't already
	await this.scoreSheet.setScores(args.endScores, {		await this.scoreSheet.setScores(args.endScores, {
	startBy: this.~~getPlayerId~~()		startBy: this.bga.players.getCurrentPlayerId()
	});		});
	}		}

2025-12-24T16:10:35Z

Usage

← Older revision		Revision as of 18:10, 24 December 2025
Line 64:		Line 64:
	},		},
	],		],
	scores: gamedatas.~~scores~~, // to defined if the game state is 99, else null, so the score displays directly on reload when the game is ended. If unset, the score sheet will be hidden by default.		scores: gamedatas.endScores, // to defined if the game state is 99, else null, so the score displays directly on reload when the game is ended. If unset, the score sheet will be hidden by default.
	onScoreDisplayed: (property, playerId, score) => { // if you want to do something when a score is revealed		onScoreDisplayed: (property, playerId, score) => { // if you want to do something when a score is revealed
	if (property === 'total') {		if (property === 'total') {

2025-12-21T15:39:01Z

← Older revision		Revision as of 17:39, 21 December 2025
Line 1:		Line 1:
	{{Studio_Framework_Navigation}}		{{Studio_Framework_Navigation}}

	~~'''<big>[https://x.boardgamearena.net/data/game-libs/bga-score-sheet/1.x/demo/index.html Demo] [https://x.boardgamearena.net/data/game-libs/bga-score-sheet/1.x/docs/index.html Doc]</big>'''~~

	== Overview ==		== Overview ==
	'''bga-score-sheet''' is a javascript component to help you display an animated score sheet at the end of the game.		'''bga-score-sheet''' is a javascript component to help you display an animated score sheet at the end of the game.

			To see how its work and access examples of source code (via browser dev tools) see
			'''[https://x.boardgamearena.net/data/game-libs/bga-score-sheet/1.x/demo/index.html Demo]'''

			For comprehensive API docs see
			'''[https://x.boardgamearena.net/data/game-libs/bga-score-sheet/1.x/docs/index.html Doc]'''

	== Usage ==		== Usage ==

2025-12-19T14:17:19Z

← Older revision		Revision as of 16:17, 19 December 2025
Line 28:		Line 28:
	document.getElementById(`my-score-sheet`), // an empty div on your template to place the score sheet on		document.getElementById(`my-score-sheet`), // an empty div on your template to place the score sheet on
	{		{
	animationsActive: () => this.gameui.bgaAnimationsActive(), // so the animation doesn't trigger on replay fast mode		animationsActive: () => this.bga.gameui.bgaAnimationsActive(), // so the animation doesn't trigger on replay fast mode
	playerNameWidth: 80,		playerNameWidth: 80,
	playerNameHeight: 30,		playerNameHeight: 30,
Line 63:		Line 63:
	onScoreDisplayed: (property, playerId, score) => { // if you want to do something when a score is revealed		onScoreDisplayed: (property, playerId, score) => { // if you want to do something when a score is revealed
	if (property === 'total') {		if (property === 'total') {
	this.gameui.scoreCtrl[playerId].setValue(score);		this.bga.gameui.scoreCtrl[playerId].setValue(score);
	}		}
	},		},

2025-12-16T10:05:00Z

← Older revision		Revision as of 12:05, 16 December 2025
Line 8:		Line 8:
	== Usage ==		== Usage ==
	Load the lib:		Load the lib:
			<pre>
			const BgaScoreSheet = await importEsmLib('bga-score-sheet', '1.x');
			</pre>

			Legacy way:
	<pre>		<pre>
	define([		define([
Line 23:		Line 28:
	document.getElementById(`my-score-sheet`), // an empty div on your template to place the score sheet on		document.getElementById(`my-score-sheet`), // an empty div on your template to place the score sheet on
	{		{
	animationsActive: () => ~~game~~.bgaAnimationsActive(), // so the animation doesn't trigger on replay fast mode		animationsActive: () => this.gameui.bgaAnimationsActive(), // so the animation doesn't trigger on replay fast mode
	playerNameWidth: 80,		playerNameWidth: 80,
	playerNameHeight: 30,		playerNameHeight: 30,
Line 58:		Line 63:
	onScoreDisplayed: (property, playerId, score) => { // if you want to do something when a score is revealed		onScoreDisplayed: (property, playerId, score) => { // if you want to do something when a score is revealed
	if (property === 'total') {		if (property === 'total') {
	this.scoreCtrl[playerId].setValue(score);		this.gameui.scoreCtrl[playerId].setValue(score);
	}		}
	},		},