BGA Undo policy - Revision history

BoontjieBoon: fix typo

2026-08-03T12:23:46Z

fix typo

← Older revision		Revision as of 14:23, 3 August 2026
Line 93:		Line 93:
	=== Step 2: Insert savepoint ===		=== Step 2: Insert savepoint ===
	Determine where you want to save the undo state. Must be single active player state		Determine where you want to save the undo state. Must be single active player state
	* ~~Begging~~ of new user turn		* Beginning of new user turn
	* Every time new information revealed such as		* Every time new information revealed such as
	** dice roll		** dice roll

Thoun: autowired example

2024-11-20T15:25:17Z

autowired example

← Older revision		Revision as of 17:25, 20 November 2024
Line 103:		Line 103:

	=== Step 3: Create undo action in server ===		=== Step 3: Create undo action in server ===
	~~Add players undo action~~
	~~in game.action.php:~~
	~~public function undo() {~~
	~~self::setAjaxMode();~~
	~~$this->game->action_undo();~~
	~~self::ajaxResponse();~~
	}
	in game.game.php		in game.game.php
	~~function action_undo() {~~		#[CheckAction(false)] // do not do checkAction - its on purpose - do not need to add undo as possible action to every state
	~~$this->undoRestorePoint~~(); // do not do checkAction - its on purpose - do not need to add undo as possible action to every state		function actUndo() {
			$this->undoRestorePoint();
	}		}

Line 119:		Line 113:
	add this to onUpdateActionButton regardless of state but inside isCurrenPlayerAction		add this to onUpdateActionButton regardless of state but inside isCurrenPlayerAction
	<pre>		<pre>
	this.addActionButton('button_undo', _('Undo'), 'onUndo', undefined, undefined, 'red');		this.addActionButton('button_undo', _('Undo'), () => this.onUndo(), undefined, undefined, 'red');
	</pre>		</pre>

Line 125:		Line 119:
	<pre>		<pre>
	onUndo: function (event) {		onUndo: function (event) {
	const action = "~~undo~~";		const action = "actUndo";
	this.ajaxcall(		this.ajaxcall(
	"/" + this.game_name + "/" + this.game_name + "/" + action + ".html",		"/" + this.game_name + "/" + this.game_name + "/" + action + ".html",

Kayvon: Restoring wording that shouldn't have been eliminated in revision 20996 by Victoria La (talk)

2024-05-30T12:47:23Z

Restoring wording that shouldn't have been eliminated in revision 20996 by Victoria La (talk)

← Older revision		Revision as of 14:47, 30 May 2024
Line 17:		Line 17:

	= When to propose to Undo? =		= When to propose to Undo? =

			As a rule of thumb, on BGA we advise you to not undo moves.

	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.

Victoria La: /* When to propose to Undo? */

2024-05-04T17:18:33Z

When to propose to Undo?

← Older revision		Revision as of 19:18, 4 May 2024
Line 17:		Line 17:

	= When to propose to Undo? =		= When to propose to Undo? =

	~~As a rule of thumb, on BGA we advise you to not undo moves.~~

	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.

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

2023-08-25T23:09:25Z

About Undo to avoid "misclick"

← Older revision		Revision as of 01:09, 26 August 2023
Line 30:		Line 30:
	== About Undo to avoid "misclick" ==		== About Undo to avoid "misclick" ==

	I most cases, you don't need this: players must pay attention :)		In 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":

Professor Tweak: /* About Undo to avoid "misclick" */ fixed typo

2023-07-16T06:43:23Z

About Undo to avoid "misclick": fixed typo

← Older revision		Revision as of 08:43, 16 July 2023
Line 45:		Line 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 consciously.		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.

	Note: not all of these ~~cituations~~ require server undo, in chess example above Undo of selection - you don't need to send piece selection to the server you can store it locally (this is "client side undo"), there is no Undo button in this case - user just selects another piece. Similary if you add prompt for clicking on critical buttons like "Pass" you can add extra prompt, but no Undo		Note: not all of these situations require server undo, in chess example above Undo of selection - you don't need to send piece selection to the server you can store it locally (this is "client side undo"), there is no Undo button in this case - user just selects another piece. Similary if you add prompt for clicking on critical buttons like "Pass" you can add extra prompt, but no Undo

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

LoriDean: /* Adding simple Undo actio to your game */

2023-02-13T11:57:58Z

Adding simple Undo actio to your game

← Older revision		Revision as of 13:57, 13 February 2023
Line 57:		Line 57:
	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.		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.

	Note: in this ~~cituation~~ it is also possible to use client side undo, instead of server side, see "Russian Railroads" for example (implemented using setClientState method).		Note: in this situation it is also possible to use client side undo, instead of server side, see "Russian Railroads" for example (implemented using setClientState method).

	= How to implement Undo =		= How to implement Undo =
Line 68:		Line 68:
	* 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 smooth and clear 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 (i.e.: 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.		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.
Line 84:		Line 84:
	'''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 !).

	== Adding simple Undo ~~actio~~ to your game ==		== Adding simple Undo action to your game ==

	=== Step 1: Declare in gameinfos ===		=== Step 1: Declare in gameinfos ===

Victoria La: /* How to implement Undo */

2023-01-29T01:37:01Z

How to implement Undo

← Older revision		Revision as of 03:37, 29 January 2023
Line 83:		Line 83:

	'''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 !).

			== Adding simple Undo actio to your game ==

			=== Step 1: Declare in gameinfos ===
			Add 'db_undo_support' => true in gamesinfo.inc.php

			Note: if you have game in studio you must reload gameinfos and restart all these games

			=== Step 2: Insert savepoint ===
			Determine where you want to save the undo state. Must be single active player state
			* Begging of new user turn
			* Every time new information revealed such as
			** dice roll
			** card is drawn
			** anything else hidden is shown

			Insert
			$this->undoSavepoint();

			=== Step 3: Create undo action in server ===
			Add players undo action
			in game.action.php:
			public function undo() {
			self::setAjaxMode();
			$this->game->action_undo();
			self::ajaxResponse();
			}
			in game.game.php
			function action_undo() {
			$this->undoRestorePoint(); // do not do checkAction - its on purpose - do not need to add undo as possible action to every state
			}

			=== Step 4: Create undo action in client ===
			in game.js
			add this to onUpdateActionButton regardless of state but inside isCurrenPlayerAction
			<pre>
			this.addActionButton('button_undo', _('Undo'), 'onUndo', undefined, undefined, 'red');
			</pre>

			and onUndo would be like this
			<pre>
			onUndo: function (event) {
			const action = "undo";
			this.ajaxcall(
			"/" + this.game_name + "/" + this.game_name + "/" + action + ".html",
			[],
			this,
			(result) => {},
			(err) => {
			if (err) return;
			this.setMainTitle(_("Undo requested..."));
			dojo.empty("generalactions");
			},
			true
			);
			},
			</pre>

			=== Step 5: Make it fancy ===
			If you want you can add extra styling to the Undo button such as it will appeat at right of all buttons
			in game.css
			<pre>
			#button_undo {
			float: right;
			background-color: red;
			background-image: none;
			}
			</pre>

	[[Category:Studio]]		[[Category:Studio]]

Ufm at 12:48, 9 June 2022

2022-06-09T12:48:59Z

← Older revision		Revision as of 14:48, 9 June 2022
Line 83:		Line 83:

	'''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 !).

			[[Category:Studio]]

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

2021-09-15T23:45:09Z

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

← Older revision		Revision as of 01:45, 16 September 2021
Line 56:		Line 56:

	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.		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.

			Note: in this cituation it is also possible to use client side undo, instead of server side, see "Russian Railroads" for example (implemented using setClientState method).

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