decouple once and allOthers

Author: nicolodavis

docs/events.md

@@ -68,7 +68,9 @@ const opts = {
   all: true,
 
   // Use this to set actionPlayers to all players
-  // except the current player.
+  // except the current player. When combined with
+  // `once: true`, the current player is added back
+  // to `actionPlayers` once everyone else takes a move.
   allOthers: true,
 };
 

examples/react/modules/turnorder/game.js

@@ -33,7 +33,7 @@ const TurnExample = Game({
 
   moves: {
     playMilitia: (G, ctx) => {
-      ctx.events.setActionPlayers({ allOthers: true });
+      ctx.events.setActionPlayers({ once: true, allOthers: true });
 
       const currentPlayer = ctx.currentPlayer;
       const playersNext = [...G.players];

src/core/flow.js

@@ -552,11 +552,8 @@ export function FlowWithPhases({
     if (state.ctx._actionPlayersOnce) {
       const playerID = action.playerID;
       actionPlayers = actionPlayers.filter(id => id !== playerID);
-    }
-    if (state.ctx._actionPlayersAllOthers) {
-      const playerID = action.playerID;
-      actionPlayers = actionPlayers.filter(id => id !== playerID);
-      if (actionPlayers.length === 0) {
+
+      if (state.ctx._actionPlayersAllOthers && actionPlayers.length === 0) {
         actionPlayers = [state.ctx.currentPlayer];
       }
     }

src/core/turn-order.js

@@ -33,9 +33,16 @@ export const Pass = (G, ctx) => {
  * @param {object} arg - An array of playerID's or <object> of:
  *   {
  *     value: [],        // array of playerID's (optional if all is set).
+ *
  *     all: true,        // set value to all playerID's
+ *
  *     allOthers: true,  // set value to all except currentPlayer.
- *     once: true,       // players have one move.
+ *                       // when combined with `once` (below)
+ *                       // currentPlayer is added back after
+ *                       // everyone has taken their move.
+ *
+ *     once: true,       // players have one move
+ *                       // (after which they're pruned from actionPlayers).
  *   }
  */
 export function SetActionPlayers(state, arg) {

src/core/turn-order.test.js

@@ -245,6 +245,7 @@ describe('SetActionPlayers', () => {
         B: (G, ctx) => {
           ctx.events.setActionPlayers({
             value: ['0', '1', '2'],
+            once: true,
             allOthers: true,
           });
           return G;