Main game logic: yourgamename.game.php - Историја измена

Sourisdudesert: /* About random and randomness */

2018-10-10T09:22:21Z

About random and randomness

← Старија измена		Верзија на датум 10. октобар 2018. у 11:22
Ред 437:		Ред 437:

	At now, the Deck component shuffle method is based on PHP "shuffle" method, which has a quite good randomness (even it is not as good as bga_rand). In consequence, we accept other shuffling methods during reviews, as long as their are based on PHP "shuffle" function (or similar, like "array_rand").		At now, the Deck component shuffle method is based on PHP "shuffle" method, which has a quite good randomness (even it is not as good as bga_rand). In consequence, we accept other shuffling methods during reviews, as long as their are based on PHP "shuffle" function (or similar, like "array_rand").

			=== Other methods ===

			Mysql "RAND()" function has not enough randomness to be a valid method to get a random element on BGA. This function has been used in some existing games and has given acceptable results, but now it should be avoided and you should use other methods instead.

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

Sourisdudesert: /* bga_rand */

2018-10-10T09:19:11Z

bga_rand

← Старија измена		Верзија на датум 10. октобар 2018. у 11:19
Ред 419:		Ред 419:
	Here's are a list of techniques you should use in these situations, from the best to the worst.		Here's are a list of techniques you should use in these situations, from the best to the worst.

	=== bga_rand ===		=== Dices and bga_rand ===

	'''bga_rand( min, max )'''		'''bga_rand( min, max )'''

Sourisdudesert: /* About random and randomness */

2018-10-10T09:18:57Z

About random and randomness

← Старија измена		Верзија на датум 10. октобар 2018. у 11:18
Ред 415:		Ред 415:
	== About random and randomness ==		== About random and randomness ==

			A large number of board games rely on random, most often based on dice, cards shuffling, picking some item in a bag, and so on. This is very important to ensure a high level of randomness for each of these situations.

			Here's are a list of techniques you should use in these situations, from the best to the worst.

			=== bga_rand ===

			'''bga_rand( min, max )'''
			This is a BGA framework function that provides you a random number between "min" and "max" (included), using the best available random method available on the system.

			This is the preferred function you should use, because we are updating it when a better method is introduced.

			At now, bga_rand is based on the PHP function "random_int", which ensure a cryptographic level of randomness.

			In particular, it is '''mandatory''' to use it for all '''dice throw''' (ie: games using other methods for dice throwing will be rejected by BGA during review).

			Note: rand() and mt_rand() are deprecated on BGA and should not be used anymore, as their randomness is not as good as "bga_rand".

			=== shuffle and cards shuffling ===

			To shuffle items, like a pile of cards, the best way is to use the BGA PHP [[Deck]] component and to use "shuffle" method. This ensure you that the best available shuffling method is used, and that if in the future we improve it your game will be up to date.

			At now, the Deck component shuffle method is based on PHP "shuffle" method, which has a quite good randomness (even it is not as good as bga_rand). In consequence, we accept other shuffling methods during reviews, as long as their are based on PHP "shuffle" function (or similar, like "array_rand").

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

Sourisdudesert: /* Game statistics */

2018-10-10T09:05:58Z

Game statistics

← Старија измена		Верзија на датум 10. октобар 2018. у 11:05
Ред 412:		Ред 412:

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

			== About random and randomness ==





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

Amadannabriona: /* Managing errors and exceptions */

2018-09-16T03:17:56Z

Managing errors and exceptions

Amadannabriona: /* Accessing database */

2018-09-15T20:03:12Z

Accessing database

← Старија измена		Верзија на датум 15. септембар 2018. у 22:03
Ред 57:		Ред 57:
	: Check the "current_player" zombie status. If true, player is zombie, i.e. left or was kicked out of the game.		: Check the "current_player" zombie status. If true, player is zombie, i.e. left or was kicked out of the game.

	== Accessing database ==		== Accessing the database ==

	The main game logic should be the only point from ~~where~~ you should access to the game database. You access your database using SQL queries with the methods below.		The main game logic should be the only point from which you should access the game database. You access your database using SQL queries with the methods below.

	'''IMPORTANT'''		'''IMPORTANT'''

	BGA ~~is using~~ [http://dev.mysql.com/doc/refman/5.0/en/sql-syntax-transactions.html database transactions]. It means that your database changes WON'T BE APPLIED to the database until your request ends normally. Using ~~transaction~~ is in fact very useful for you: at any time, if your game logic detects that something is wrong (ex: ~~unallowed~~ move), you just have to throw an exception and all ~~the~~ changes ~~already performed on~~ the game situation will be removed.		BGA uses [http://dev.mysql.com/doc/refman/5.0/en/sql-syntax-transactions.html database transactions]. This means that your database changes WON'T BE APPLIED to the database until your request ends normally. Using transactions is in fact very useful for you; at any time, if your game logic detects that something is wrong (example: a disallowed move), you just have to throw an exception and all changes to the game situation will be removed.

	; DbQuery( $sql )		; DbQuery( $sql )
	: 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 below are much better.		: You should use it for UPDATE/DELETE/REPLACE queries. For SELECT queries, the specialized methods below are much better.

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

Amadannabriona: /* Accessing player informations */

2018-09-15T20:01:30Z

Accessing player informations

← Старија измена		Верзија на датум 15. септембар 2018. у 22:01
Ред 18:		Ред 18:
	* zombieTurn: what to do it's the turn of a zombie player.		* zombieTurn: what to do it's the turn of a zombie player.

	== Accessing player ~~informations~~ ==		== Accessing player information ==

	; getPlayersNumber()		; getPlayersNumber()

Amadannabriona у 20:01, 15. септембар 2018.

2018-09-15T20:01:08Z

← Старија измена		Верзија на датум 15. септембар 2018. у 22:01
Ред 1:		Ред 1:

	This ~~file~~ is the main file for your game logic. Here you initialize the game, persist data, implement the rules and notify ~~changes to~~ the client interface.		This is the main file for your game logic. Here you initialize the game, persist data, implement the rules and notify the client interface of changes.

	== File Structure ==		== File Structure ==

	The details on how the file is structured is described directly with comments on the code skeleton provided to you.		The details of how the file is structured are described directly with comments in the code skeleton provided to you.

	~~Basically, here's this~~ structure:		Here is the basic structure:

	* EmptyGame (constructor): where you define global variables.		* EmptyGame (constructor): where you define global variables.
	* setupNewGame: initial setup of the game.		* setupNewGame: initial setup of the game.

Victoria la: /* Multiactivate player handling */

2018-06-21T12:45:47Z

Multiactivate player handling

@@ Ред 259: / Ред 259: @@
 : If this player was the last active player, the method trigger the "next_state" transition to go to the next game state.
 : returns true if state transition happened, false otherwise
 ; $this->gamestate->getActivePlayerList()

Victoria la: /* Accessing player informations */

2018-06-21T12:29:01Z

Accessing player informations

← Старија измена		Верзија на датум 21. јун 2018. у 14:29
Ред 34:		Ред 34:
	; loadPlayersBasicInfos()		; loadPlayersBasicInfos()
	: Get an associative array with generic data about players (ie: not game specific data).		: Get an associative array with generic data about players (ie: not game specific data).
	: The key of the associative array is the player id.		: The key of the associative array is the player id. The returned table is cached, so ok to call multiple times without performance concerns.
	: The content of each value is:		: The content of each value is:
	: * player_name		: * player_name - the name of the player
	: * player_color (ex: ff0000)		: * player_color (ex: ff0000) - the color code of the player
			: * player_no - the position of the player at the start of the game in natural table order, i.e. 1,2,3

	; getCurrentPlayerId()		; getCurrentPlayerId()

← Старија измена		Верзија на датум 16. септембар 2018. у 05:17
Ред 573:		Ред 573:
	== Managing errors and exceptions ==		== Managing errors and exceptions ==

	Note: when you throw an exception, all database changes and all notifications are cancelled immediately. This way, the game situation that ~~were existing~~ before the request is completely restored.		Note: when you throw an exception, all database changes and all notifications are cancelled immediately. This way, the game situation that existed before the request is completely restored.

	; throw new BgaUserException ( $error_message)		; throw new BgaUserException ( $error_message)
	: Base class to notify a user error		: Base class to notify a user error
	: You must throw this exception when a player ~~want~~ to do something that he is not allowed to do.		: You must throw this exception when a player wants to do something that he is not allowed to do.
	: The error message will be shown to the player as a "red message", so it must be translated.		: The error message will be shown to the player as a "red message", so it must be translated.
	: Throwing such an exception is NOT considered as a bug, so it is not traced in BGA error logs.		: Throwing such an exception is NOT considered a bug, so it is not traced in BGA error logs.

	Example from Gomoku:		Example from Gomoku:
Ред 588:		Ред 588:

	; throw new BgaVisibleSystemException ( $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 in 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 that he can report it in the forum.
	: The error message is logged in BGA error logs. If it happens regularly, we will report it to you.		: The error message is logged in BGA error logs. If it happens regularly, we will report it to you.