Your game state machine: states.inc.php - Versiju hronoloģija

Pikiou: /* id */ potential crash on active games when ID is changed

2014-06-18T23:04:42Z

id: potential crash on active games when ID is changed

← Senāka versija		Versija, kas saglabāta 2014. gada 19. jūnijs, plkst. 01.04
51. rindiņa:		51. rindiņa:

	Note²: You can't of course use the same ID twice.		Note²: You can't of course 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.

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

Archduke: /* Private infos in args */

2014-06-16T09:38:51Z

Private infos in args

← Senāka versija		Versija, kas saglabāta 2014. gada 16. jūnijs, plkst. 11.38
322. rindiņa:		322. rindiņa:
	}		}
	</pre>		</pre>

			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 an information to a specific player (<specific_player_id>) only:

Sourisdudesert: /* args */

2014-01-06T09:09:19Z

args

@@ 295. rindiņa: / 295. rindiņa: @@
 </pre>
-Note: you can also used 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).
 === updateGameProgression ===

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

2013-05-05T21:14:19Z

args: argPlayerTurn instead argPlaceWorker :)

← Senāka versija		Versija, kas saglabāta 2013. gada 5. maijs, plkst. 23.14
269. rindiņa:		269. rindiņa:
	</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

← Senāka versija		Versija, kas saglabāta 2013. gada 5. aprīlis, plkst. 04.46
252. rindiņa:		252. rindiņa:
	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

← Senāka versija		Versija, kas saglabāta 2013. gada 28. marts, plkst. 19.34
259. rindiņa:		259. rindiņa:
	<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'

← Senāka versija		Versija, kas saglabāta 2013. gada 23. marts, plkst. 12.33
110. rindiņa:		110. rindiņa:
	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:
117. rindiņa:		117. rindiņa:
	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

@@ 263. rindiņa: / 263. rindiņa: @@
          "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

← Senāka versija		Versija, kas saglabāta 2013. gada 11. janvāris, plkst. 16.13
239. rindiņa:		239. rindiņa:

	</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

← Senāka versija		Versija, kas saglabāta 2013. gada 11. janvāris, plkst. 16.08
233. rindiņa:		233. rindiņa:
	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 ; }