BGA Undo policy - Гісторыя версій

Een: /* How to implement Undo */ link to undo functions doc

2019-12-09T15:27:29Z

How to implement Undo: link to undo functions doc

← Папярэдн. версія		Версія ад 17:27, 9 снежня 2019
Радок 58:		Радок 58:

	There are 2 ways to implement Undo:		There are 2 ways to implement Undo:
	* The framework undoSavePoint/undoRestorepoint methods.		* The framework undoSavePoint/undoRestorepoint methods, [[Main_game_logic:_yourgamename.game.php#Undo_moves \| documented here]].
	* Your own method.		* Your own method.

Een: /* How undoSavePoint/undoRestorepoint works? */

2019-05-13T11:27:22Z

How undoSavePoint/undoRestorepoint works?

← Папярэдн. версія		Версія ад 13:27, 13 мая 2019
Радок 68:		Радок 68:
	However, the framework is very handy to use (only 2 methods), so this should be your first choice if some moves are very difficult to reverse on client side.		However, the framework is very handy to use (only 2 methods), so this should be your first choice if some moves are very difficult to reverse on client side.

	== How undoSavePoint/undoRestorepoint works? ==		== How does undoSavePoint/undoRestorepoint works? ==

	The undoSavePoint method makes a full copy of the game database state.		The undoSavePoint method makes a full copy of the game database state.

	The undoRestorePoint method:		The undoRestorePoint method:
	* ~~restore~~ the game database		* restores the game database
	* ~~remove~~ all your game HTML + the player~~'s panel~~		* removes all your game HTML + the player panels
	* ~~restore~~ the game HTML + the player~~'s panel~~ according to their state at ~~browser's page~~ loading ~~page~~		* restores the game HTML + the player panels according to their state at the initial game loading
	* ~~call~~ your "setup" method		* calls your "setup" method

	'''Important''': because undoRestorePoint is calling your "setup" method, you must ensure that your whole game state can be restored from there. In particular, all your member variables must be initialized inside the "setup" method (and not only in the constructor !).		'''Important''': because undoRestorePoint is calling your "setup" method, you must ensure that your whole game state can be restored from there. In particular, all your member variables must be initialized inside the "setup" method (and not only in the constructor !).

Een: /* How to implement Undo */

2019-05-13T11:25:00Z

How to implement Undo

← Папярэдн. версія		Версія ад 13:25, 13 мая 2019
Радок 57:		Радок 57:
	= How to implement Undo =		= How to implement Undo =

	There is 2 ways to implement Undo:		There are 2 ways to implement Undo:
	* The framework undoSavePoint/undoRestorepoint methods.		* The framework undoSavePoint/undoRestorepoint methods.
	* Your own method.		* Your own method.

	As a rule of thumb, ~~this~~ is way better to us your own method to provide an Undo. The reasons are:		As a rule of thumb, it is way better to use your own method to provide an Undo. The reasons are:
	* The framework method is quite heavy to use (it saves the WHOLE situation). To cancel a simple move, it is way more efficient for you to execute the opposite move.		* The framework method is quite heavy to use (it saves the WHOLE situation). To cancel a simple move, it is way more efficient for you to execute the opposite move.
	* The framework method is doing a full "reset" of the game interface. It is way more ~~beautiful~~ to play the opposite move from a player point of view.		* The framework method is doing a full "reset" of the game interface. It is way more smooth and clear to play the opposite move from a player point of view.
	* The framework Undo provides only ONE save point. If you want to provide a complex Undo (ie: the possibility to undo all the previous steps one by one), you must implement it by yourself.		* The framework Undo provides only ONE save point. If you want to provide a complex Undo (ie: the possibility to undo all the previous steps one by one), you must implement it by yourself.

Een: /* About Undo to take back moves from a complex series of actions */

2019-05-13T11:23:42Z

About Undo to take back moves from a complex series of actions

← Папярэдн. версія		Версія ад 13:23, 13 мая 2019
Радок 51:		Радок 51:
	In most games, you shouldn't provide an undo because players are not allowed to "explore" the different possibilities by playing and undoing their moves.		In most games, you shouldn't provide an undo because players are not allowed to "explore" the different possibilities by playing and undoing their moves.

	However, in some games, ~~this~~ is commonly admitted that players are allowed to take back a move. The typical example is a complex strategy game with a long serie of actions during your turn. "Through the Ages" or "Tzolk'in" are 2 good examples.		However, in some games, it is commonly admitted that players are allowed to take back a move. The typical example is a complex strategy game with a long serie of actions during your turn. "Through the Ages" or "Tzolk'in" are 2 good examples.

	To know if this is a good idea to propose an undo, ask yourself the question: "when playing in real life, will my opponents authorize me to take back this move?". Depending on your answer, you should ~~propose~~ an Undo, do not ~~propose~~ an Undo, or maybe propose an Undo as an option for the game.		To know if this is a good idea to propose an undo, ask yourself the question: "when playing in real life, will my opponents authorize me to take back this move?". Depending on your answer, you should choose to provide an Undo, to not provide an Undo, or maybe to propose an Undo as an option for the game.

	= How to implement Undo =		= How to implement Undo =

Een: /* About Undo to avoid "misclick" */

2019-05-13T11:22:28Z

About Undo to avoid "misclick"

← Папярэдн. версія		Версія ад 13:22, 13 мая 2019
Радок 35:		Радок 35:

	* If the '''zone to click is very small''', or close to other zones, misclicks may happened frequently. Note that if this only happens on mobile, you can propose the Undo to mobile users only.		* If the '''zone to click is very small''', or close to other zones, misclicks may happened frequently. Note that if this only happens on mobile, you can propose the Undo to mobile users only.
	* If '''there is already another step''' after the step you want to undo. In this case, adding an "Undo" do not add an extra step.		* If '''there is already another step''' after the step you want to undo. In this case, adding an "Undo" does not add an extra step.
	* If you are in the middle of a real "game action". For example, on Chess, ~~this~~ is normal to allow to undo the selection of a piece in order to select another one, as the move hasn't been done already.		* If you are in the middle of a real "game action". For example, on Chess, it is normal to allow to undo the selection of a piece in order to select another one, as the move hasn't been done already.
	* The action done by the player is obviously ~~stupid~~ (in this case, please also consider adding a confirmation before the action).		* The action done by the player is obviously a mistake (in this case, please also consider adding a confirmation before the action).

	On the contrary, you must be reluctant to add an Undo if:		On the contrary, you must be reluctant to add an Undo if:
	* This adds an extra step.		* This adds an extra step.
	* The game action is clear and the zone to click is ~~very~~ large.		* The game action is clear and the zone to click is large.

	To conclude: we may allow a player to undo a move caused by a "misclick", but we shouldn't allow a player to undo a bad move he plays ~~conscientiously~~.		To conclude: we may allow a player to undo a move caused by a "misclick", but we shouldn't allow a player to undo a bad move he plays consciously.

	== About Undo to take back moves from a complex series of actions ==		== About Undo to take back moves from a complex series of actions ==

Een: /* About Undo to avoid "misclick" */

2019-05-13T11:20:36Z

About Undo to avoid "misclick"

← Папярэдн. версія		Версія ад 13:20, 13 мая 2019
Радок 30:		Радок 30:
	== About Undo to avoid "misclick" ==		== About Undo to avoid "misclick" ==

	~~Most of the case~~, you don't need this: players must pay attention :)		I most cases, you don't need this: players must pay attention :)

	However, if several of the following cases correspond to your situation, you may consider adding an Undo for "misclicks":		However, if several of the following cases correspond to your situation, you may consider adding an Undo for "misclicks":

Een: /* When to propose to Undo? */

2019-05-13T11:20:08Z

When to propose to Undo?

← Папярэдн. версія		Версія ад 13:20, 13 мая 2019
Радок 22:		Радок 22:
	Undo are painful for opponents, in real world and online. Some players may also use Undo to "test" situations while they should just think instead.		Undo are painful for opponents, in real world and online. Some players may also use Undo to "test" situations while they should just think instead.

	In many ~~case~~, proposing an "Undo" means also adding an extra step, which is not good for the game interface.		In many cases, proposing an "Undo" means also adding an extra step, which is not good for the game interface.

	Undo may be useful in 2 main situations:		Undo may be useful in 2 main situations:

Sourisdudesert: /* How to implement Undo */

2019-05-10T14:13:09Z

How to implement Undo

← Папярэдн. версія		Версія ад 16:13, 10 мая 2019
Радок 56:		Радок 56:

	= How to implement Undo =		= How to implement Undo =

			There is 2 ways to implement Undo:
			* The framework undoSavePoint/undoRestorepoint methods.
			* Your own method.

			As a rule of thumb, this is way better to us your own method to provide an Undo. The reasons are:
			* The framework method is quite heavy to use (it saves the WHOLE situation). To cancel a simple move, it is way more efficient for you to execute the opposite move.
			* The framework method is doing a full "reset" of the game interface. It is way more beautiful to play the opposite move from a player point of view.
			* The framework Undo provides only ONE save point. If you want to provide a complex Undo (ie: the possibility to undo all the previous steps one by one), you must implement it by yourself.

			However, the framework is very handy to use (only 2 methods), so this should be your first choice if some moves are very difficult to reverse on client side.

			== How undoSavePoint/undoRestorepoint works? ==

			The undoSavePoint method makes a full copy of the game database state.

			The undoRestorePoint method:
			* restore the game database
			* remove all your game HTML + the player's panel
			* restore the game HTML + the player's panel according to their state at browser's page loading page
			* call your "setup" method

			'''Important''': because undoRestorePoint is calling your "setup" method, you must ensure that your whole game state can be restored from there. In particular, all your member variables must be initialized inside the "setup" method (and not only in the constructor !).

Sourisdudesert на 14:01, 10 мая 2019

2019-05-10T14:01:37Z

← Папярэдн. версія		Версія ад 16:01, 10 мая 2019
Радок 54:		Радок 54:

	To know if this is a good idea to propose an undo, ask yourself the question: "when playing in real life, will my opponents authorize me to take back this move?". Depending on your answer, you should propose an Undo, do not propose an Undo, or maybe propose an Undo as an option for the game.		To know if this is a good idea to propose an undo, ask yourself the question: "when playing in real life, will my opponents authorize me to take back this move?". Depending on your answer, you should propose an Undo, do not propose an Undo, or maybe propose an Undo as an option for the game.

			= How to implement Undo =

Sourisdudesert: /* About Undo to take back moves from a very complex series of actions */

2019-05-10T14:01:20Z

About Undo to take back moves from a very complex series of actions

← Папярэдн. версія		Версія ад 16:01, 10 мая 2019
Радок 45:		Радок 45:
	To conclude: we may allow a player to undo a move caused by a "misclick", but we shouldn't allow a player to undo a bad move he plays conscientiously.		To conclude: we may allow a player to undo a move caused by a "misclick", but we shouldn't allow a player to undo a bad move he plays conscientiously.

	== About Undo to take back moves from a ~~very~~ complex series of actions ==		== About Undo to take back moves from a complex series of actions ==

	Games with a ~~very~~ complex ~~turns~~ are an "exception" to BGA Undo policy.		Games with a complex serie of actions are an "exception" to BGA Undo policy.

	In most games, you shouldn't provide an undo because players are not allowed to "explore" the different possibilities by playing and undoing their moves. However, this is		In most games, you shouldn't provide an undo because players are not allowed to "explore" the different possibilities by playing and undoing their moves.

			However, in some games, this is commonly admitted that players are allowed to take back a move. The typical example is a complex strategy game with a long serie of actions during your turn. "Through the Ages" or "Tzolk'in" are 2 good examples.

			To know if this is a good idea to propose an undo, ask yourself the question: "when playing in real life, will my opponents authorize me to take back this move?". Depending on your answer, you should propose an Undo, do not propose an Undo, or maybe propose an Undo as an option for the game.