Main game logic: yourgamename.game.php - Historial de revisió

Chaf: /* Use globals */

2015-05-18T20:10:03Z

Use globals

← Versió més antiga		Revisió del 22:10, 18 maig 2015
Línia 193:		Línia 193:
	This method is located at the beginning of your game logic. This is the place you defines the globals used in your game logic, by assigning them IDs.		This method is located at the beginning of your game logic. This is the place you defines the globals used in your game logic, by assigning them IDs.

	You can define up to 89 globals, with IDs from 10 to 89. You must NOT use globals outside this range as globals are used by other components of the framework.		You can define up to 79 globals, with IDs from 10 to 89. You must NOT use globals outside this range as globals are used by other components of the framework.

	<pre>		<pre>

Wucnuc: Removed duplication

2015-05-17T23:52:12Z

Removed duplication

← Versió més antiga		Revisió del 01:52, 18 maig 2015
Línia 180:		Línia 180:

	</pre>		</pre>


	~~; function getNonEmptyObjectFromDB( $sql )~~
	~~: Idem, but raise an exception if the query doesn't return exactly one row~~


	Note: see Editing [[Game database model: dbmodel.sql]] to know how to define your database model.		Note: see Editing [[Game database model: dbmodel.sql]] to know how to define your database model.

Pikiou: /* Notify players */ Warning about ignored notifications at game start

2014-08-22T04:25:53Z

Notify players: Warning about ignored notifications at game start

← Versió més antiga		Revisió del 06:25, 22 ago 2014
Línia 311:		Línia 311:

	Notifications are sent at the very end of the request, when it ends normally. It means that if you throw an exception for any reason (ex: move not allowed), no notifications will be sent to players.		Notifications are sent at the very end of the request, when it ends normally. It means that if you throw an exception for any reason (ex: move not allowed), no notifications will be sent to players.
			Notifications sent between the game start (setupNewGame) and the end of the "action" method of the first active state will never reach their destination.

	'''notifyAllPlayers( $notification_type, $notification_log, $notification_args )'''		'''notifyAllPlayers( $notification_type, $notification_log, $notification_args )'''

Archduke: /* Notify players */

2014-06-15T21:03:48Z

Notify players

← Versió més antiga		Revisió del 23:03, 15 juny 2014
Línia 328:		Línia 328:
	If you define a real string here, you should use "clienttranslate" method to make sure it can be translate.		If you define a real string here, you should use "clienttranslate" method to make sure it can be translate.

	You can use arguments in your notification_log strings, that refers to values defines in the "notification_args" argument (see below).		You can use arguments in your notification_log strings, that refers to values defines in the "notification_args" argument (see below). NB: Make sure you only use single quotes ('), otherwise PHP will try to interpolate the variable and will ignore the values in the args array.

	Note: you CAN use some HTML inside your notification log, and it is working. However:		Note: you CAN use some HTML inside your notification log, and it is working. However:

Archduke: /* Accessing database */

2014-06-08T08:51:18Z

Accessing database

← Versió més antiga		Revisió del 10:51, 8 juny 2014
Línia 66:		Línia 66:
	: This is the generic method to access the database.		: This is the generic method to access the database.
	: It can execute any type of SELECT/UPDATE/DELETE/REPLACE query on the database.		: It can execute any type of SELECT/UPDATE/DELETE/REPLACE query on the database.
	: You should use it for UPDATE/DELETE/REPLACE query. For SELECT queries, the specialized methods ~~above~~ are much better.		: You should use it for UPDATE/DELETE/REPLACE query. For SELECT queries, the specialized methods below are much better.

	; getUniqueValueFromDB( $sql )		; getUniqueValueFromDB( $sql )

Sourisdudesert: /* File Structure */

2014-01-06T09:00:34Z

File Structure

← Versió més antiga		Revisió del 11:00, 6 gen 2014
Línia 13:		Línia 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

← Versió més antiga		Revisió del 10:53, 6 gen 2014
Línia 506:		Línia 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 a 08:45, 6 gen 2014

2014-01-06T08:45:43Z

← Versió més antiga		Revisió del 10:45, 6 gen 2014
Línia 501:		Línia 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

← Versió més antiga		Revisió del 18:32, 30 set 2013
Línia 423:		Línia 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 a 09:01, 22 maig 2013

2013-05-22T09:01:51Z

← Versió més antiga		Revisió del 11:01, 22 maig 2013
Línia 454:		Línia 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.
Línia 496:		Línia 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.