Notification popups

[byorgey]

Closes #916.

Adds animated popup boxes at the top of the screen to alert the user when they (1) attain a new achievement, (2) unlock new recipes, or (3) unlock new commands.

I've tried hard to make sure that the UI always gets redrawn when there is a popup box that needs to be animated, but it was a bit fiddly and it's possible I've missed a case. Note that we used to use continueWithoutRedraw extensively while displaying menus, but in case a notification popup occurs we don't want that. Rather than plumb around a boolean so we can decide whether to continueWithoutRedraw or not, I decided to just get rid of them. This means we now redraw the menu every frame but that really shouldn't be an issue.

Open to suggestions for making the popups look nicer or including more information.

To test, try e.g.

• Opening the About menu (make sure to delete ~/.local/share/swarm/achievement/LookedAtAboutScreen first)
• Completing a tutorial (delete ~/.local/share/swarm/achievement/CompletedSingleTutorial first)
• Start a Classic game and get a tree (should notify of new recipes)
• make "branch"; make "branch predictor" (should notify of new commands)

[noahyor]

I was playing around with this system (it's great, by the way) and I think I found a bug.

To reproduce:

1. Delete the Single Tutorial achievement
2. Win the first tutorial

The goal modal appears.

However, the "Congratulations" Menu should be shown.

Doing the above steps without deleting the achievement produces the desired effect.

[byorgey]

OK, my current theory is that in a sense the game has always "wanted" to display the goals dialog right after displaying the win dialog... but the UI was not updated while the game was implicitly paused by the win dialog, so the goals dialog did not get displayed unless you chose "keep playing". However, when there's a popup to display we must keep updating the UI so it will be properly animated. This also causes the goals dialog to immediately be shown after the win dialog.

In a sense this is sort of a bug which has existed for a long time, but it just happened to work because of the way we did not update the UI while displaying certain modals.

I'll have to think about the best way to resolve this.

[byorgey]

The fix was very easy in the end --- when there was any popup to animate I was forcing the entire game to run rather than just forcing the UI to be redrawn! In other words when there was a popup, it was ignoring the "pause" setting. The solution is simple --- if the game is paused, only use the "force redraw" boolean to decide whether to call continueWithoutRedraw or not, not whether to call runFrameUI.

[byorgey]

I think this is ready now! Of course, still very open to suggestions for improvement.

[nitinprakash96]

Works like a charm!

[xsebek]

This is awesome! 🤩

It's a great improvement on a highlighted shortcut in UI. 😆

[noahyor]

This is amazing! I would love for this to be in 0.6!