Pause on objective completion

[xsebek]

• add a new option --hide-goal Do not show goal modal window that pauses the game.
• pause the game once an objective is finished - can be disabled by --hide-goal
• show the goal modal window (and autopause) even when running with --autoplay
  • previous behavior can be achieved with --autoplay --hide-goal
  • removes the debug option autoplay_goals
• closes Pause the game on objective completion #2073

[xsebek]

For reference, this is how I debugged this with an output to file that showed the state of the objective display queue:

Show patch and debug output

--- b/src/swarm-engine/Swarm/Game/Step.hs
+++ a/src/swarm-engine/Swarm/Game/Step.hs
@@ -341,9 +341,22 @@ hypotheticalWinCheck em g ws oc = do
     _ -> return ()
 
   queue <- messageInfo . announcementQueue Swarm.Util.<%= (>< Seq.fromList (map ObjectiveCompleted $ completionAnnouncementQueue finalAccumulator))
-  shouldPause <- use $ temporal . pauseOnCompletion
 
-  when (newWinState /= Ongoing || (notNull queue && shouldPause == PauseOnAnyObjective)) $
+  shouldPause <- use $ temporal . pauseOnCompletion
+  let willPause = newWinState /= Ongoing || (notNull queue && shouldPause == PauseOnAnyObjective)
+  -- TODO: remove this debug ouput
+  sendIO $
+    appendFile "log_win.txt" $
+      intercalate
+        " \t"
+        [ show $ getTickNumber ts
+        , if newWinState == Ongoing then "ongoing" else "won"
+        , if notNull queue then "queued" else "empty"
+        , show shouldPause
+        , if willPause then "AutoPause" else "Running"
+        ] <> "\n"
+
+  when willPause $
     temporal . runStatus .= AutoPause
 
   mapM_ handleException $ exceptions finalAccumulator

1 	ongoing 	empty 	PauseOnAnyObjective 	Running
2 	ongoing 	queued 	PauseOnAnyObjective 	AutoPause
3 	ongoing 	empty 	PauseOnAnyObjective 	Running
4 	ongoing 	empty 	PauseOnAnyObjective 	Running
5 	ongoing 	empty 	PauseOnAnyObjective 	Running
6 	ongoing 	empty 	PauseOnAnyObjective 	Running
7 	ongoing 	empty 	PauseOnAnyObjective 	Running
8 	ongoing 	queued 	PauseOnAnyObjective 	AutoPause
9 	ongoing 	empty 	PauseOnAnyObjective 	Running
10 	ongoing 	empty 	PauseOnAnyObjective 	Running
11 	ongoing 	empty 	PauseOnAnyObjective 	Running
12 	ongoing 	empty 	PauseOnAnyObjective 	Running
13 	ongoing 	queued 	PauseOnAnyObjective 	AutoPause
14 	ongoing 	empty 	PauseOnAnyObjective 	Running
15 	ongoing 	empty 	PauseOnAnyObjective 	Running
16 	ongoing 	empty 	PauseOnAnyObjective 	Running
17 	ongoing 	empty 	PauseOnAnyObjective 	Running
18 	ongoing 	empty 	PauseOnAnyObjective 	Running
19 	ongoing 	empty 	PauseOnAnyObjective 	Running
20 	ongoing 	empty 	PauseOnAnyObjective 	Running
21 	ongoing 	empty 	PauseOnAnyObjective 	Running
22 	ongoing 	empty 	PauseOnAnyObjective 	Running
23 	ongoing 	empty 	PauseOnAnyObjective 	Running
24 	ongoing 	empty 	PauseOnAnyObjective 	Running
25 	ongoing 	empty 	PauseOnAnyObjective 	Running
26 	ongoing 	empty 	PauseOnAnyObjective 	Running
27 	ongoing 	empty 	PauseOnAnyObjective 	Running
28 	ongoing 	empty 	PauseOnAnyObjective 	Running
29 	ongoing 	empty 	PauseOnAnyObjective 	Running
30 	ongoing 	empty 	PauseOnAnyObjective 	Running
31 	ongoing 	empty 	PauseOnAnyObjective 	Running
32 	ongoing 	empty 	PauseOnAnyObjective 	Running
33 	ongoing 	empty 	PauseOnAnyObjective 	Running
34 	ongoing 	empty 	PauseOnAnyObjective 	Running
35 	ongoing 	empty 	PauseOnAnyObjective 	Running
36 	ongoing 	empty 	PauseOnAnyObjective 	Running
37 	won 	queued 	PauseOnAnyObjective 	AutoPause

[byorgey]

I'm trying to make sure I understand the logic here. What is the purpose of the notNull queue check? How does the newWinState check and the other check fit together? (And can you turn your answer into some comments in the code here?)

[xsebek]

I named the parts using let. Is it clearer now? 🙂

[byorgey]

Yes, much better, thanks!