Main game logic: yourgamename.game.php - Sejarah semakan

Victoria la: /* Game statistics */

2016-07-23T02:21:10Z

Game statistics

← Semakan terdahulu		Semakan pada 02:21, 23 Julai 2016
Baris 368:		Baris 368:

	See [[Game statistics: stats.inc.php]] to see how you defines statistics for your game.		See [[Game statistics: stats.inc.php]] to see how you defines statistics for your game.


	'''initStat( $table_or_player, $name, $value, $player_id=null )'''		'''initStat( $table_or_player, $name, $value, $player_id=null )'''

	Create a statistic entry for the specified statistics with a default value.		Create a statistic entry for the specified statistics with a default value.
	This method must be called for each statistics of your game, in your setupNewGame method.		This method must be called for each statistics of your game, in your setupNewGame method.

	'table_or_player' must be set to "table" if this is a table statistics, or "player" if this is a player statistics.		'$table_or_player' must be set to "table" if this is a table statistics, or "player" if this is a player statistics.

			'$name' is the name of your statistics, as it has been defined in your stats.inc.php file.

	'~~name~~' is the ~~name~~ of ~~your~~ statistics, ~~as it has been defined in your stats.inc.php file~~.		'$value' is the initial value of the statistics. If this is a player statistics and if the player is not specified by "$player_id" argument, the value is set for ALL players.

	~~'value' is the initial value of the statistics. If this is a player statistics and if the player is not specified by "player_id" argument, the value is set for ALL players.~~

			'''setStat( $value, $name, $player_id = null )'''

	~~'''function setStat( $value,~~ $name, $~~player_id = null )'''~~		Set a statistic $name to $value.

	~~Set~~ a statistic ~~value~~.		If "$player_id" is not specified, setStat consider it is a TABLE statistic.

	If "player_id" is ~~not~~ specified, setStat consider it is a ~~TABLE~~ statistic.		If "$player_id" is specified, setStat consider it is a PLAYER statistic.

	~~If "player_id" is specified, setStat consider it is a PLAYER statistic.~~

	'''incStat( $delta, $name, $player_id = null )'''		'''incStat( $delta, $name, $player_id = null )'''

	Increment (or decrement) specified statistic value. Same behavior as ~~above~~.		Increment (or decrement) specified statistic value by $delta value. Same behavior as setStat function.

	== Translations ==		== Translations ==

Victoria la: /* Accessing database */

2016-06-19T16:12:36Z

Accessing database

← Semakan terdahulu		Semakan pada 16:12, 19 Jun 2016
Baris 106:		Baris 106:
	: Idem than previous one, but raise an exception if the collection is empty		: Idem than previous one, but raise an exception if the collection is empty

	; ~~function~~ getObjectFromDB( $sql )		; getObjectFromDB( $sql )
	: Returns one row for the sql SELECT query as an associative array or null if there is no result		: Returns one row for the sql SELECT query as an associative array or null if there is no result
	: Raise an exception if the query return more than one row		: Raise an exception if the query return more than one row
Baris 168:		Baris 168:
	: (unsafe = can be modified by a player).		: (unsafe = can be modified by a player).
	: This method makes sure that no SQL injection will be done through the string used.		: This method makes sure that no SQL injection will be done through the string used.
			: Note: if you using standard types in ajax actions, like AT_alphanum it is sanitized before arrival,
			: this is only needed if you manage to get unchecked string, like in the games where user has to enter text as a response.

	<pre>		<pre>
	~~self::getObjectFromDB( "SELECT player_name name, player_color color FROM player WHERE player_id='1234'" );~~

	~~Result:~~
	~~array(~~
	~~'id' => 1234,~~
	~~'name' => 'myuser1',~~
	~~'color' => 'ff0000'~~
	)

	</pre>		</pre>

Victoria la: Debugging

2016-06-06T00:14:26Z

Debugging

← Semakan terdahulu		Semakan pada 00:14, 6 Jun 2016
Baris 563:		Baris 563:
	* #000000 Black		* #000000 Black
	* #ffffff White		* #ffffff White

			== Debugging and Tracing ==

			To debug php code you can use some tracing functions available from the parent class such as debug, trace, error, warn, dump.

			self::debug("Ahh!");
			self::dump('my_var',$my_var);

			See [[Practical_debugging]] section for complete information about debugging interfaces and where to find logs.

Victoria la: /* Game states and active players */

2016-06-01T02:38:37Z

Game states and active players

← Semakan terdahulu		Semakan pada 02:38, 1 Jun 2016
Baris 269:		Baris 269:
	: Example: in Libertalia game, you want to authorize players to change their mind about card played. They are of course not active at the time they change their mind, so you cannot use "checkAction" and use "checkPossibleAction" instead.		: Example: in Libertalia game, you want to authorize players to change their mind about card played. They are of course not active at the time they change their mind, so you cannot use "checkAction" and use "checkPossibleAction" instead.

	; $this->gamestate->nextState( $~~state~~ )		; $this->gamestate->nextState( $transition )
	: Change current state to a new state, see [[Your game state machine: states.inc.php]] for more information about states.		: Change current state to a new state. Important: parameter $transition is the name of the transition, and NOT the name of the target game state, see [[Your game state machine: states.inc.php]] for more information about states.

	; $this->gamestate->state()		; $this->gamestate->state()

Victoria la: /* Game states and active players */

2016-05-31T23:30:48Z

Game states and active players

← Semakan terdahulu		Semakan pada 23:30, 31 Mei 2016
Baris 223:		Baris 223:

	; checkAction( $actionName, $bThrowException=true )		; checkAction( $actionName, $bThrowException=true )
	: Check if action is valid regarding current game state (exception if fails)		: Check if action is valid regarding current game state (exception if fails).
	: The action is valid if it is listed as a "possibleactions" in the current game state (see game state description).		: The action is valid if it is listed as a "possibleactions" in the current game state (see game state description).
	: This method MUST be called in the first place in ALL your PHP methods that handle players action, in order to make sure a player can't do an action when the rules disallow it at this moment of the game.		: This method MUST be called in the first place in ALL your PHP methods that handle players action, in order to make sure a player can't do an action when the rules disallow it at this moment of the game.
Baris 270:		Baris 270:

	; $this->gamestate->nextState( $state )		; $this->gamestate->nextState( $state )
	: Change current state to a new state, see [[Your game state machine: states.inc.php]] for more information about states		: Change current state to a new state, see [[Your game state machine: states.inc.php]] for more information about states.

	; $this->gamestate->state()		; $this->gamestate->state()
	: Get an associative array of current game state attributes, see [[Your game state machine: states.inc.php]] for state attributes		: Get an associative array of current game state attributes, see [[Your game state machine: states.inc.php]] for state attributes.
	$state=$this->gamestate->state(); if( $state['name'] == 'myGameState' ) {...}		$state=$this->gamestate->state(); if( $state['name'] == 'myGameState' ) {...}

Victoria la: /* Game states and active players */

2016-05-31T12:02:34Z

Game states and active players

← Semakan terdahulu		Semakan pada 12:02, 31 Mei 2016
Baris 268:		Baris 268:
	: This is used specifically in certain game states when you want to authorize some additional actions for players that are not active at the moment.		: This is used specifically in certain game states when you want to authorize some additional actions for players that are not active at the moment.
	: Example: in Libertalia game, you want to authorize players to change their mind about card played. They are of course not active at the time they change their mind, so you cannot use "checkAction" and use "checkPossibleAction" instead.		: Example: in Libertalia game, you want to authorize players to change their mind about card played. They are of course not active at the time they change their mind, so you cannot use "checkAction" and use "checkPossibleAction" instead.

			; $this->gamestate->nextState( $state )
			: Change current state to a new state, see [[Your game state machine: states.inc.php]] for more information about states

			; $this->gamestate->state()
			: Get an associative array of current game state attributes, see [[Your game state machine: states.inc.php]] for state attributes
			$state=$this->gamestate->state(); if( $state['name'] == 'myGameState' ) {...}

	== Players turn order ==		== Players turn order ==

Victoria la: /* Player color preferences */

2016-05-23T17:45:01Z

Player color preferences

← Semakan terdahulu		Semakan pada 17:45, 23 Mei 2016
Baris 547:		Baris 547:
	* for some games (ex : Chess), the color has an influence on a mechanism of the game, most of the time by giving a special advantage to a player (ex : Starting the game). Color preference mechanism must NOT be used in such a case.		* for some games (ex : Chess), the color has an influence on a mechanism of the game, most of the time by giving a special advantage to a player (ex : Starting the game). Color preference mechanism must NOT be used in such a case.
	* your logic should NEVER consider that the first player has the color X, that the second player has the color Y, and so on. If this is the case, your game will NOT be compatible with reattributeColorsBasedOnPreferences as this method attribute colors to players based on their preferences and not based as their order at the table.		* your logic should NEVER consider that the first player has the color X, that the second player has the color Y, and so on. If this is the case, your game will NOT be compatible with reattributeColorsBasedOnPreferences as this method attribute colors to players based on their preferences and not based as their order at the table.

			Colours currently listed as a choice in preferences:

			* #ff0000 Red
			* #008000 Green
			* #0000ff Blue
			* #ffa500 Yellow
			* #000000 Black
			* #ffffff White

Een: /* Notify players */ tip on player name highlighting

2016-02-04T10:06:15Z

Notify players: tip on player name highlighting

← Semakan terdahulu		Semakan pada 10:06, 4 Februari 2016
Baris 349:		Baris 349:
	You can see in the example above the use of the "clienttranslate" method, and the use of 2 arguments "player_name" and "returned_nbr" in the notification log.		You can see in the example above the use of the "clienttranslate" method, and the use of 2 arguments "player_name" and "returned_nbr" in the notification log.

	Important: NO private ~~date~~ must be sent with this method, as a cheater could see it even it is not used explicitly by the game interface logic. If you want to send private information to a player, please use notifyPlayer below.		Important: NO private data must be sent with this method, as a cheater could see it even it is not used explicitly by the game interface logic. If you want to send private information to a player, please use notifyPlayer below.

	'''notifyPlayer( $player_id, $notification_type, $notification_log, $notification_args )'''		'''notifyPlayer( $player_id, $notification_type, $notification_log, $notification_args )'''
Baris 356:		Baris 356:

	This method must be used each time some private information must be transmitted to a player.		This method must be used each time some private information must be transmitted to a player.

			Important: the variable for player name must be ${player_name} in order to be highlighted with the player color in the game log

	== Game statistics ==		== Game statistics ==

Sourisdudesert pada 10:42, 28 Disember 2015

2015-12-28T10:42:27Z

← Semakan terdahulu		Semakan pada 10:42, 28 Disember 2015
Baris 511:		Baris 511:
	* 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.		* 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.		* 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.

			== Player color preferences ==


			BGA players (Club members) may now choose their preferred color for playing. For example, if they are used to play green for every board game, they can select "green" in their BGA preferences page.

			Making your game compatible with colors preferences is very easy and requires only 1 line of PHP and 1 configuration change :

			On your gameinfos.inc.php file, add the following lines :

			// Favorite colors support : if set to "true", support attribution of favorite colors based on player's preferences (see reattributeColorsBasedOnPreferences PHP method)
			'favorite_colors_support' => true,

			Then, on your main <your_game>.game.php file, find the "reloadPlayersBasicInfos" call in your "setupNewGame" method and replace :

			$sql .= implode( $values, ',' );
			self::DbQuery( $sql );
			self::reloadPlayersBasicInfos();

			By :

			$sql .= implode( $values, ',' );
			self::DbQuery( $sql );
			self::reattributeColorsBasedOnPreferences( $players, array( /* LIST HERE THE AVAILABLE COLORS OF YOUR GAME INSTEAD OF THESE ONES */"ff0000", "008000", "0000ff", "ffa500", "773300" ) );
			self::reloadPlayersBasicInfos();


			The "reattributeColorsBasedOnPreferences" method reattributes all colors, taking into account players color preferences and available colors.

			Note that you must update the colors to indicate the colors available for your game.

			2 important remarks :
			* for some games (ex : Chess), the color has an influence on a mechanism of the game, most of the time by giving a special advantage to a player (ex : Starting the game). Color preference mechanism must NOT be used in such a case.
			* your logic should NEVER consider that the first player has the color X, that the second player has the color Y, and so on. If this is the case, your game will NOT be compatible with reattributeColorsBasedOnPreferences as this method attribute colors to players based on their preferences and not based as their order at the table.

Ludovic: /* Accessing database */

2015-10-27T11:02:35Z

Accessing database

← Semakan terdahulu		Semakan pada 11:02, 27 Oktober 2015
Baris 170:		Baris 170:

	<pre>		<pre>
	self::getObjectFromDB( "SELECT ~~player_id id,~~ player_name name, player_color color FROM player WHERE player_id='1234'" );		self::getObjectFromDB( "SELECT player_name name, player_color color FROM player WHERE player_id='1234'" );

	Result:		Result: