Practical debugging - Revision history

Thoun: /* Writing custom debug functions */

2026-07-07T10:04:17Z

Writing custom debug functions

← Older revision		Revision as of 12:04, 7 July 2026
Line 252:		Line 252:
	function debug_playUntilMyTurn() {		function debug_playUntilMyTurn() {
	$this->debug->playUntil(fn(int $count) => (int)$this->getActivePlayerId() === (int)$this->getCurrentPlayerId());		$this->debug->playUntil(fn(int $count) => (int)$this->getActivePlayerId() === (int)$this->getCurrentPlayerId());
			}

			function debug_testUpgradeTableDb(int $version = 0) {
			$this->upgradeTableDb($version);
	}		}
	</pre>		</pre>

Thoun at 09:29, 12 March 2026

2026-03-12T09:29:24Z

← Older revision		Revision as of 11:29, 12 March 2026
Line 132:		Line 132:
	} catch ( Exception $e ) {		} catch ( Exception $e ) {
	// logging does not actually work in game init :(		// logging does not actually work in game init :(
	~~// but if you calling from php chat it will work~~
	$this->error("Fatal error while creating game");		$this->error("Fatal error while creating game");
	$this->dump('err', $e);		$this->dump('err', $e);
Line 138:		Line 137:
	}		}

	Create a code for this function, and if it does not work run it from ~~the chat window~~ of the just created game ~~(i.e. 'initMyTables()' without quotes)~~. That way you can see debug output!		Create a code for this function, and if it does not work run it from a debug_ function of the just created game. That way you can see debug output!
	The only trick is you have to clear all your tables in the begging so when you run it multiple times your db does not puke.		The only trick is you have to clear all your tables in the begging so when you run it multiple times your db does not puke.
	If your game does not start at all - do not even call it from setupNewGame, comment it out and only call from ~~chat window~~ until it works.		If your game does not start at all - do not even call it from setupNewGame, comment it out and only call from a debug_ function until it works.
	Don't forget you can also look at tables in db using php-admin tool (link at the bottom of the game table in studio).		Don't forget you can also look at tables in db using php-admin tool (link at the bottom of the game table in studio).

Line 146:		Line 145:
	to you game state, after you done debugging it remove the state and shortcut the transition to your game state.		to you game state, after you done debugging it remove the state and shortcut the transition to your game state.

	Instead of calling initMyTables directly you can call helper function ~~instead from chat window~~ which will also reset the client, i.e.		Instead of calling initMyTables directly you can call an helper function ike this which will also reset the client, i.e.
	<pre>		<pre>
	function debug_initMyTables() {		function debug_initMyTables() {
Line 217:		Line 216:
	BGA will detect methods with this prefix and the associated parameters.		BGA will detect methods with this prefix and the associated parameters.

	Functions with parameters will show with "..." in the debug menu and will show a popin to set the parameters. Functions without parameters will be called directly~~. The result in the end is the same as calling the function from the chat~~.		Functions with parameters will show with "..." in the debug menu and will show a popin to set the parameters. Functions without parameters will be called directly.

	'''More examples of debug functions :'''		'''More examples of debug functions :'''

Thoun: /* Debugging my PHP game logic (or my view) */

2026-03-10T08:29:02Z

Debugging my PHP game logic (or my view)

← Older revision		Revision as of 10:29, 10 March 2026
Line 84:		Line 84:
	To access logs on production, use button "Display recent errors from production (unexpected errors)" on control panel of your game		To access logs on production, use button "Display recent errors from production (unexpected errors)" on control panel of your game

	~~=== Call php functions from chat ===~~

	~~Obsolete, please use [[Practical debugging#Writing custom debug functions]] instead.~~

	~~You can call individual function in your game.php from chat window, see details~~
	~~at https://en.doc.boardgamearena.com/Tools_and_tips_of_BGA_Studio#Run_PHP_functions_from_the_chat~~
	=== Dump data and die ===		=== Dump data and die ===
	First, make sure you can reproduce the needed game situation with one click. Use Save ("[[Tools_and_tips_of_BGA_Studio#Save_.26_restore_state\|save & restore]]") function before doing some "test actions".		First, make sure you can reproduce the needed game situation with one click. Use Save ("[[Tools_and_tips_of_BGA_Studio#Save_.26_restore_state\|save & restore]]") function before doing some "test actions".

Thoun at 10:27, 13 February 2026

2026-02-13T10:27:48Z

← Older revision		Revision as of 12:27, 13 February 2026
Line 158:		Line 158:
	$this->initMyTables();		$this->initMyTables();
	$newGameDatas = $this->getAllTableDatas(); // this is framework function		$newGameDatas = $this->getAllTableDatas(); // this is framework function
	$this->notify->player($this->getActivePlayerId(), 'resetInterfaceWithAllDatas', '', $newGameDatas); // this is notification to reset all data		$this->bga->notify->player($this->getActivePlayerId(), 'resetInterfaceWithAllDatas', '', $newGameDatas); // this is notification to reset all data
	$this->notify->all("message",'setup called',[]);		$this->bga->notify->all("message",'setup called',[]);
	}		}
	</pre>HINT: This is a great suggestion. If you make any simple mistake in any code in setupNewGame, you may see "BGA Service Exception" instead of anything very useful, since setupNewGame failed. For example, even sending a bad SQL string to $this->dbQuery() will generate this error. Very hard to debug!		</pre>HINT: This is a great suggestion. If you make any simple mistake in any code in setupNewGame, you may see "BGA Service Exception" instead of anything very useful, since setupNewGame failed. For example, even sending a bad SQL string to $this->dbQuery() will generate this error. Very hard to debug!

Thoun: /* Writing custom debug functions */

2026-02-10T08:23:55Z

Writing custom debug functions

← Older revision		Revision as of 10:23, 10 February 2026
Line 213:		Line 213:
	#[Debug(reload: true)]		#[Debug(reload: true)]
	function debug_setCardType(int $id, int $type, int $typeArg = 0) {		function debug_setCardType(int $id, int $type, int $typeArg = 0) {
	$this->DbQuery("UPDATE card SET card_type = $type, card_type_arg = $typeArg WHERE card_id = $id" );		$this->DbQuery("UPDATE `card` SET `card_type` = $type, `card_type_arg` = $typeArg WHERE `card_id` = $id" );
	}		}
	</pre>		</pre>

Thoun: /* Studio environment */

2026-02-10T08:23:24Z

Studio environment

← Older revision		Revision as of 10:23, 10 February 2026
Line 368:		Line 368:
	Some developers have requested a method allowing to know which environment the module is running on. While in general, your code should be the same on all environments so that the validation process makes sense, this may allow for example to display some helpers for testing during development while being sure that they'll never show up outside of the studio.		Some developers have requested a method allowing to know which environment the module is running on. While in general, your code should be the same on all environments so that the validation process makes sense, this may allow for example to display some helpers for testing during development while being sure that they'll never show up outside of the studio.

	From your ~~<gamename>.game~~.php file you can use:		From your Game.php file you can use:

	<pre>if ($this->getBgaEnvironment() == 'studio') { ... }</pre>		<pre>if ($this->getBgaEnvironment() === 'studio') { ... }</pre>

	Or if needed from your <gamename>.view.php file:		Or if needed from your <gamename>.view.php file:

	<pre>if ($this->game->getBgaEnvironment() == 'studio') { ... }</pre>		<pre>if ($this->game->getBgaEnvironment() === 'studio') { ... }</pre>



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

Thoun: /* Get the database matching a bug report */

2026-02-10T08:23:05Z

Get the database matching a bug report

@@ Line 363: / Line 363: @@
 * Load the bug dump by entering the bug report ID this debug section
 [[File:LoadBugReportInput.png]]
 == Studio environment ==

Thoun: /* Writing custom debug functions */

2025-12-15T16:39:03Z

Writing custom debug functions

← Older revision		Revision as of 18:39, 15 December 2025
Line 251:		Line 251:
	$round = $this->getCurrentRound();		$round = $this->getCurrentRound();
	$this->debug->playUntil(fn(int $count) => $this->getCurrentRound() > $round);		$this->debug->playUntil(fn(int $count) => $this->getCurrentRound() > $round);
			}

			// to go to the turn of a specific player
			function debug_playUntilTurnOf(int $playerId) {
			$this->debug->playUntil(fn(int $count) => (int)$this->getActivePlayerId() === $playerId);
			}
			function debug_playUntilMyTurn() {
			$this->debug->playUntil(fn(int $count) => (int)$this->getActivePlayerId() === (int)$this->getCurrentPlayerId());
	}		}
	</pre>		</pre>

Thoun: /* Writing custom debug functions */

2025-12-15T16:31:49Z

Writing custom debug functions

← Older revision		Revision as of 18:31, 15 December 2025
Line 231:		Line 231:
	$this->gamestate->jumpToState($state);		$this->gamestate->jumpToState($state);
	}		}
	</~~pre>~~
	~~<pre>~~		// play one move, using the zombie code
	function debug_playOneMove() {		function debug_playOneMove() {
	$this->debug->playUntil(fn(int $count) => $count == 1);		$this->debug->playUntil(fn(int $count) => $count == 1);
	}		}

			// if you want to be able to concede
	function debug_playToFiftyPercent() {		function debug_playToFiftyPercent() {
	$this->debug->playUntil(fn(int $count) => $this->gamestate->getCurrentMainStateId() >= ST_END_GAME \|\| $this->getGameProgression() >= 50 \|\| $count >= 100);		$this->debug->playUntil(fn(int $count) => $this->gamestate->getCurrentMainStateId() >= ST_END_GAME \|\| $this->getGameProgression() >= 50 \|\| $count >= 100);
	}		}

			// to see end game result
	function debug_playToEndGame() {		function debug_playToEndGame() {
	$this->debug->playUntil(fn(int $count) => $this->gamestate->getCurrentMainStateId() >= ST_END_GAME \|\| $count >= 100);		$this->debug->playUntil(fn(int $count) => $this->gamestate->getCurrentMainStateId() >= ST_END_GAME \|\| $count >= 100);
	}		}

			// to see end round result
	function debug_playToEndRound() {		function debug_playToEndRound() {
	$round = $this->getCurrentRound();		$round = $this->getCurrentRound();

Thoun: /* Writing custom debug functions */

2025-12-15T16:30:44Z

Writing custom debug functions

← Older revision		Revision as of 18:30, 15 December 2025
Line 233:		Line 233:
	</pre>		</pre>
	<pre>		<pre>
	~~// randomly play until reaching the end of round state (example from Pixies game), to test end round computation without playing all the round.~~		function debug_playOneMove() {
	function ~~debug_playToEndRound~~(~~) {~~		$this->debug->playUntil(fn(int $count) => $count == 1);
	~~while (intval($this->gamestate->state_id()) < ST_MULTIPLAYER_BEFORE_END_ROUND~~) {		}
	~~$state = intval(~~$this->~~gamestate~~->~~state_id~~(~~));~~
	~~switch~~ ($~~state~~) {
	~~case ST_PLAYER_CHOOSE_CARD:~~
	$~~playerId~~ = ~~intval($this->getActivePlayerId()~~);

	~~$cards =~~ $this->~~getCardsFromDb~~($this->~~cards~~->~~getCardsInLocation~~(~~'table'~~));		function debug_playToFiftyPercent() {
	~~$card~~ = $~~cards[bga_rand(0,~~ count~~($cards) - 1~~)];		$this->debug->playUntil(fn(int $count) => $this->gamestate->getCurrentMainStateId() >= ST_END_GAME \|\| $this->getGameProgression() >= 50 \|\| $count >= 100);
			}

	$this->~~applyChooseCard~~($~~playerId, $card~~);		function debug_playToEndGame() {
	~~break;~~		$this->debug->playUntil(fn(int $count) => $this->gamestate->getCurrentMainStateId() >= ST_END_GAME \|\| $count >= 100);
			}
	~~case ST_PLAYER_PLAY_CARD:~~
	~~$playerId~~ = ~~intval(~~$this->~~getActivePlayerId());~~
	~~$args = $this~~->~~argPlayCard~~();
	~~$spaces~~ = $~~args['spaces'];~~
	~~$space~~ = ~~$spaces[bga_rand(0, count($spaces~~) ~~- 1)]~~;

	$this->~~applyPlayCard~~(~~$playerId, $space~~);		function debug_playToEndRound() {
	~~break;~~		$round = $this->getCurrentRound();
			$this->debug->playUntil(fn(int $count) => $this->getCurrentRound() > $round);
	~~case ST_PLAYER_KEEP_CARD:~~
	~~$playerId = intval(~~$this->~~getActivePlayerId~~());
	$this->~~applyKeepCard~~($~~playerId, 0~~);
	~~break;~~
	}
	}
	}		}
	</pre>		</pre>