Describe use of blue highlights in protocol specs
authorH.G.Muller <hgm@hgm-xboard.(none)>
Sun, 8 May 2016 18:04:36 +0000 (20:04 +0200)
committerH.G.Muller <hgm@hgm-xboard.(none)>
Sun, 8 May 2016 18:04:36 +0000 (20:04 +0200)
The function of 'blue' markers, and the role of the 'choice' command
in this is explained in the CECP specs.

engine-intf.html

index bc4815f..b8b09fb 100644 (file)
@@ -1853,8 +1853,9 @@ Some colors have special meaning to the GUI:
 <table>\r
 <tr><th>color</th><th>used for</th><th>effect</th><tr>\r
 <tr><td>red</td><td>capture</td><td>hovering over the square makes the GUI send a "hover" command</td><tr>\r
 <table>\r
 <tr><th>color</th><th>used for</th><th>effect</th><tr>\r
 <tr><td>red</td><td>capture</td><td>hovering over the square makes the GUI send a "hover" command</td><tr>\r
-<tr><td>magenta</td><td>promotion</td><td>moving to the square will be treated by the GUI as a promotion</td><tr>\r
-<tr><td>cyan</td><td>multi-move</td><td>moving to the square will not complete the move entry</td><tr>\r
+<tr><td>magenta</td><td>promotion choice</td><td>moving to the square will be treated by the GUI as a promotion</td><tr>\r
+<tr><td>blue</td><td>forced promotion</td><td>moving to the square will automatically promote the piece as specified in a 'choice' command</td><tr>\r
+<tr><td>cyan</td><td>multi-leg moving</td><td>moving to the square will not complete the move entry</td><tr>\r
 <tr><td>green</td><td>victims</td><td>no real effect, but used by convention to indicate capture victims on "hover"</td><tr>\r
 </table>\r
 The GUI will use the markers for legality checking,\r
 <tr><td>green</td><td>victims</td><td>no real effect, but used by convention to indicate capture victims on "hover"</td><tr>\r
 </table>\r
 The GUI will use the markers for legality checking,\r
@@ -1875,6 +1876,11 @@ to alter the choice offered to the user for the promotion piece from what the GU
 to the piece IDs mentioned in the PIECESTRING.\r
 The IDs in that string should be given as capitals irrespective of color.\r
 The first piece mentioned will be the default choice.\r
 to the piece IDs mentioned in the PIECESTRING.\r
 The IDs in that string should be given as capitals irrespective of color.\r
 The first piece mentioned will be the default choice.\r
+An engine <i>must</i> send this command on receiving a 'put' on a square that it highlighted in blue,\r
+or the move will not be completed;\r
+the GUI must wait for the 'choice' command in this case,\r
+to complete the move with the specified promotion suffix,\r
+which will then always be the first piece mentioned in the PIECESTRING.\r
 </dd>\r
 </dl>\r
 \r
 </dd>\r
 </dl>\r
 \r