Your game state machine: states.inc.php - Historial de revisións

Amadannabriona: /* Example of multipleactiveplayer state */

2018-09-15T17:33:55Z

Example of multipleactiveplayer state

← Revisión máis antiga		Revisión como estaba o 15 de setembro de 2018 ás 19:33
Liña 413:		Liña 413:
	}		}

	When ending the player action instead of state transition, deactivate player		When ending the player action, instead of a state transition, deactivate player.

	function action_playKeep($cardId) {		function action_playKeep($cardId) {
Liña 419:		Liña 419:
	$player_id = $this->getCurrentPlayerId(); // CURRENT!!! not active		$player_id = $this->getCurrentPlayerId(); // CURRENT!!! not active
	... // some logic here		... // some logic here
	$this->gamestate->setPlayerNonMultiactive($player_id, 'next'); // deactivate player, if ~~non~~ left transition to 'next' state		$this->gamestate->setPlayerNonMultiactive($player_id, 'next'); // deactivate player; if none left, transition to 'next' state
	}		}

Amadannabriona: /* Example of multipleactiveplayer state */

2018-09-15T17:32:26Z

Example of multipleactiveplayer state

← Revisión máis antiga		Revisión como estaba o 15 de setembro de 2018 ás 19:32
Liña 394:		Liña 394:
	=== Example of multipleactiveplayer state ===		=== Example of multipleactiveplayer state ===

	This is example of multipleactiveplayer state		This is an example of a multipleactiveplayer state:

	2 => array (		2 => array (
Liña 408:		Liña 408:

	In game.php:		In game.php:
	// this will make all ~~player~~ multiactive just before entering the state		// this will make all players multiactive just before entering the state
	function st_MultiPlayerInit() {		function st_MultiPlayerInit() {
	$this->gamestate->setAllPlayersMultiactive();		$this->gamestate->setAllPlayersMultiactive();

Amadannabriona: /* Using Named Constants for States */

2018-09-15T17:31:33Z

Using Named Constants for States

← Revisión máis antiga		Revisión como estaba o 15 de setembro de 2018 ás 19:31
Liña 367:		Liña 367:
	<pre>		<pre>
	// define contants for state ids		// define contants for state ids
	if (!defined('STATE_END_GAME')) { // ~~guard~~ since ~~this~~ is included multiple times		if (!defined('STATE_END_GAME')) { // ensure this block is only invoked once, since it is included multiple times
	define("STATE_PLAYER_TURN", 2);		define("STATE_PLAYER_TURN", 2);
	define("STATE_GAME_TURN", 3);		define("STATE_GAME_TURN", 3);

Amadannabriona: /* Using Named Constants for States */

2018-09-15T17:29:49Z

Using Named Constants for States

← Revisión máis antiga		Revisión como estaba o 15 de setembro de 2018 ás 19:29
Liña 367:		Liña 367:
	<pre>		<pre>
	// define contants for state ids		// define contants for state ids
	if (!defined('STATE_END_GAME')) { // guard since this included multiple times		if (!defined('STATE_END_GAME')) { // guard since this is included multiple times
	define("STATE_PLAYER_TURN", 2);		define("STATE_PLAYER_TURN", 2);
	define("STATE_GAME_TURN", 3);		define("STATE_GAME_TURN", 3);

Amadannabriona: /* Using Named Constants for States */

2018-09-15T17:29:13Z

Using Named Constants for States

← Revisión máis antiga		Revisión como estaba o 15 de setembro de 2018 ás 19:29
Liña 358:		Liña 358:
	=== Using Named Constants for States ===		=== Using Named Constants for States ===

	Using numeric ~~constant~~ is prone to errors~~, if~~ you want you can declare state constants as PHP named constants~~, this~~ way you can		Using numeric constants is prone to errors. If you want you can declare state constants as PHP named constants. This way you can
	use them in states file and game.php as well		use them in the states file and in game.php as well

			EXAMPLE:

	states.inc.php:		states.inc.php:

Amadannabriona: /* updateGameProgression */

2018-09-15T17:28:14Z

updateGameProgression

← Revisión máis antiga		Revisión como estaba o 15 de setembro de 2018 ás 19:28
Liña 349:		Liña 349:
	(optional)		(optional)

	IF you specify "updateGameProgression => true" in a game state, your "getGameProgression" PHP method will be called at the beginning of this game state - and thus the game progression of the game will be updated.		If you specify "updateGameProgression => true" in a game state, your "getGameProgression" PHP method will be called at the beginning of this game state - and thus the game progression of the game will be updated.

	At least one of your game ~~state~~ (any ~~of them~~) must specify updateGameProgression=>true.		''At least one'' of your game states (any one) must specify "updateGameProgression=>true".

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

Amadannabriona: /* Private infos in args */

2018-09-15T17:27:19Z

Private infos in args

← Revisión máis antiga		Revisión como estaba o 15 de setembro de 2018 ás 19:27
Liña 301:		Liña 301:
	'''Warning''': the "args" method can be called before the "action" method so don't expect data modifications by the "action" method to be available in the "args" method!		'''Warning''': the "args" method can be called before the "action" method so don't expect data modifications by the "action" method to be available in the "args" method!

	==== Private ~~infos~~ in args ====		==== Private info in args ====

	By default, all data provided through this method are PUBLIC TO ALL PLAYERS. Please do not send any private data with this method, as a cheater could see it even it is not used explicitly by the game interface logic.		By default, all data provided through this method are PUBLIC TO ALL PLAYERS. Please do not send any private data with this method, as a cheater could see it even it is not used explicitly by the game interface logic.

Amadannabriona: /* args */

2018-09-15T17:27:04Z

args

← Revisión máis antiga		Revisión como estaba o 15 de setembro de 2018 ás 19:27
Liña 247:		Liña 247:
	(optional)		(optional)

	~~From time to time,~~ it happens that you need some information on the client side (~~ie : for~~ your game interface) only for a specific game state.		Sometimes it happens that you need some information on the client side (i.e., for your game interface) only for a specific game state.

	Example 1 : ~~for~~ Reversi, the list of possible moves during playerTurn state.		Example 1 : in ''Reversi'', the list of possible moves during the playerTurn state.
	Example 2 : in Caylus, the number of remaining king's ~~favor~~ to choose in the state where the player is choosing a favor.		Example 2 : in ''Caylus'', the number of remaining king's favors to choose in the state where the player is choosing a favor.
	Example 3 : in Can't ~~stop~~, the list of possible die ~~combination~~ to be displayed to the active player ~~in order~~ he can choose among them.		Example 3 : in ''Can't Stop'', the list of possible die combinations to be displayed to the active player so that he can choose from among them.

	In such a situation, you can specify a method name as the « args » argument for your game state. This method must ~~get~~ some piece of information about the game (ex : for Reversi, the possible moves) and return ~~them~~.		In such a situation, you can specify a method name as the « args » argument for your game state. This method must retrieve some piece of information about the game (example: for ''Reversi'', the list of possible moves) and return it.

	Thus, this data can be transmitted to the clients and used by the clients to display it. It should always be an associative array.		Thus, this data can be transmitted to the clients and used by the clients to display it. It should always be an associative array.
Liña 259:		Liña 259:
	Let's see a complete example using args with « Reversi » game :		Let's see a complete example using args with « Reversi » game :

	In states.inc.php, we specify ~~some~~ « args » argument for gamestate « playerTurn » :		In states.inc.php, we specify an « args » argument for gamestate « playerTurn » :
	<pre>		<pre>
	10 => array(		10 => array(
Liña 281:		Liña 281:
	</pre>		</pre>

	Then, when we enter into « playerTurn » game state on the client side, we can highlight the possible moves on the board using information returned by argPlayerTurn :		Then, when we enter into the « playerTurn » game state on the client side, we can highlight the possible moves on the board using information returned by argPlayerTurn :

	<pre>		<pre>
Liña 297:		Liña 297:
	Note: you can also use values returned by your "args" method to have some custom values in your "description"/"descriptionmyturn" (see above).		Note: you can also use values returned by your "args" method to have some custom values in your "description"/"descriptionmyturn" (see above).

	Note: as a BGA convention, PHP methods called with "args" are prefixed by "arg" (ex: argPlayerTurn).		Note: as a BGA convention, PHP methods called with "args" are prefixed by "arg" (example: argPlayerTurn).

	Warning: the "args" method can be called before the "action" method so don't expect data modifications by the "action" method to be available in the "args" method!		'''Warning''': the "args" method can be called before the "action" method so don't expect data modifications by the "action" method to be available in the "args" method!

	==== Private infos in args ====		==== Private infos in args ====
Liña 305:		Liña 305:
	By default, all data provided through this method are PUBLIC TO ALL PLAYERS. Please do not send any private data with this method, as a cheater could see it even it is not used explicitly by the game interface logic.		By default, all data provided through this method are PUBLIC TO ALL PLAYERS. Please do not send any private data with this method, as a cheater could see it even it is not used explicitly by the game interface logic.

	~~This~~ is ~~although~~ possible to specify that some data should be sent to ~~some~~ specific players only:		However, it is possible to specify that some data should be sent to specific players only.

	Example 1: send an information to active player(s) only:		Example 1: send information to active player(s) only:

	<pre>		<pre>
Liña 319:		Liña 319:
	),		),

	'possibleMoves' => self::getPossibleMoves() // will be ~~send~~ to all players		'possibleMoves' => self::getPossibleMoves() // will be sent to all players
	);		);
	}		}
Liña 326:		Liña 326:
	Inside the js file, these variables will be available through `args._private`. (e.g. `args._private.somePrivateData` -- it is not `args._private.active.somePrivateData` nor is it `args.somePrivateData`)		Inside the js file, these variables will be available through `args._private`. (e.g. `args._private.somePrivateData` -- it is not `args._private.active.somePrivateData` nor is it `args.somePrivateData`)

	Example 2: send an information to a specific player (<specific_player_id>) only:		Example 2: send information to a specific player (<specific_player_id>) only:

	<pre>		<pre>
Liña 333:		Liña 333:
	'_private' => array( // Using "_private" keyword, all data inside this array will be made private		'_private' => array( // Using "_private" keyword, all data inside this array will be made private

	<specific_player_id> => array( // ~~you~~ select one specific player ~~with its~~ id		<specific_player_id> => array( // select one specific player by id
	'somePrivateData' => self::getSomePrivateData() // will be ~~send~~ only to <specific_player_id>		'somePrivateData' => self::getSomePrivateData() // will be sent only to <specific_player_id>
	)		)
	),		),

	'possibleMoves' => self::getPossibleMoves() // will be ~~send~~ to all players		'possibleMoves' => self::getPossibleMoves() // will be sent to all players
	);		);
	}		}
	</pre>		</pre>

	IMPORTANT: in certain ~~situation~~ (ex: multipleactiveplayer game state) these "private data" features can have a ~~big~~ performance ~~impact~~. Please do not use if not needed.		IMPORTANT: in certain situations (example: "multipleactiveplayer" game state) these "private data" features can have a significant impact on performance. Please do not use if not needed.

	=== updateGameProgression ===		=== updateGameProgression ===

Amadannabriona: /* possibleactions */

2018-09-15T17:13:48Z

possibleactions

← Revisión máis antiga		Revisión como estaba o 15 de setembro de 2018 ás 19:13
Liña 216:		Liña 216:
	=== possibleactions ===		=== possibleactions ===

	(~~mandatory for~~ "activeplayer" ~~and~~ "multipleactiveplayer" ~~game states~~)		('''Mandatory''' when the game state is "activeplayer" or "multipleactiveplayer")

	"possibleactions" defines the actions possible by the players at this game state.		"possibleactions" defines the actions possible by the players in this game state, and ensures they cannot cannot perform actions that are not allowed in this state.

	~~By defining "possibleactions"~~, ~~you make sure players can't do~~ actions that ~~they~~ are not allowed ~~to do at~~ this ~~game states~~.

	Example:		Example:
Liña 231:		Liña 229:
	function playCard( ...)		function playCard( ...)
	{		{
	self::checkAction( "playCard" ); // Will ~~failed~~ if "playCard" is not specified in "possibleactions" in current game state.		self::checkAction( "playCard" ); // Will fail if "playCard" is not specified in "possibleactions" in the current game state.

	....		....
Liña 238:		Liña 236:
	playCard: function( ... )		playCard: function( ... )
	{		{
	if( this.checkAction( "playCard" ) ) // Will ~~failed~~ if "playCard" is not specified in "possibleactions" in current game state.		if( this.checkAction( "playCard" ) ) // Will fail if "playCard" is not specified in "possibleactions" in the current game state.
	{ return ; }		{ return ; }

Amadannabriona: /* transitions */

2018-09-15T17:11:07Z

transitions

← Revisión máis antiga		Revisión como estaba o 15 de setembro de 2018 ás 19:11
Liña 180:		Liña 180:
	=== transitions ===		=== transitions ===

	(~~mandatory~~)		('''Mandatory''')

	With "~~transition~~" you specify in which game state you can jump from a given game state.		With "transitions" you specify which game state(s) you can jump to from a given game state.

	Example:		Example:
Liña 193:		Liña 193:
	</pre>		</pre>

	In the example above, if "myGameState" is the current active game state, I can jump to game state with ID 27, or game state with ID 39.		In the example above, if "myGameState" is the current active game state, I can jump to the game state with ID 27 or the game state with ID 39.

	Example to jump to ID 27:		Example to jump to ID 27:
Liña 201:		Liña 201:
	</pre>		</pre>

	Important: "nextPlayer" is the name of the transition, and NOT the name of the target game state. ~~Several~~ transitions can lead to the same game state.		Important: "nextPlayer" is the name of the transition, and NOT the name of the target game state. Multiple transitions can lead to the same game state.

	Note: ~~if you have~~ only 1 transition, you may give it an empty name.		Note: If there is only 1 transition, you may give it an empty name.

	Example:		Example:
Liña 213:		Liña 213:
	$this->gamestate->nextState( ); // We don't need to specify a transition as there is only one here		$this->gamestate->nextState( ); // We don't need to specify a transition as there is only one here
	</pre>		</pre>


	=== possibleactions ===		=== possibleactions ===