Merge pull request #267 from th555/sunspot

sunspot: add validation messages to incomplete moves

Author: Perlkonig

locales/en/apgames.json

@@ -5044,6 +5044,10 @@
             "NO_PIECE": "You don't have a size {{size}} piece to place.",
             "PARTIAL_PLACEMENT": "Click an empty space on the board to place your {{size}} piece."
         },
+        "sunspot": {
+            "OPTIONAL_FLIP": "You may submit the move as-is, or you may additionally flip an interior stone that is part of a combined group to your colour.",
+            "MANDATORY_COUNTERFLIP": "You must flip one of your own edge subgroups in the same group as the flipped stone."
+        },
         "surmount": {
             "BAD_CAP": "You may not capture the stone at {{cell}}. The captured stone must be adjacent to the capturing group and must be part of a group that is the same size as the capturing group.",
             "BAD_CONTINUE": "You may not place a stone at {{cell}}. Continuations may not make contact with any groups other than those initially contacted, and they may not grow the group any larger than the largest enemy group initially contacted.",

src/games/sunspot.ts

@@ -18,6 +18,7 @@ type MovePart = {
         previousAction: string
     ) => [boolean, Map<string, cellcontent>];
     condition?: (board: Map<string, cellcontent>, previousAction: string) => boolean;
+    message?: string;
 }
 
 export interface IMoveState extends IIndividualState {
@@ -212,6 +213,8 @@ export class SunspotGame extends GameBase {
      - Finally, actions also return the board after the action has been applied.
      - Note that conditions don't have an 'action' argument.
      - Note that they must be arrow functions, to keep the 'this' in scope.
+     - Moves that have both a condition and an action can have a message, to indicate to the player
+       what to do next in case of an incomplete move.
     */
 
     /* Actions */
@@ -305,12 +308,14 @@ export class SunspotGame extends GameBase {
 
     private flipAction = {
         condition: this.checkFlipIsPossible,
-        action: this.doFlipAction
+        action: this.doFlipAction,
+        message: "apgames:validation.sunspot.OPTIONAL_FLIP"
     }
 
     private counterFlipAction = {
         condition: this.checkCounterFlipIsPossible,
-        action: this.doCounterFlipAction
+        action: this.doCounterFlipAction,
+        message: "apgames:validation.sunspot.MANDATORY_COUNTERFLIP"
     }
 
     private placeIsNotPossible = {
@@ -362,6 +367,7 @@ export class SunspotGame extends GameBase {
 
         let complete = false; // found at least one (valid) complete move
         let incomplete = false; // found at least one (valid) incomplete move
+        let message = undefined;
         for (const movePartSequence of validMoves) {
             let remainingActionStrs = m.split(';');
             let previousActionStr = "";
@@ -393,6 +399,9 @@ export class SunspotGame extends GameBase {
                         movePartSequence. */
                         incomplete = true;
                         validComplete = false;
+                        if (movePart.message !== undefined) {
+                            message = movePart.message;
+                        }
                         break;
                     }
                 }
@@ -417,6 +426,9 @@ export class SunspotGame extends GameBase {
                 result.complete = -1;
                 result.message = i18next.t("apgames:validation._general.INCOMPLETE_MOVE");
             }
+            if (incomplete && message !== undefined) {
+                result.message = i18next.t(message);
+            }
             return result
         } else {
             return {