Your game state machine: states.inc.php - História úprav

Rudolf: /* args */ argPlayerTurn instead argPlaceWorker :)

2013-05-05T21:14:19Z

args: argPlayerTurn instead argPlaceWorker :)

← Staršia verzia		Verzia z 23:14, 5. máj 2013
Riadok 269:		Riadok 269:
	</pre>		</pre>

	It corresponds to a ~~« argPlaceWorkers »~~ method in our PHP code (reversi.game.php):		It corresponds to a « argPlayerTurn » method in our PHP code (reversi.game.php):
	<pre>		<pre>
	function argPlayerTurn()		function argPlayerTurn()

Pikiou: /* args */ returned value from the arg function must be an associative array

2013-04-05T02:46:37Z

args: returned value from the arg function must be an associative array

← Staršia verzia		Verzia z 04:46, 5. apríl 2013
Riadok 252:		Riadok 252:
	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 get some piece of information about the game (ex : for Reversi, the possible moves) and return them.

	Thus, this data can be transmitted to the clients and used by the clients to display 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.

	Let's see a complete example using args with « Reversi » game :		Let's see a complete example using args with « Reversi » game :

Sourisdudesert: /* args */

2013-03-28T17:34:44Z

args

← Staršia verzia		Verzia z 19:34, 28. marec 2013
Riadok 259:		Riadok 259:
	<pre>		<pre>
	10 => array(		10 => array(
	"name" => "~~placeWorkers~~",		"name" => "playerTurn",
	"description" => clienttranslate('${actplayer} must ~~place some workers~~'),		"description" => clienttranslate('${actplayer} must play a disc'),
	"descriptionmyturn" => clienttranslate('${you} must ~~place some workers~~'),		"descriptionmyturn" => clienttranslate('${you} must play a disc'),
	"type" => "activeplayer",		"type" => "activeplayer",
	"args" => "~~argPlaceWorkers~~", <================================== HERE		"args" => "argPlayerTurn", <================================== HERE
	"possibleactions" => array( ~~"placeWorkers"~~ ),		"possibleactions" => array( 'playDisc' ),
	"transitions" => array( "~~nextPlayer~~" => 11~~, "nextPhase" => 12~~, "zombiePass" => 11 )		"transitions" => array( "playDisc" => 11, "zombiePass" => 11 )
	),		),
	</pre>		</pre>

Tirix: Corrected 'arg'=>'args'

2013-03-23T10:33:02Z

Corrected 'arg'=>'args'

← Staršia verzia		Verzia z 12:33, 23. marec 2013
Riadok 110:		Riadok 110:
	In the description string, you can use ${actplayer} to refer to the active player.		In the description string, you can use ${actplayer} to refer to the active player.

	You can also use custom arguments in your description. These custom arguments correspond to values returned by your "~~arg~~" PHP method (see below "~~arg~~" field).		You can also use custom arguments in your description. These custom arguments correspond to values returned by your "args" PHP method (see below "args" field).

	Example of custom field:		Example of custom field:
Riadok 117:		Riadok 117:
	In states.inc.php:		In states.inc.php:
	"description" => clienttranslate('${actplayer} must choose ${nbr} identical energies'),		"description" => clienttranslate('${actplayer} must choose ${nbr} identical energies'),
	"~~arg~~" => "argMyArgumentMethod"		"args" => "argMyArgumentMethod"

	In mygame.game.php:		In mygame.game.php:

Sourisdudesert: /* args */

2013-01-11T14:16:16Z

args

@@ Riadok 263: / Riadok 263: @@
          "descriptionmyturn" => clienttranslate('${you} must place some workers'),
          "type" => "activeplayer",
-         '''"args" => "argPlaceWorkers",'''
+         "args" => "argPlaceWorkers",    <================================== HERE
          "possibleactions" => array( "placeWorkers" ),
          "transitions" => array( "nextPlayer" => 11, "nextPhase" => 12, "zombiePass" => 11 )
      ),
 </pre>
 === updateGameProgression ===

Sourisdudesert: /* possibleactions */

2013-01-11T14:13:58Z

possibleactions

← Staršia verzia		Verzia z 16:13, 11. január 2013
Riadok 239:		Riadok 239:

	</pre>		</pre>

			=== args ===

			(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.

			Example 1 : for Reversi, the list of possible moves during 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 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.

			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.

			Thus, this data can be transmitted to the clients and used by the clients to display it.

			Let's see a complete example using args with « Reversi » game :

			In states.inc.php, we specify some « args » argument for gamestate « playerTurn » :
			<pre>
			10 => array(
			"name" => "placeWorkers",
			"description" => clienttranslate('${actplayer} must place some workers'),
			"descriptionmyturn" => clienttranslate('${you} must place some workers'),
			"type" => "activeplayer",
			'''"args" => "argPlaceWorkers",'''
			"possibleactions" => array( "placeWorkers" ),
			"transitions" => array( "nextPlayer" => 11, "nextPhase" => 12, "zombiePass" => 11 )
			),
			</pre>
			=== updateGameProgression ===

			(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.

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

Sourisdudesert: /* possibleactions */

2013-01-11T14:08:14Z

possibleactions

← Staršia verzia		Verzia z 16:08, 11. január 2013
Riadok 233:		Riadok 233:
	playCard: function( ... )		playCard: function( ... )
	{		{
	if( this.checkAction( "playCard" ) )		if( this.checkAction( "playCard" ) ) // Will failed if "playCard" is not specified in "possibleactions" in current game state.
	{ return ; }		{ return ; }

Sourisdudesert: /* transitions */

2013-01-11T14:07:59Z

transitions

@@ Riadok 173: / Riadok 173: @@
 === transitions ===
 With "transition" you specify in which game state you can jump from a given game state.
@@ Riadok 204: / Riadok 206: @@
 In mygame.game.php:
      $this->gamestate->nextState(  );     // We don't need to specify a transition as there is only one here
 </pre>

Sourisdudesert: /* action */

2013-01-11T14:02:57Z

action

← Staršia verzia		Verzia z 16:02, 11. január 2013
Riadok 171:		Riadok 171:

	Note: a BGA convention specify that PHP method called with "action" are prefixed by "st".		Note: a BGA convention specify that PHP method called with "action" are prefixed by "st".

			=== transitions ===

			With "transition" you specify in which game state you can jump from a given game state.

			Example:
			<pre>
			25 => array(
			"name" => "myGameState",
			"transitions" => array( "nextPlayer" => 27, "endRound" => 39 ),
			....
			}
			</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.

			Example to jump to ID 27:
			<pre>
			In mygame.game.php:
			$this->gamestate->nextState( "nextPlayer" );
			</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.

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

			Example:
			<pre>
			In states.inc.php:
			"transitions" => array( "" => 27 ),

			In mygame.game.php:
			$this->gamestate->nextState( ); // We don't need to specify a transition as there is only one here
			</pre>

Sourisdudesert: /* id */

2013-01-11T13:52:19Z

← Staršia verzia		Verzia z 15:52, 11. január 2013
Riadok 49:		Riadok 49:

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

	Note²: You can't of course use the same ID twice.		Note²: You can't of course use the same ID twice.