Main game logic: Game.php - Revision history

Thoun: /* Co-operative game */

2026-09-30T09:03:38Z

Co-operative game

@@ Line 1,537: / Line 1,537: @@
 Assign a score of zero to everyone if it's a loss.
 Assign the same score > 0 to everyone if it's a win.
 === Semi-coop ===

Thoun: /* Solo */

2026-09-30T09:03:02Z

Solo

← Older revision		Revision as of 11:03, 30 September 2026
Line 1,576:		Line 1,576:

	If game supports solo variant, a negative or zero score means defeat, a positive score means victory.		If game supports solo variant, a negative or zero score means defeat, a positive score means victory.

			If your want to consider some positive scores as defeat, you need to set-up a GameResult object to tell BGA this specificity.

			On your last state (usually EndScore.php), instead of returning 99 to go the end game, return a GameResult. returning a GameResult object in a State class will then go the end game.
			<pre>
			use Bga\GameFramework\GameResult\GameResult;
			use Bga\GameFramework\GameResult\Player;

			...

			public function onEnteringState() {
			...

			// TODO fetch $playerScore and $automataScore
			return GameResult::solo(score: $playerScore, win: $playerScore > $automataScore);
			}
			</pre>

	=== Player elimination ===		=== Player elimination ===

Thoun: /* Reverse scoring and reverse tie-breaker */

2026-09-30T09:00:14Z

Reverse scoring and reverse tie-breaker

← Older revision		Revision as of 11:00, 30 September 2026
Line 1,510:		Line 1,510:
	</pre>		</pre>
	If there are negative score, the game will continue with negative scores, else it will continue with positive scores.		If there are negative score, the game will continue with negative scores, else it will continue with positive scores.

			If your game always have the player score stored in the way it should be displayed, it's not necessary to send the players object, you can just use
			<pre>
			return GameResult::individualRanking(reverseScore: true);
			</pre>

	=== Result neutralization ===		=== Result neutralization ===

Thoun: /* Debugging and Tracing */

2026-09-30T08:58:11Z

Debugging and Tracing

← Older revision		Revision as of 10:58, 30 September 2026
Line 2,012:		Line 2,012:


	'''getBgaEnvironment(): string'''		'''static getBgaEnvironment(): string'''
	:Returns "studio" for studio and "prod" for production environment (i.e. where games current runs). Only useful for debbugging hooks.		:Returns "studio" for studio and "prod" for production environment (i.e. where games current runs). Only useful for debbugging hooks.
	~~Note~~: ~~alpha server is also "prod"~~
			; '''$this->bga->tableOptions->getGameVersion(): int'''
			: Returns the current game version

	== Creating other classes ==		== Creating other classes ==

Thoun: /* BGA predefined globals */

2026-09-28T14:11:16Z

BGA predefined globals

← Older revision		Revision as of 16:11, 28 September 2026
Line 397:		Line 397:
	=== BGA predefined globals ===		=== BGA predefined globals ===

	BGA already defines some globals in the ''global'' database table. You should not change them directly but it can be useful to know what they mean when debugging:		BGA already defines some globals in the ''global'' database table. You should not change them directly, nor read them in your game code, but it can be useful to know what they mean when debugging:

	{\| class="wikitable"		{\| class="wikitable"

Lymon Flowers: /* Tournament API (🚧 Beta) */ Update infos returned by tournament->getInfo()

2026-09-09T05:54:19Z

Tournament API (🚧 Beta): Update infos returned by tournament->getInfo()

← Older revision		Revision as of 07:54, 9 September 2026
Line 1,911:		Line 1,911:
	:* <code>name</code>: Name of the tournament		:* <code>name</code>: Name of the tournament
	:* <code>championship_name</code>: Championship name if any		:* <code>championship_name</code>: Championship name if any
			:* <code>tournament_parent_id</code> : ID of the parent tournament if any
			:* <code>tournament_group</code> : BGA group associated to the tournament
	:* <code>oot_options</code>: Out of Time players options (<code>no_kick</code>, <code>auto_kick</code>)		:* <code>oot_options</code>: Out of Time players options (<code>no_kick</code>, <code>auto_kick</code>)
	:* <code>avatar</code>: avatar ID		:* <code>avatar</code>: avatar ID

Quietmint: /* Actions (autowired) */ magic params

2026-08-08T20:03:43Z

Actions (autowired): magic params

← Older revision		Revision as of 22:03, 8 August 2026
Line 839:		Line 839:
	(Note: if you also declare the function in the action.php, it will be used instead of the autowiring)		(Note: if you also declare the function in the action.php, it will be used instead of the autowiring)

	~~Similar to the state <code>getArgs()</code> function, autowired~~ action functions support the following "magic" parameters that will be automatically filled by the framework:		Autowired action functions support the following "magic" parameters that will be automatically filled by the framework:

			* <code>array $args</code> will be filled by current state's arguments (result of your <code>getArgs()</code> function)
	* <code>int $activePlayerId</code> (or <code>int $active_player_id</code>) will be filled by the id of the active player. To be used on ACTIVE_PLAYER states only.		* <code>int $activePlayerId</code> (or <code>int $active_player_id</code>) will be filled by the id of the active player. To be used on ACTIVE_PLAYER states only.
	* <code>int $activePlayerNo</code> (or <code>int $active_player_no</code>) will be filled by the no of the active player. To be used on ACTIVE_PLAYER states only.		* <code>int $activePlayerNo</code> (or <code>int $active_player_no</code>) will be filled by the no of the active player. To be used on ACTIVE_PLAYER states only.
	* <code>int $~~playerId~~</code> (or ~~<code>int $player_id</code>/<code>int $currentPlayerId</code>/~~<code>int $current_player_id</code>) will be filled by the player id of the current player. To be used on MULTIPLE_ACTIVE_PLAYER and PRIVATE states only.		* <code>int $currentPlayerId</code> (or <code>int $current_player_id</code>) will be filled by the player id of the current player. To be used on MULTIPLE_ACTIVE_PLAYER and PRIVATE states only.
	* <code>int $~~playerNo~~</code> (or ~~<code>int $player_no</code>/<code>int $currentPlayerNo</code>/~~<code>int $current_player_no</code>) will be filled by the player no of the current player. To be used on MULTIPLE_ACTIVE_PLAYER and PRIVATE states only.		* <code>int $currentPlayerNo</code> (or <code>int $current_player_no</code>) will be filled by the player no of the current player. To be used on MULTIPLE_ACTIVE_PLAYER and PRIVATE states only.
	* <code>~~array~~ $~~args~~</code> ~~will be filled by current state's arguments (your~~ <code>~~getArgs()~~</code> ~~function)~~		* ''Note: unlike <code>getArgs()</code>, autowired actions do '''NOT''' support magic parameters <code>int $playerId</code>/<code>int $player_id</code> to refer to the current player. This inconsistency is probably a framework bug.''

	If you want more complex types like int array or JSON, you'll need to specify it using the Param attributes. Same if the PHP variable name is different from the front query param, or if you want to specify the tests that should be realized on the parameter before calling the function.		If you want more complex types like int array or JSON, you'll need to specify it using the Param attributes. Same if the PHP variable name is different from the front query param, or if you want to specify the tests that should be realized on the parameter before calling the function.

Quietmint: /* Actions (autowired) */ magic params

2026-08-08T19:42:29Z

Actions (autowired): magic params

← Older revision		Revision as of 21:42, 8 August 2026
Line 839:		Line 839:
	(Note: if you also declare the function in the action.php, it will be used instead of the autowiring)		(Note: if you also declare the function in the action.php, it will be used instead of the autowiring)

	~~Autowired actions also~~ support the following magic parameters:		Similar to the state <code>getArgs()</code> function, autowired action functions support the following "magic" parameters that will be automatically filled by the framework:

	* <code>int $activePlayerId</code> (or <code>int $activePlayerNo</code>) ~~to get~~ the active player		* <code>int $activePlayerId</code> (or <code>int $active_player_id</code>) will be filled by the id of the active player. To be used on ACTIVE_PLAYER states only.
	* <code>int $currentPlayerId</code> (or <code>int $currentPlayerNo</code>) ~~to get~~ the current player (e.~~g., for~~ MULTIPLE_ACTIVE_PLAYER states)		* <code>int $activePlayerNo</code> (or <code>int $active_player_no</code>) will be filled by the no of the active player. To be used on ACTIVE_PLAYER states only.
	* <code>array $args</code> ~~to get the~~ current state arguments		* <code>int $playerId</code> (or <code>int $player_id</code>/<code>int $currentPlayerId</code>/<code>int $current_player_id</code>) will be filled by the player id of the current player. To be used on MULTIPLE_ACTIVE_PLAYER and PRIVATE states only.
			* <code>int $playerNo</code> (or <code>int $player_no</code>/<code>int $currentPlayerNo</code>/<code>int $current_player_no</code>) will be filled by the player no of the current player. To be used on MULTIPLE_ACTIVE_PLAYER and PRIVATE states only.
			* <code>array $args</code> will be filled by current state's arguments (your <code>getArgs()</code> function)

	If you want more complex types like int array or JSON, you'll need to specify it using the Param attributes. Same if the PHP variable name is different from the front query param, or if you want to specify the tests that should be realized on the parameter before calling the function.		If you want more complex types like int array or JSON, you'll need to specify it using the Param attributes. Same if the PHP variable name is different from the front query param, or if you want to specify the tests that should be realized on the parameter before calling the function.

Quietmint: /* Actions (autowired) */ magic params

2026-08-08T19:26:33Z

Actions (autowired): magic params

← Older revision		Revision as of 21:26, 8 August 2026
Line 838:		Line 838:

	(Note: if you also declare the function in the action.php, it will be used instead of the autowiring)		(Note: if you also declare the function in the action.php, it will be used instead of the autowiring)

			Autowired actions also support the following magic parameters:

			* <code>int $activePlayerId</code> (or <code>int $activePlayerNo</code>) to get the active player
			* <code>int $currentPlayerId</code> (or <code>int $currentPlayerNo</code>) to get the current player (e.g., for MULTIPLE_ACTIVE_PLAYER states)
			* <code>array $args</code> to get the current state arguments

	If you want more complex types like int array or JSON, you'll need to specify it using the Param attributes. Same if the PHP variable name is different from the front query param, or if you want to specify the tests that should be realized on the parameter before calling the function.		If you want more complex types like int array or JSON, you'll need to specify it using the Param attributes. Same if the PHP variable name is different from the front query param, or if you want to specify the tests that should be realized on the parameter before calling the function.

Lymon Flowers: /* Tournament API (🚧 Beta) */ Add missing function

2026-07-29T14:09:14Z

Tournament API (🚧 Beta): Add missing function

← Older revision		Revision as of 16:09, 29 July 2026
Line 1,895:		Line 1,895:
	: Returns true if this table is a tournament encounter.		: Returns true if this table is a tournament encounter.
	: Use this to guard tournament‑only logic.		: Use this to guard tournament‑only logic.
			'''$this->bga->tournament->getInfo()'''

			: Returns an associative array containing the tournament informations.
			: Keys:
			:* <code>id:</code> ID of the tournament
			:* <code>name</code>: Name of the tournament
			:* <code>championship_name</code>: Championship name if any
			:* <code>oot_options</code>: Out of Time players options (<code>no_kick</code>, <code>auto_kick</code>)
			:* <code>avatar</code>: avatar ID

	; $this->'''bga->'''tournament->getSeedInfo()		; $this->'''bga->'''tournament->getSeedInfo()