Your game state machine: states.inc.php - Revision history

Thoun at 14:53, 5 November 2026

2026-11-05T14:53:49Z

← Older revision		Revision as of 14:53, 5 November 2026
Line 600:		Line 600:
	</pre>		</pre>

	Please check the detailed API [~~[Main_game_logic~~:~~_yourgamename~~.game~~.php~~#~~Private_parallel_states\|~~here]].		Please check the detailed API [https://doc.studio.boardgamearena.com/framework-documentation/back-end/main-game-logic/#private-parallel-states here].

	=== Client States ===		=== Client States ===

2026-11-05T11:14:05Z

← Older revision		Revision as of 11:14, 5 November 2026
Line 1:		Line 1:
			{{InfoBox\|title=Deprecated\|body='''IMPORTANT NOTE:''' This file is deprecated, you shouldn't need to change it if you use [https://doc.studio.boardgamearena.com/framework-documentation/back-end/game-state-classes/ State classes]. See the Reversi tutorial for an example.}}

	{{Studio_Framework_Navigation}}		{{Studio_Framework_Navigation}}


	<span style='color:red; font-size:20px;'>'''IMPORTANT NOTE:''' This file is deprecated, you shouldn't need to change it if you use [https://doc.studio.boardgamearena.com/framework-documentation/back-end/game-state-classes/ State classes]. See the Reversi tutorial for an example.</span>

	This file describes the state machine of your game (all the game states properties, and the transitions to get from one state to another).		This file describes the state machine of your game (all the game states properties, and the transitions to get from one state to another).

2026-11-04T17:20:39Z

← Older revision		Revision as of 17:20, 4 November 2026
Line 2:		Line 2:


	<span style='color:red; font-size:20px;'>'''IMPORTANT NOTE:''' This file is deprecated, you shouldn't need to change it if you use [~~[State~~ classes~~: State directory\|~~State classes]]. See the Reversi tutorial for an example.</span>		<span style='color:red; font-size:20px;'>'''IMPORTANT NOTE:''' This file is deprecated, you shouldn't need to change it if you use [https://doc.studio.boardgamearena.com/framework-documentation/back-end/game-state-classes/ State classes]. See the Reversi tutorial for an example.</span>

	This file describes the state machine of your game (all the game states properties, and the transitions to get from one state to another).		This file describes the state machine of your game (all the game states properties, and the transitions to get from one state to another).

2025-09-19T14:01:48Z

← Older revision		Revision as of 14:01, 19 September 2025
Line 2:		Line 2:


	<span style='color:red; font-size:20px;'>'''IMPORTANT NOTE:''' This file is deprecated, you shouldn't need to change it if you use State classes. See the Reversi tutorial for an example.</span>		<span style='color:red; font-size:20px;'>'''IMPORTANT NOTE:''' This file is deprecated, you shouldn't need to change it if you use [[State classes: State directory\|State classes]]. See the Reversi tutorial for an example.</span>

	This file describes the state machine of your game (all the game states properties, and the transitions to get from one state to another).		This file describes the state machine of your game (all the game states properties, and the transitions to get from one state to another).

2025-09-19T14:01:03Z

← Older revision		Revision as of 14:01, 19 September 2025
Line 1:		Line 1:
	{{Studio_Framework_Navigation}}		{{Studio_Framework_Navigation}}


			<span style='color:red; font-size:20px;'>'''IMPORTANT NOTE:''' This file is deprecated, you shouldn't need to change it if you use State classes. See the Reversi tutorial for an example.</span>

	This file describes the state machine of your game (all the game states properties, and the transitions to get from one state to another).		This file describes the state machine of your game (all the game states properties, and the transitions to get from one state to another).

2025-07-23T13:26:18Z

← Older revision		Revision as of 13:26, 23 July 2025
Line 499:		Line 499:

	== Implementation Notes ==		== Implementation Notes ==

			=== End Score state ===
			You will often need to do some computation at the end of the game, for end score or for average stats. As you cannot modify the endGame state, it's recommended to create a state just before, that will do it.

			On your project skeleton, you'll have <pre>98 => GameStateBuilder::endScore()->build()</pre> in your states.inc.php, that will call stEndScore function defined in your Game.php. Use it to do those computations.

			For debugging purpose, you can comment this line in your states.inc.php and replace it by
			<pre>
			98 => GameStateBuilder::create()
			->name('endScore')
			->description('')
			->descriptionmyturn('')
			->type(StateType::ACTIVE_PLAYER)
			->action('stEndScore')
			->build(),
			</pre>
			and comment the nextState on stEndScore. Then you can run your game to the endScore state, test the result, and reload a previous state until your debugging is complete.

	=== Private parallel states ===		=== Private parallel states ===

2025-06-19T09:36:55Z

Complete examples

← Older revision		Revision as of 09:36, 19 June 2025
Line 699:		Line 699:
	}		}

	$machinestates = [		$machinestates = [
	~~1 => [ // The initial state. Please do not modify.~~
	~~"name" => "gameSetup",~~
	~~"description" => "",~~
	~~"type" => "manager",~~
	~~"action" => "stGameSetup",~~
	~~"transitions" => [ "" => STATE_PLAYER_TURN ] ],~~
	// Game states		// Game states
	STATE_PLAYER_TURN => [ // main active player state		STATE_PLAYER_TURN => [ // main active player state
Line 735:		Line 729:
	"transitions" => ["next" => STATE_END_GAME,"loopback" => STATE_PLAYER_GAME_END ] //		"transitions" => ["next" => STATE_END_GAME,"loopback" => STATE_PLAYER_GAME_END ] //
	],		],
	~~// End of Game states~~
	~~// Final state.~~
	~~// Please do not modify (and do not overload action/args methods).~~
	~~STATE_END_GAME => [~~
	~~"name" => "gameEnd",~~
	~~"description" => clienttranslate("End of game"),"type" => "manager",~~
	~~"action" => "stGameEnd",~~
	~~"args" => "argGameEnd" ]~~

	];		];

2025-06-19T09:36:05Z

Overall structure

← Older revision		Revision as of 09:36, 19 June 2025
Line 18:		Line 18:

	$machinestates = [		$machinestates = [
			// only keep this line if your initial state is not 2. In that case, uncomment and replace '2' by your first state id.
	// ~~The~~ initial state. ~~Please do not modify~~.		// 1 => GameStateBuilder::gameSetup(2)->build(),
	1 => GameStateBuilder::~~create()~~
	~~->name('~~gameSetup')
	~~->description('')~~
	~~->type~~(~~StateType::MANAGER)~~
	~~->action('stGameSetup')~~
	~~->transitions(['' =>~~ 2])
	->build(),

	~~// Note: ID=2 => your first state~~

	2 => GameStateBuilder::create()		2 => GameStateBuilder::create()

2025-06-08T17:46:38Z

Example of MULTIPLE_ACTIVE_PLAYER state

← Older revision		Revision as of 17:46, 8 June 2025
Line 636:		Line 636:

	2 => GameStateBuilder::create()		2 => GameStateBuilder::create()
	->name('playerTurnSetup'),		->name('playerTurnSetup')
	->type(StateType::MULTIPLE_ACTIVE_PLAYER)		->type(StateType::MULTIPLE_ACTIVE_PLAYER)
	->description(clienttranslate('Other players must choose one Objective'))		->description(clienttranslate('Other players must choose one Objective'))
Line 644:		Line 644:
	->action('stMultiPlayerInit')		->action('stMultiPlayerInit')
	->args('argplayerTurnSetup')		->args('argplayerTurnSetup')
	>build(),		->build(),

	In game.php:		In game.php:

2025-06-04T12:55:25Z

description

← Older revision		Revision as of 12:55, 4 June 2025
Line 138:		Line 138:

	In mygame.game.php:		In mygame.game.php:
	function argMyArgumentMethod()		function argMyArgumentMethod(): array
	{		{
	return ~~array(~~		return [
	'nbr' => 2 // In this case ${nbr} in the description will be replaced by "2"		'nbr' => 2 // In this case ${nbr} in the description will be replaced by "2"
	);		];
	}		}
	</pre>		</pre>