Main game logic: yourgamename.game.php - Muutoshistoria

Sourisdudesert: /* File Structure */

2014-01-06T09:00:34Z

File Structure

← Vanhempi versio		Versio 6. tammikuuta 2014 kello 11.00
Rivi 13:		Rivi 13:
	* Utility functions: your utility functions.		* Utility functions: your utility functions.
	* Player actions: the entry points for players actions.		* Player actions: the entry points for players actions.
	* Game state arguments: methods to return additional data on specific game states.		* Game state arguments: methods to return additional data on specific game states ([http://en.doc.boardgamearena.com/Your_game_state_machine:_states.inc.php#args more info here]).
	* Game state actions: the logic to run when entering a new game state.		* Game state actions: the logic to run when entering a new game state ([http://en.doc.boardgamearena.com/Your_game_state_machine:_states.inc.php#action more info here]).
	* zombieTurn: what to do it's the turn of a zombie player.		* zombieTurn: what to do it's the turn of a zombie player.

Sourisdudesert: /* Player elimination */

2014-01-06T08:53:15Z

Player elimination

← Vanhempi versio		Versio 6. tammikuuta 2014 kello 10.53
Rivi 506:		Rivi 506:
	In some games, this is useful to eliminate a player from the game in order he/she can start another game without waiting for the current game end.		In some games, this is useful to eliminate a player from the game in order he/she can start another game without waiting for the current game end.

	This case should be rare. Please don't use player elimination feature if some player just has to wait the last 10% of the game for game end. This feature is		This case should be rare. Please don't use player elimination feature if some player just has to wait the last 10% of the game for game end. This feature should be used only in games where players are eliminated all along the game (typical examples: "Perudo" or "The Werewolves of Miller's Hollow").

			Usage:

			* Player to eliminate should NOT be active anymore (preferably use the feature in a "game" type game state).
			* In your PHP code:
			self::eliminatePlayer( <player_to_eliminate_id> );
			* the player is informed in a dialog box that he no longer have to played and can start another game if he/she wants too (whith buttons "stay at this table" "quit table and back to main site"). In any case, the player is free to tart&join another table from now.
			* When your game is over, all players who have been eliminated before receive a "notification" (the small "!" icon on the top right of the BGA interface) that indicate them that "the game has ended" and invite them to review the game results.

Sourisdudesert (6. tammikuuta 2014 kello 08.45)

2014-01-06T08:45:43Z

← Vanhempi versio		Versio 6. tammikuuta 2014 kello 10.45
Rivi 501:		Rivi 501:

	Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.		Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.

			== Player elimination ==

			In some games, this is useful to eliminate a player from the game in order he/she can start another game without waiting for the current game end.

			This case should be rare. Please don't use player elimination feature if some player just has to wait the last 10% of the game for game end. This feature is

Sourisdudesert: /* Manage player scores and Tie breaker */

2013-09-30T16:32:23Z

Manage player scores and Tie breaker

← Vanhempi versio		Versio 30. syyskuuta 2013 kello 18.32
Rivi 423:		Rivi 423:
	Tie breaker score is displayed only for players who are tied at the end of the game. Most of the time, it is not supposed to be displayed explicitly during the game.		Tie breaker score is displayed only for players who are tied at the end of the game. Most of the time, it is not supposed to be displayed explicitly during the game.

	When you are using "player_score_aux" functionality, you must describe the formula to use in your ~~Constructor method~~ like this:		When you are using "player_score_aux" functionality, you must describe the formula to use in your gameinfos.inc.php file like this:

	<pre>		<pre>
	~~$this->~~tie_breaker_description = ~~self::_~~("Describe here your tie breaker formula");		'tie_breaker_description' => totranslate("Describe here your tie breaker formula"),
	</pre>		</pre>

Sourisdudesert (22. toukokuuta 2013 kello 09.01)

2013-05-22T09:01:51Z

← Vanhempi versio		Versio 22. toukokuuta 2013 kello 11.01
Rivi 454:		Rivi 454:


	; throw new ~~BgaSystemVisibleException~~ ( $error_message)		; throw new BgaVisibleSystemException ( $error_message)
	: You must throw this exception when you detect something that is not supposed to happened into your code.		: You must throw this exception when you detect something that is not supposed to happened into your code.
	: The error message is shown to the user as an "Unexpected error", in order he can report it in the forum.		: The error message is shown to the user as an "Unexpected error", in order he can report it in the forum.
Rivi 496:		Rivi 496:
	}		}
	else		else
	throw new ~~BgaSystemVisibleException~~( "Zombie mode not supported at this game state: ".$statename );		throw new BgaVisibleSystemException( "Zombie mode not supported at this game state: ".$statename );
	}		}
	</pre>		</pre>

	Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.		Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.

Tilalilalou: /* Zombie mode */

2013-05-21T16:24:52Z

Zombie mode

← Vanhempi versio		Versio 21. toukokuuta 2013 kello 18.24
Rivi 496:		Rivi 496:
	}		}
	else		else
	throw new ~~feException~~( "Zombie mode not supported at this game state: ".$statename );		throw new BgaSystemVisibleException( "Zombie mode not supported at this game state: ".$statename );
	}		}
	</pre>		</pre>

	Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.		Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.

Pikiou: /* Game states and active players */ Precision on setPlayersMultiactive

2013-04-18T14:32:20Z

Game states and active players: Precision on setPlayersMultiactive

← Vanhempi versio		Versio 18. huhtikuuta 2013 kello 16.32
Rivi 259:		Rivi 259:
	; $this->gamestate->setPlayersMultiactive( $players, $next_state )		; $this->gamestate->setPlayersMultiactive( $players, $next_state )
	: Make a specific list of players active during a multiactive gamestate.		: Make a specific list of players active during a multiactive gamestate.
			: Bare in mind it doesn't deactivate other previously active players.
	: "players" is the array of player id that should be made active.		: "players" is the array of player id that should be made active.
	: In case "players" is empty, the method trigger the "next_state" transition to go to the next game state.		: In case "players" is empty, the method trigger the "next_state" transition to go to the next game state.

Sourisdudesert: /* Zombie mode */

2013-03-06T15:35:34Z

Zombie mode

← Vanhempi versio		Versio 6. maaliskuuta 2013 kello 17.35
Rivi 498:		Rivi 498:
	}		}
	</pre>		</pre>

			Note that in the example above, all corresponding game state should implement "zombiePass" as a transition.

Sourisdudesert: /* Zombie mode */

2013-03-06T15:35:02Z

Zombie mode

← Vanhempi versio		Versio 6. maaliskuuta 2013 kello 17.35
Rivi 472:		Rivi 472:

	Most of the time, the best thing to do when it is zombie player turn is to jump immediately to a state where he is not active anymore. For example, if he is in a game state where he has a choice between playing A and playing B, the best thing to do is NOT to choose A or B, but to pass. So, even if there's no "pass" action in the rules, add a "zombiepass" transitition in your game state and use it.		Most of the time, the best thing to do when it is zombie player turn is to jump immediately to a state where he is not active anymore. For example, if he is in a game state where he has a choice between playing A and playing B, the best thing to do is NOT to choose A or B, but to pass. So, even if there's no "pass" action in the rules, add a "zombiepass" transitition in your game state and use it.

			Each time a zombie player must play, your "zombieTurn" method is called.

			Parameters:
			* $state: the name of the current game state.
			* $active_player: the id of the active player.

			Most of the time, your zombieTurn method looks like this:

			<pre>
			function zombieTurn( $state, $active_player )
			{
			$statename = $state['name'];

			if( $statename == 'myFirstGameState'
			\|\| $statename == 'my2ndGameState'
			\|\| $statename == 'my3rdGameState'
			....
			)
			{
			$this->gamestate->nextState( "zombiePass" );
			}
			else
			throw new feException( "Zombie mode not supported at this game state: ".$statename );
			}
			</pre>

Sourisdudesert (6. maaliskuuta 2013 kello 15.32)

2013-03-06T15:32:43Z

← Vanhempi versio		Versio 6. maaliskuuta 2013 kello 17.32
Rivi 461:		Rivi 461:
	: Base class to notify a system exception. The message will be hidden from the user, but show in the logs. Use this if the message contains technical information.		: Base class to notify a system exception. The message will be hidden from the user, but show in the logs. Use this if the message contains technical information.
	: You shouldn't use this type of exception except if you think the information shown could be critical. Indeed: a generic error message will be shown to the user, so it's going to be difficult for you to see what happened.		: You shouldn't use this type of exception except if you think the information shown could be critical. Indeed: a generic error message will be shown to the user, so it's going to be difficult for you to see what happened.

			== Zombie mode ==

			When a player leaves a game for any reason (expelled, quit), he becomes a "zombie player". In this case, the results of the game won't count for statistics, but this is cool if the other players can finish the game anyway. That's why zombie mode exists: allow the other player to finish the game, even if the situation is not ideal.

			While developing your zombie mode, keep in mind that:
			* Do not refer to the rules, because this situation is not planned by the rules.
			* Try to figure that you are playing with your friends and one of them has to leave: how can we finish the game without killing the spirit of the game?
			* The idea is NOT to develop an artificial intelligence for the game.

			Most of the time, the best thing to do when it is zombie player turn is to jump immediately to a state where he is not active anymore. For example, if he is in a game state where he has a choice between playing A and playing B, the best thing to do is NOT to choose A or B, but to pass. So, even if there's no "pass" action in the rules, add a "zombiepass" transitition in your game state and use it.