Your game state machine: states.inc.php - Гісторыя версій

Salty-horse: /* args */ Fix typo

2020-10-09T19:58:01Z

args: Fix typo

← Папярэдн. версія		Версія ад 19:58, 9 кастрычніка 2020
Радок 347:		Радок 347:
	Also don't modify database in this method!		Also don't modify database in this method!

	You should NOT be calling getCurrentPlayer() in the context of this function, since state transitions are broadcasted to all player independent of who initiated it. Instead you should send information on per player basis (Note: if this is private info see ~~seciton~~ below).		You should NOT be calling getCurrentPlayer() in the context of this function, since state transitions are broadcasted to all player independent of who initiated it. Instead you should send information on per player basis (Note: if this is private info see section below).

	If you using this function in multi-player state, you should not call getActivePlayer() either, you should send per player info:		If you using this function in multi-player state, you should not call getActivePlayer() either, you should send per player info:

Victoria La: /* Example of multipleactiveplayer state */

2020-10-03T01:35:07Z

Example of multipleactiveplayer state

← Папярэдн. версія		Версія ад 01:35, 3 кастрычніка 2020
Радок 493:		Радок 493:
	$this->gamestate->setAllPlayersMultiactive();		$this->gamestate->setAllPlayersMultiactive();
	}		}

			Note: if you want exact this function its already defined in table class its called 'stMakeEveryoneActive'

	When ending the player action, instead of a state transition, deactivate player.		When ending the player action, instead of a state transition, deactivate player.
Радок 502:		Радок 504:
	$this->gamestate->setPlayerNonMultiactive($player_id, 'next'); // deactivate player; if none left, transition to 'next' state		$this->gamestate->setPlayerNonMultiactive($player_id, 'next'); // deactivate player; if none left, transition to 'next' state
	}		}


	=== Diffrence between Single active and Multi active states ===		=== Diffrence between Single active and Multi active states ===

Salty-horse: /* args */ Fix typo

2020-09-28T21:06:16Z

args: Fix typo

← Папярэдн. версія		Версія ад 21:06, 28 верасня 2020
Радок 328:		Радок 328:
	</pre>		</pre>

	==== Naming and API ~~convetions~~ ====		==== Naming and API conventions ====

	As a BGA convention, PHP methods called with "args" are prefixed by "arg" followed by state name (example: '''argPlayerTurn''').		As a BGA convention, PHP methods called with "args" are prefixed by "arg" followed by state name (example: '''argPlayerTurn''').

Victoria La: /* args */

2020-09-03T00:51:47Z

args

← Папярэдн. версія		Версія ад 00:51, 3 верасня 2020
Радок 337:		Радок 337:
	Arg method MUST return array. Return integer or string will result in some undebugguggable exceptions.		Arg method MUST return array. Return integer or string will result in some undebugguggable exceptions.

	Arg method MUST be defined in php if it is declared in state description, if you don't need it comment it out from the states.php file (the '''args''' parameter). If you not sure if you need it or not you can keep it returning empty array until you figure it out.		Arg method MUST be defined in php if it is declared in state description, if you don't need it comment it out from the states.inc.php file (the '''args''' parameter). If you not sure if you need it or not you can keep it returning empty array until you figure it out.

	function argPlayerTurn() {		function argPlayerTurn() {
Радок 347:		Радок 347:
	Also don't modify database in this method!		Also don't modify database in this method!

	You should NOT be calling getCurrentPlayer() in the context of this function, since state transitions are ~~brodcased~~ to all player independent of who initiated it~~, instead~~ you should send information on per player basis (Note: if this is private info see seciton below).		You should NOT be calling getCurrentPlayer() in the context of this function, since state transitions are broadcasted to all player independent of who initiated it. Instead you should send information on per player basis (Note: if this is private info see seciton below).

	If you using this function in ~~multiplayer~~ state, you should not call getActivePlayer either, you should send per player info:		If you using this function in multi-player state, you should not call getActivePlayer() either, you should send per player info:

	function arg_playerTurn() {		function arg_playerTurn() {
Радок 362:		Радок 362:

	Note: you never need to send player color like this, this is just an example.		Note: you never need to send player color like this, this is just an example.

			Note 2: you CAN call methods that return all active players if multi-player states if its relevant.


	==== Other usages ====		==== Other usages ====

	You can ~~also~~ use values returned by your "args" method to have some custom values in your "description"/"descriptionmyturn", i.e in states.inc.php:		You can use values returned by your "args" method to have some custom values in your "description"/"descriptionmyturn", i.e. in states.inc.php:

	"descriptionmyturn" => clienttranslate('${you} must play ${color} disc'),		"descriptionmyturn" => clienttranslate('${you} must play ${color} disc'),
Радок 407:		Радок 409:
	<pre>		<pre>
	function argPlayerTurn() {		function argPlayerTurn() {
			$specific_player_id = ...; // calculate some-how
	return array(		return array(
	'_private' => array( // ~~Using "_private" keyword,~~ all data inside this array will be ~~made~~ private		'_private' => array( // all data inside this array will be private
			$specific_player_id => array( // will be sent only to that player
	$specific_player_id => array( // ~~select one specific~~ player ~~by id~~		'somePrivateData' => self::getSomePrivateData()
	'somePrivateData' => self::getSomePrivateData() ~~// will be sent only to that player~~
	)		)
	),		),

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

	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.		IMPORTANT: in certain situations (i.e. "multipleactiveplayer" game state) these "private data" features can have a significant impact on performance. Please do not use if not needed.

	It is also possible to use these private args in the "description" messages, like "${you} have to play ${_private.count} cards".		It is also possible to use these private args in the "description" messages, like "${you} have to play ${_private.count} cards".

Victoria La: /* args */

2020-09-03T00:45:41Z

args

← Папярэдн. версія		Версія ад 00:45, 3 верасня 2020
Радок 337:		Радок 337:
	Arg method MUST return array. Return integer or string will result in some undebugguggable exceptions.		Arg method MUST return array. Return integer or string will result in some undebugguggable exceptions.

	Arg method MUST be defined in php if it is declared in state description, if you don't need it ~~commit~~ it out from the states.php file (the '''args''' parameter). If you not sure if you need it or not you can keep it returning empty array until you figure it out.		Arg method MUST be defined in php if it is declared in state description, if you don't need it comment it out from the states.php file (the '''args''' parameter). If you not sure if you need it or not you can keep it returning empty array until you figure it out.

	function argPlayerTurn() {		function argPlayerTurn() {

Victoria La: Added more examples and corner cases

2020-09-03T00:44:17Z

Added more examples and corner cases

← Папярэдн. версія		Версія ад 00:44, 3 верасня 2020
Радок 290:		Радок 290:
	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.

	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 an ~~« args »~~ argument for gamestate ~~« playerTurn »~~ :		In states.inc.php, we specify an '''args''' argument for gamestate '''playerTurn''':
	<pre>		<pre>
	10 => array(		10 => array(
Радок 299:		Радок 299:
	"descriptionmyturn" => clienttranslate('${you} must play a disc'),		"descriptionmyturn" => clienttranslate('${you} must play a disc'),
	"type" => "activeplayer",		"type" => "activeplayer",
	"args" => "argPlayerTurn", <~~==============================~~==== HERE		"args" => "argPlayerTurn", // <==== HERE
	"possibleactions" => array( 'playDisc' ),		"possibleactions" => array( 'playDisc' ),
	"transitions" => array( "playDisc" => 11, "zombiePass" => 11 )		"transitions" => array( "playDisc" => 11, "zombiePass" => 11 )
Радок 305:		Радок 305:
	</pre>		</pre>

	It corresponds to a ~~« argPlayerTurn »~~ 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() {
	return array(		return array(
	'possibleMoves' => self::getPossibleMoves()		'possibleMoves' => self::getPossibleMoves()
Радок 314:		Радок 314:
	</pre>		</pre>

	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~~ :		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>
Радок 328:		Радок 328:
	</pre>		</pre>

	~~Note~~: ~~you can also use values returned by your~~ "~~args~~" method ~~to have~~ some ~~custom values~~ in ~~your "~~description~~"/"descriptionmyturn"~~ (~~see above~~).		==== Naming and API convetions ====

			As a BGA convention, PHP methods called with "args" are prefixed by "arg" followed by state name (example: '''argPlayerTurn''').

			All "arg*" methods are put into corresponding section of .game.php file commented as
			//////////// Game state arguments

			Arg method MUST return array. Return integer or string will result in some undebugguggable exceptions.

			Arg method MUST be defined in php if it is declared in state description, if you don't need it commit it out from the states.php file (the '''args''' parameter). If you not sure if you need it or not you can keep it returning empty array until you figure it out.

			function argPlayerTurn() {
			return array(); // must be an array
			}

	~~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!
			Also don't modify database in this method!

			You should NOT be calling getCurrentPlayer() in the context of this function, since state transitions are brodcased to all player independent of who initiated it, instead you should send information on per player basis (Note: if this is private info see seciton below).

			If you using this function in multiplayer state, you should not call getActivePlayer either, you should send per player info:

			function arg_playerTurn() {
			$res = array ();
			$players = $this->loadPlayersBasicInfos();
			foreach ( $players as $player_id => $player_info ) {
			$color = $player_info ['player_color'];
			$res [$player_id] = array("color"=>$color);
			}
			return $res;
			}

			Note: you never need to send player color like this, this is just an example.


			==== Other usages ====

			You can also use values returned by your "args" method to have some custom values in your "description"/"descriptionmyturn", i.e in states.inc.php:

			"descriptionmyturn" => clienttranslate('${you} must play ${color} disc'),

			So arg function will be something like:

			function argPlayerTurn() {
			return array('color'=>this->getActivePlayerColor());
			}

			You can use args also in '''onUpdateActionButtons''' function on js side, however two important notes:
			* it is just '''args''' (not args.args like in '''onEnteringState''')
			* it is args of the current state, which may not be state you think it will be! This method is called during change of active player, which happens in some weird place especially during "multipleactiveplayer" states. If you pulling your hair thinking why its "undefined" on js side - check the current state.

	==== Private info in args ====		==== Private info in args ====
Радок 346:		Радок 392:
	return array(		return array(
	'_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

	'active' => array( // Using "active" keyword inside "_private", you select active player(s)		'active' => array( // Using "active" keyword inside "_private", you select active player(s)
	'somePrivateData' => self::getSomePrivateData() // will be send only to active player(s)		'somePrivateData' => self::getSomePrivateData() // will be send only to active player(s)
	)		)
	),		),

	'possibleMoves' => self::getPossibleMoves() // will be sent to all players		'possibleMoves' => self::getPossibleMoves() // will be sent to all players
	);		);
Радок 366:		Радок 410:
	'_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( // select one specific player by id		$specific_player_id => array( // select one specific player by id
	'somePrivateData' => self::getSomePrivateData() // will be sent only to ~~<specific_player_id>~~		'somePrivateData' => self::getSomePrivateData() // will be sent only to that player
	)		)
	),		),

Victoria La: /* args */

2020-09-02T23:59:26Z

args

← Папярэдн. версія		Версія ад 23:59, 2 верасня 2020
Радок 280:		Радок 280:
	Sometimes it happens that you need some information on the client side (i.e., 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 : in ''Reversi'', the list of possible moves during the 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 favors to choose in the state where the player is choosing a favor.
	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.		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 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 retrieve some piece of information about the game (example: for ''Reversi'', the list of possible moves) and return it.		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.

Victoria La: /* action */

2020-08-16T21:36:31Z

action

← Папярэдн. версія		Версія ад 21:36, 16 жніўня 2020
Радок 161:		Радок 161:

	Example:		Example:
			In states.inc.php:
	<pre>		<pre>
	~~In states.inc.php:~~
	28 => array(		28 => array(
	"name" => "~~startPlayerTurn~~",		"name" => "gameTurnNextPlayer",
	"description" => '',		"description" => clienttranslate('Updating some stuff...'),
	"type" => "game",		"type" => "game",
	"action" => "~~stStartPlayerTurn~~",		"action" => "st_gameTurnNextPlayer",
			</pre>
	In mygame.game.php:		In mygame.game.php:
	function ~~stStartPlayerTurn~~()		<pre>
	{		function st_gameTurnNextPlayer() {
	~~// ... do something at the beginning of~~ this ~~game state~~		$player_id = $this->getActivePlayerId();
			$next_player_id = $this->getPlayerAfter($player_id);
			$this->giveExtraTime($next_player_id);
			$this->incStat(1, 'turns_number', $next_player_id);
			$this->incStat(1, 'turns_number');
			$this->gamestate->changeActivePlayer($next_player_id);
			$this->gamestate->nextState('next');
			}
	</pre>		</pre>

Радок 180:		Радок 187:

	Note: this field CAN be used for player states to set something up; e.g., for multiplayer states, it can make all players active.		Note: this field CAN be used for player states to set something up; e.g., for multiplayer states, it can make all players active.

			Example for action in player state:
			in states.inc.php:
			<pre>
			2 => array(
			"name" => "playerTurnPlace",
			"description" => clienttranslate('Other player must place ships'),
			"descriptionmyturn" => clienttranslate('${you} must place ships (click on YOUR SHIPS board to place)'),
			"type" => "multipleactiveplayer",
			'action' => 'st_MultiPlayerInit',
			'args' => 'arg_playerTurnPlace',
			"possibleactions" => array( "playPlace" ),
			"transitions" => array( "next" => 4, "last" => 99)
			),
			</pre>
			in mygame.game.php:
			<pre>
			function st_MultiPlayerInit() {
			$this->gamestate->setAllPlayersMultiactive();
			}
			</pre>

	=== transitions ===		=== transitions ===

Volker78: It was not clear, if using private-args in description messages are ok, but it seems so after testing.

2020-07-13T19:33:41Z

It was not clear, if using private-args in description messages are ok, but it seems so after testing.

← Папярэдн. версія		Версія ад 19:33, 13 ліпеня 2020
Радок 347:		Радок 347:

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

			It is also possible to use these private args in the "description" messages, like "${you} have to play ${_private.count} cards".

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

Galeelox: /* Private info in args */

2020-05-25T12:25:16Z

Private info in args

← Папярэдн. версія		Версія ад 12:25, 25 мая 2020
Радок 327:		Радок 327:
	</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`)		Inside the js file, these variables will be available through `args.args._private`. (e.g. `args.args._private.somePrivateData` -- it is not `args._private.active.somePrivateData` nor is it `args.somePrivateData`)

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