PlayerCounter and TableCounter - Revision history

Thoun: /* Overview */

2026-06-11T14:45:44Z

Overview

← Older revision		Revision as of 14:45, 11 June 2026
Line 13:		Line 13:
	Note that by default, they have a min to 0 and no max, but you can change that in the create function.		Note that by default, they have a min to 0 and no max, but you can change that in the create function.

	Two PlayerCounter are available by default on the games, playerScore and playerScoreAux. As their name suggests, they will update the player_score and player_score_aux for you (and the score counter on the player panels, front-side), so you never need to update manually the scores on the DB. They don't have a min, and default is 0, so if you need to set a different initial value, call <code>$this->playerScore->setAll(2)</code>.		Two PlayerCounter are available by default on the games, playerScore and playerScoreAux. As their name suggests, they will update the player_score and player_score_aux for you (and the score counter on the player panels, front-side), so you never need to update manually the scores on the DB. They don't have a min, and default is 0, so if you need to set a different initial value, call <code>$this->playerScore->setAll(2)</code>. By default, they use player id and are not strict.

	'''$this->counterFactory->createPlayerCounter(string $name, ?int $min = 0, ?int $max = null, CounterVisibility $visibility = CounterVisibility::VISIBLE): PlayerCounter'''		'''$this->counterFactory->createPlayerCounter(string $name, ?int $min = 0, ?int $max = null, CounterVisibility $visibility = CounterVisibility::VISIBLE, bool $useNo = false, ?bool $strict = null): PlayerCounter'''

	'''$this->counterFactory->createTableCounter(string $name, ?int $min = 0, ?int $max = null): TableCounter'''		'''$this->counterFactory->createTableCounter(string $name, ?int $min = 0, ?int $max = null): TableCounter'''
Line 23:		Line 23:
	* self: only the current player can see the value of their counter, bot not the others (that will display '-')		* self: only the current player can see the value of their counter, bot not the others (that will display '-')
	* private: nobody can see the counter values (that will display '-')		* private: nobody can see the counter values (that will display '-')

			useNo means everytime you use the counter, you will pass player no instead of player id.

			strict means an exception is triggered if you send an id or a no that doesn't exist at the table.

	== PlayerCounter ==		== PlayerCounter ==

Thoun: /* PlayerCounter */

2026-06-11T14:42:23Z

PlayerCounter

← Older revision		Revision as of 14:42, 11 June 2026
Line 25:		Line 25:

	== PlayerCounter ==		== PlayerCounter ==
	;initDb(array $~~playerIds~~, int $initialValue = 0)		;initDb(array $playerIdsOrNos, int $initialValue = 0)
	:Creates database table if needed (bga_player_counters). Must be called from <code>setupNewGame</code> (or if adding to older games in <code>upgradeTableDb</code>).		:Creates database table if needed (bga_player_counters). Must be called from <code>setupNewGame</code> (or if adding to older games in <code>upgradeTableDb</code>).
	:Parameters:		:Parameters:
	:* <code>array $~~playerIds~~</code> the player ids having the counter (usually, <code>array_keys($players)</code>, but you might want to add 0 for an automata)		:* <code>array $playerIdsOrNos</code> the player ids (or player no) having the counter (usually, <code>array_keys($players)</code>, but you might want to add 0 for an automata)
	:* <code>int $initialValue</code> initial value, if different than 0		:* <code>int $initialValue</code> initial value, if different than 0

	;get(int $~~playerId~~)<nowiki>:</nowiki> int		;get(int $playerIdOrNo)<nowiki>:</nowiki> int
	:Returns the current value of the counter for a player.		:Returns the current value of the counter for a player.
	:Parameters:		:Parameters:
	:* <code>int $~~playerId~~</code> the player id		:* <code>int $playerIdOrNo</code> the player id (or no if useNo: true)
	:Throws:		:Throws:
	:* <code>UnknownPlayerException</code> if $playerId is not in the player ids initialized by <code>initDb</code>		:* <code>UnknownPlayerException</code> if $playerId is not in the player ids initialized by <code>initDb</code>

	;set(int $~~playerId~~, int $value, ?\Bga\GameFramework\NotificationMessage $message)<nowiki>:</nowiki> int		;set(int $playerIdOrNo, int $value, ?\Bga\GameFramework\NotificationMessage $message)<nowiki>:</nowiki> int
	:Set the value of the counter, and send a notif (of type <code>setPlayerCounter)</code> to update the value on the front side. Returns the new value.		:Set the value of the counter, and send a notif (of type <code>setPlayerCounter)</code> to update the value on the front side. Returns the new value.
	:Parameters:		:Parameters:
	:* <code>int $~~playerId~~</code> the player id		:* <code>int $playerIdOrNo</code> the player id (or no if useNo: true)
	:* <code>int $value</code> the new value		:* <code>int $value</code> the new value
	:* <code>?\Bga\GameFramework\NotificationMessage $message</code> the next notif to send to the front. Empty for no log, null for no notif at all (the front will not be updated).		:* <code>?\Bga\GameFramework\NotificationMessage $message</code> the next notif to send to the front. Empty for no log, null for no notif at all (the front will not be updated).
Line 48:		Line 48:
	:* <code>UnknownPlayerException</code> if $playerId is not in the player ids initialized by initDb		:* <code>UnknownPlayerException</code> if $playerId is not in the player ids initialized by initDb

	;inc(int $~~playerId~~, int $inc, ?\Bga\GameFramework\NotificationMessage $message)<nowiki>:</nowiki> int		;inc(int $playerIdOrNo, int $inc, ?\Bga\GameFramework\NotificationMessage $message)<nowiki>:</nowiki> int
	:Increment the value of the counter, and send a notif (of type <code>setPlayerCounter)</code>to update the value on the front side. Returns the new value. Note: if the inc is 0, no notif will be sent.		:Increment the value of the counter, and send a notif (of type <code>setPlayerCounter)</code>to update the value on the front side. Returns the new value. Note: if the inc is 0, no notif will be sent.
	:Parameters:		:Parameters:
	:* <code>int $~~playerId~~</code> the player id		:* <code>int $playerIdOrNo</code> the player id (or no if useNo: true)
	:* <code>int $inc</code> the value to add to the current value		:* <code>int $inc</code> the value to add to the current value
	:* <code>?\Bga\GameFramework\NotificationMessage $message</code> the next notif to send to the front. Empty for no log, null for no notif at all (the front will not be updated).		:* <code>?\Bga\GameFramework\NotificationMessage $message</code> the next notif to send to the front. Empty for no log, null for no notif at all (the front will not be updated).
Line 65:		Line 65:

	;getAll()<nowiki>:</nowiki> array		;getAll()<nowiki>:</nowiki> array
	:Return the values for each player, as an associative array $playerId => $value.		:Return the values for each player, as an associative array ($playerId or $playerNo) => $value.

	;setAll(int $value, ?\Bga\GameFramework\NotificationMessage $message)<nowiki>:</nowiki> int		;setAll(int $value, ?\Bga\GameFramework\NotificationMessage $message)<nowiki>:</nowiki> int
Line 93:		Line 93:
	;isSelf(): bool		;isSelf(): bool
	:Return if the counter is visible by the current player only.		:Return if the counter is visible by the current player only.

			;setUseNo(bool $useNo)
			:Tell if the counter input will be player no (true) or player id (false)

			;setStrict(bool $strict)
			:Tell if the counter input will be validated. If true, the counter will trigger an exception if the no or id doesn't exist in the game.

	==TableCounter==		==TableCounter==

Epsilon Theta: Added a section to advise on the needs of the built-in player score PlayerCounter.

2026-04-14T18:13:05Z

Added a section to advise on the needs of the built-in player score PlayerCounter.

← Older revision		Revision as of 18:13, 14 April 2026
Line 213:		Line 213:

	In the same fashion, there is <code>notif_setTableCounter</code> and <code>notif_setPlayerCounterAll</code>.		In the same fashion, there is <code>notif_setTableCounter</code> and <code>notif_setPlayerCounterAll</code>.

			== Game's default Player Score ==
			The default <code>PlayerCounter</code> provided by <code>game</code> relies on reading <code>score</code> from <code>gamedatas</code>. As such, make sure that you provide it in <code>getAllDatas():</code><pre>
			$result["players"] = $this->getCollectionFromDb(
			"SELECT `player_id` `id`, `player_score` AS `score` FROM `player`"
			);
			</pre>

	[[Category:Studio]]		[[Category:Studio]]

Thoun: /* PlayerCounter */

2026-04-08T12:49:46Z

PlayerCounter

← Older revision		Revision as of 12:49, 8 April 2026
Line 75:		Line 75:
	:* <code>OutOfRangeCounterException</code> if the value is outside the min/max		:* <code>OutOfRangeCounterException</code> if the value is outside the min/max

	;fillResult(array &$result, ?string $fieldName = null)		;fillResult(array &$result, ?string $fieldName = null, ?int $currentPlayerId = null)
	:Updates the result object, to be used in the <code>getAllDatas</code> function. Will set the value on each <code>$result["players"]</code> sub-array.		:Updates the result object, to be used in the <code>getAllDatas</code> function. Will set the value on each <code>$result["players"]</code> sub-array.
	:Parameters:		:Parameters:
	:* <code>array &$result</code> the object to update		:* <code>array &$result</code> the object to update
	:* <code>?string $fieldName</code> the field name to set in $result["players"], if different than the counter name.		:* <code>?string $fieldName</code> the field name to set in $result["players"], if different than the counter name.
			:* <code>?int $currentPlayerId</code> the current player for visibility "self".

			;setVisibility(CounterVisibility $visibility)
			:Set the counter visibility.

			;isVisible(): bool
			:Return if the counter is visible by anyone.

			;isHidden(): bool
			:Return if the counter is invisible.

			;isSelf(): bool
			:Return if the counter is visible by the current player only.

	==TableCounter==		==TableCounter==

Thoun: /* Overview */

2026-04-08T12:47:02Z

Overview

← Older revision		Revision as of 12:47, 8 April 2026
Line 15:		Line 15:
	Two PlayerCounter are available by default on the games, playerScore and playerScoreAux. As their name suggests, they will update the player_score and player_score_aux for you (and the score counter on the player panels, front-side), so you never need to update manually the scores on the DB. They don't have a min, and default is 0, so if you need to set a different initial value, call <code>$this->playerScore->setAll(2)</code>.		Two PlayerCounter are available by default on the games, playerScore and playerScoreAux. As their name suggests, they will update the player_score and player_score_aux for you (and the score counter on the player panels, front-side), so you never need to update manually the scores on the DB. They don't have a min, and default is 0, so if you need to set a different initial value, call <code>$this->playerScore->setAll(2)</code>.

	'''$this->counterFactory->createPlayerCounter(string $name, ?int $min = 0, ?int $max = null): PlayerCounter'''		'''$this->counterFactory->createPlayerCounter(string $name, ?int $min = 0, ?int $max = null, CounterVisibility $visibility = CounterVisibility::VISIBLE): PlayerCounter'''

	'''$this->counterFactory->createTableCounter(string $name, ?int $min = 0, ?int $max = null): TableCounter'''		'''$this->counterFactory->createTableCounter(string $name, ?int $min = 0, ?int $max = null): TableCounter'''

			Visibility can be:
			* public (default): everyone can see the counter values
			* self: only the current player can see the value of their counter, bot not the others (that will display '-')
			* private: nobody can see the counter values (that will display '-')

	== PlayerCounter ==		== PlayerCounter ==

GTSchemer at 18:25, 28 January 2026

2026-01-28T18:25:04Z

← Older revision		Revision as of 18:25, 28 January 2026
Line 195:		Line 195:

	In the same fashion, there is <code>notif_setTableCounter</code> and <code>notif_setPlayerCounterAll</code>.		In the same fashion, there is <code>notif_setTableCounter</code> and <code>notif_setPlayerCounterAll</code>.

			[[Category:Studio]]

Thoun at 09:32, 14 January 2026

2026-01-14T09:32:36Z

← Older revision		Revision as of 09:32, 14 January 2026
Line 13:		Line 13:
	Note that by default, they have a min to 0 and no max, but you can change that in the create function.		Note that by default, they have a min to 0 and no max, but you can change that in the create function.

	Two PlayerCounter are available by default on the games, playerScore and playerScoreAux. As their name suggests, they will update the player_score and player_score_aux for you (and ~~scoreCtrl~~ on front-side), so you never need to update manually the scores on the DB. They don't have a min, and default is 0, so if you need to set a different initial value, call <code>$this->playerScore->setAll(2)</code>.		Two PlayerCounter are available by default on the games, playerScore and playerScoreAux. As their name suggests, they will update the player_score and player_score_aux for you (and the score counter on the player panels, front-side), so you never need to update manually the scores on the DB. They don't have a min, and default is 0, so if you need to set a different initial value, call <code>$this->playerScore->setAll(2)</code>.

	'''$this->counterFactory->createPlayerCounter(string $name, ?int $min = 0, ?int $max = null): PlayerCounter'''		'''$this->counterFactory->createPlayerCounter(string $name, ?int $min = 0, ?int $max = null): PlayerCounter'''

Thoun: /* Example */

2026-01-06T09:56:25Z

Example

← Older revision		Revision as of 09:56, 6 January 2026
Line 181:		Line 181:
	{ value: gamedatas.remainingTokens, tableCounter: 'remainingTokens' }		{ value: gamedatas.remainingTokens, tableCounter: 'remainingTokens' }
	);		);
	~~});~~
	</pre>		</pre>

Thoun: /* Example */

2026-01-06T09:56:07Z

Example

← Older revision		Revision as of 09:56, 6 January 2026
Line 173:		Line 173:

	Nothing more needs to be set, the JS counter will update automatically when you call <code>set</code> or <code>inc</code>!		Nothing more needs to be set, the JS counter will update automatically when you call <code>set</code> or <code>inc</code>!

			For a TableCounter, the value will be sent directly in the gamedatas, with the fieldName you set in fillResult, or with the counter name if no fieldName is set.
			<pre>
			const counter = new ebg.counter();
			counter.create(
			`remaining-tokens-counter`,
			{ value: gamedatas.remainingTokens, tableCounter: 'remainingTokens' }
			);
			});
			</pre>

	== Listen to counter notification on the client ==		== Listen to counter notification on the client ==

Thoun: /* Example */

2025-12-19T14:20:10Z

Example

← Older revision		Revision as of 14:20, 19 December 2025
Line 160:		Line 160:
	<pre>		<pre>
	Object.values(gamedatas.players).forEach(player => {		Object.values(gamedatas.players).forEach(player => {
	this.playerPanels.getElement(player.id).insertAdjacentHTML('beforeend', `		this.bga.playerPanels.getElement(player.id).insertAdjacentHTML('beforeend', `
	<div id="energy-player-counter-${player.id}"></div>		<div id="energy-player-counter-${player.id}"></div>
	<span>${_("Energy")}</span>		<span>${_("Energy")}</span>