docs: Document setting next phase with method as added in #972

boardgameio · Aug 7, 2021 · d8fc8f5 · d8fc8f5
1 parent bfaf983
commit d8fc8f5
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/docs/documentation/api/Game.md b/docs/documentation/api/Game.md
@@ -104,6 +104,7 @@
       start: true,
 
       // Set the phase to enter when this phase ends.
+      // Can also be a function: (G, ctx) => 'nextPhaseName'
       next: 'nextPhaseName',
     },
 

diff --git a/docs/documentation/phases.md b/docs/documentation/phases.md
@@ -176,22 +176,27 @@ phases: {
 },
 ```
 
-If you need to specify the next phase dynamically, you can return
-an object containing a `next` field from your `endIf`:
+!> Whenever a phase ends, the current player's turn is first ended automatically.
+
+
+### Setting the next phase dynamically
+
+Instead of setting a phase’s `next` option with a string, you can
+provide a function that will return the next phase based on game
+state at the end of the phase:
 
 ```js
 phases: {
   phaseA: {
-    endIf: (G, ctx) => {
-      return { next: G.condition ? 'phaseB' : 'phaseC' }
+    next: (G, ctx) => {
+      return G.condition ? 'phaseC' : 'phaseB';
     },
   },
   phaseB: { ... },
   phaseC: { ... },
 },
 ```
 
-!> Whenever a phase ends, the current player's turn is first ended automatically.
 
 ### Override Behavior