State classes: State directory - Revision history

Thoun: /* Function zombie */

2026-04-29T08:34:11Z

Function zombie

← Older revision		Revision as of 10:34, 29 April 2026
Line 438:		Line 438:

	== Function zombie ==		== Function zombie ==
	In non GAME states, the <code>zombie</code> function is mandatory. The first parameter <code>int $playerId</code> will be filled by the Zombified player id.		In non GAME states, the <code>zombie</code> function is mandatory. The first parameter <code>int $playerId</code> will be filled by the Zombified player id. If the first parameter is called <code>int $playerNo</code> / <code>int $player_no</code>, it will send the player no instead of the player id.

	You can see some examples in the [[Zombie Mode]] page.		You can see some examples in the [[Zombie Mode]] page.

Thoun: /* Functions act* */

2026-04-29T08:25:01Z

Functions act*

← Older revision		Revision as of 10:25, 29 April 2026
Line 390:		Line 390:
	* <code>array $args</code> will be filled by the result of $this->getArgs().		* <code>array $args</code> will be filled by the result of $this->getArgs().
	* <code>int $activePlayerId</code> (or <code>int $active_player_id</code>) will be filled by the id of the active player (not necessarily the one triggering the action!). 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 (not necessarily the one triggering the action!). 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 (not necessarily the one triggering the action!). To be used on ACTIVE_PLAYER states only.
	* <code>int $currentPlayerId</code> (or <code>int $current_player_id</code>) will be filled by the id of the player who triggered the action.		* <code>int $currentPlayerId</code> (or <code>int $current_player_id</code>) will be filled by the id of the player who triggered the action.
			* <code>int $currentPlayerNo</code> (or <code>int $current_player_no</code>) will be filled by the no of the player who triggered the action.

	The return value works the same way as onEnteringState.		The return value works the same way as onEnteringState.

Thoun: /* Function onEnteringState */

2026-04-29T08:24:09Z

Function onEnteringState

← Older revision		Revision as of 10:24, 29 April 2026
Line 335:		Line 335:
	* <code>array $args</code> will be filled by the result of $this->getArgs().		* <code>array $args</code> will be filled by the result of $this->getArgs().
	* <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 $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 PRIVATE state. To be used on PRIVATE 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 PRIVATE state. To be used on 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 id of the current PRIVATE state. To be used on PRIVATE states only.

	This function can do state redirection by returning a value :		This function can do state redirection by returning a value :

Thoun: /* Function getArgs */

2026-04-29T08:23:13Z

Function getArgs

← Older revision		Revision as of 10:23, 29 April 2026
Line 272:		Line 272:

	* <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 $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 PRIVATE state. To be used on PRIVATE 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 PRIVATE state. To be used on 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 PRIVATE state. To be used on PRIVATE states only.

	==== Private info in args ====		==== Private info in args ====

Thoun: /* Function getArgs */

2026-04-08T09:23:58Z

Function getArgs

← Older revision		Revision as of 11:23, 8 April 2026
Line 283:		Line 283:
	<pre>		<pre>
	function getArgs(int $activePlayerId): array {		function getArgs(int $activePlayerId): array {
	return ~~array(~~		return [
	'_private' => ~~array(~~ // all data inside this array will be private		'_private' => [ // all data inside this array will be private
	$activePlayerId => ~~array(~~ // will be sent only to that player		$activePlayerId => [ // will be sent only to that player
	'somePrivateData' => $this->getSomePrivateData($activePlayerId)		'somePrivateData' => $this->getSomePrivateData($activePlayerId)
	)		]
	),		],

	'possibleMoves' => $this->getPossibleMoves() // will be sent to all players		'possibleMoves' => $this->getPossibleMoves() // will be sent to all players
	);		];
	}		}
	</pre>		</pre>
Line 297:		Line 297:

	IMPORTANT: in certain situations (i.e. MULTIPLE_ACTIVE_PLAYER game state) these "private data" features can have a significant impact on performance. Please do not use if not needed.		IMPORTANT: in certain situations (i.e. MULTIPLE_ACTIVE_PLAYER game state) these "private data" features can have a significant impact on performance. Please do not use if not needed.

			If you add <code>_merge_private => true</code> next to <code>_private</code>, the private informations will be accessible in `args.args` instead of `args.args._private`.
			If you want all your <code>_private</code> objects to be merged (state args and notif args), call <code>$this->bga->notify->alwaysMergePrivate();</code> in your Game constructor instead of adding the <code>_merge_private</code> flag on each arg.

	==== Flag to indicate a skipped state ====		==== Flag to indicate a skipped state ====

Thoun: /* Implementation Notes */

2026-03-11T09:52:07Z

Implementation Notes

← Older revision		Revision as of 11:52, 11 March 2026
Line 456:		Line 456:
	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.		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.

			=== Creating subfolders in the States folder ===
			When creating Classes in subfolders of the States folder, don't forget to make the namespace reflect the subfolders structure for autoloading to work.

	=== Private parallel states ===		=== Private parallel states ===
Line 586:		Line 587:

	[[File:Eurogamestates.png]]		[[File:Eurogamestates.png]]





	== Migrating for states written in states.inc.php and Game.php ==		== Migrating for states written in states.inc.php and Game.php ==

Victoria La: /* Function onEnteringState */

2025-12-30T00:02:13Z

Function onEnteringState

← Older revision		Revision as of 02:02, 30 December 2025
Line 334:		Line 334:
	This function can do state redirection by returning a value :		This function can do state redirection by returning a value :

	* a class name~~: <code>return NextPlayer::class</code>~~ will redirect to the state declared in that class.		* a class name will redirect to the state declared in that class
	* a state id~~: <code>return ST_END_GAME;</code> = <code>return 99;</code>~~ will redirect to the state of that id. It must be typed as int, numbers in a string won't work.		return NextPlayer::class;
	* a transition name~~: <code>return 'nextPlayer';</code>~~ will redirect to the transition of that name (requires <code>transitions</code> to be declared in the constructor).		* a state id will redirect to the state of that id. It must be typed as int, numbers in a string won't work.
			return StateConstants::ST_END_GAME;
			or
			return 99;
			* a transition name will redirect to the transition of that name (requires <code>transitions</code> to be declared in the constructor).
			return 'nextPlayer';




	~~"action" specifies a PHP method to call when entering this game state.~~

	Example:		Example:
Line 367:		Line 370:
	return; // no value		return; // no value
	}		}
	</pre>'''Warning''': ~~Prevent to do anything on~~ stGameEnd() and argGameEnd() in Game.php. It may cause game never end and always stuck in "Recording game results + computing statistics in progress...".		</pre>

			'''Warning''': Do not override stGameEnd() and argGameEnd() in Game.php. It may cause game never end and always stuck in "Recording game results + computing statistics in progress...".

	== Functions act* ==		== Functions act* ==

Victoria La: /* Difference between Single active and Multi active states */

2025-12-29T22:25:59Z

Difference between Single active and Multi active states

← Older revision		Revision as of 00:25, 30 December 2025
Line 561:		Line 561:

	* You can (and must) change the active players DURING the state		* You can (and must) change the active players DURING the state
	* During such a state, players can be activated/~~desactivated~~ anytime during the state, giving you the maximum of possibilities.		* During such a state, players can be activated/deactivated anytime during the state, giving you the maximum of possibilities.
	* You shouldn't set active player before entering the state. But you can set it in "state initializer" php function (see example above stMultiPlayerInit)		* You shouldn't set active player before entering the state. But you can set it in "state initializer" php function (see example above stMultiPlayerInit)
	* Finally, during onEnteringState, on JS side, the active players are NOT active yet so you must use onUpdateActionButtons to perform the client side operation which depends on a player active/inactive status.		* Finally, during onEnteringState, on JS side, the active players are NOT active yet so you must use onUpdateActionButtons to perform the client side operation which depends on a player active/inactive status.

Victoria La: /* Using Named Constants for States */

2025-12-29T22:25:33Z

Using Named Constants for States

@@ Line 537: / Line 537: @@
      const STATE_END_GAME = 99;
+}
 </pre>

Victoria La: /* Name Parameters of Game State constructor */

2025-12-29T22:22:08Z

Name Parameters of Game State constructor

← Older revision		Revision as of 00:22, 30 December 2025
Line 80:		Line 80:


	~~The keys determine~~ game state ~~IDs~~ (in the example above: 2).		This key determines game the state numeric identifier (aka ID) (in the example above: 2).

	~~IDs~~ must be positive ~~integers~~.		It must be positive integer and unique between all your states (i.e. you must not use the same ID twice).

	~~ID=~~1 is reserved for the first game state and should not be used (and you must not modify it).		Number 1 is reserved for the first game state and should not be used (and you must not modify it).

	~~ID=~~99 is reserved for the last game state (end of the game) (and you must not modify it).		Number 99 is reserved for the last game state (end of the game) (and you must not modify it).

	Note: you may use any ID, even an ID greater than 100. But you cannot use 1 or 99.		Note: you may use any ID, even an ID greater than 100. But you cannot use 1 or 99.

	Note²~~: You must not use the same ID twice.~~		Note²: When a game is in prod and you change the ID of a state, all active games (including many turn based) will behave unpredictably.

	~~Note³~~: When a game is in prod and you change the ID of a state, all active games (including many turn based) will behave unpredictably.


Line 99:		Line 97:

	You can use 4 types of game states:		You can use 4 types of game states:
	* StateType::ACTIVE_PLAYER : 1 player is active and must play. ('activeplayer' if using the old array notation)		* StateType::ACTIVE_PLAYER: One player is active and must play ('activeplayer' if using the old array notation).
	* StateType::MULTIPLE_ACTIVE_PLAYER : ~~1..N~~ players can be active and must play. ('multipleactiveplayer' if using the old array notation)		* StateType::MULTIPLE_ACTIVE_PLAYER: Multiple players can be active and must play ('multipleactiveplayer' if using the old array notation).
	* StateType::PRIVATE ~~(during~~ multiactive states players can independently move to different private parallel states. ('private' if using the old array notation) See more details [[#Private_parallel_states\|here]].		* StateType::PRIVATE: During multiactive states players can independently move to different private parallel states ('private' if using the old array notation). See more details [[#Private_parallel_states\|here]].
	* StateType::GAME (No player is active. This is a transitional state to do something automatic specified by the game rules.) ('game' if using the old array notation)		* StateType::GAME: No player is active. This is a transitional state to do something automatic specified by the game rules ('game' if using the old array notation).

	=== name ===		=== name ===


	The name of a game state is used to identify it in your game logic. Default: class name (as is).		The name of a game state is used to identify the state in your game logic. Default: class name (as is).

	Several game states can share the same name; however, this is not recommended.		Several game states can share the same name; however, this is not recommended.

	Warning! Do not put spaces in the name. This could cause unexpected problems ~~in some cases~~.		Warning! Do not put spaces and other weird characters in the name (i.e. stick to identifier). This could cause unexpected problems.

	PHP example:		PHP example: