Game becomes paused with cycling menu screen

[pjlsergeant]

Issue Summary

I think this is a regression of #3223. Starting a single player Skirmish game and then repeatedly hitting the Escape key to toggle the menu on and off will put the game into a paused state (which I still haven't worked out how to undo!)

Reproduction

Open the game in a single player Skirmish game, hit Esc rapidly ten times. The game is now paused, even when the menu is dismissed

Expected behavior

EXPECTED BEHAVIOR

Screenshots / Screen recordings / Replays

[dragunoff]

[...] will put the game into a paused state (which I still haven't worked out how to undo!)

Pressing the "Pause" key will unpause the game. I was able to reproduce this on both release and bleed - pressing Esc several times in quick succession puts the game in pause.

[jongleur1983]

Edited after further investigation and learning about the code base.

Cause of this bug:

On [Esc] the game is paused by issuing a Pause-Order or unpaused respectively.
This order before my fix was not issued immediately, and by that enqueued together with other orders of the game.

When the menu opens, at first the current pause-state of the world is queried and stored. This is done to keep the same state after closing: When the game was paused already before opening the menu, it should still be paused after returning to the game.

So the algorithm basically is:

1. On Escape: Store current paused state of the world locally
2. Pause game (in case it was not paused before)
3. Show Menu
4. On Escape again (when closing the menu): Restore paused state to the stored value from (1).

The bug is caused by 1. here:
When in the first iteration Restore is triggered, that is triggered by issuing an unpause-Order.
As that order was not flagged as IsImmediate, the next iterations step (1) stored an outdated pause state while the order from (4) was still in the queue to be processed.
As that usually is "paused" because that's always the case while the menu is open, the observed bug behavior is the result.