Toggle between the map and look around

[Brambor]

Summary

Interface "Toggle between the map and look around"

Purpose of change

• Resolve Seamless transition from map to look around & from look around to map #74470
• Resolve Create option on map view to exit map view, but keep your camera in the area like the "look around" keybind #70072

Describe the solution

Add uistate.open_menu. It stores a function to be executed in the main loop. It is used to open a menu with arguments. Unlike ACTIONS arguments can be passed. Unlike ACTIVITY it doesn't take a turn for the player.

This is utilized to remember the position of look around/map when toggling to the other one. It can be used in more places, such as:

• view recipe works only once per opened Advanced Inventory #62996, which currently takes a turn. I plan to do that next.

Describe alternatives you've considered

Put avatar.open_menu somewhere else than into avatar. Could be in the game. I think of it as an ACTIVITY/ACTION, so I prefer avatar over game. Creature/Character cannot have it, only avatar can. But maybe it belongs to some uistate or how was it called. Done.

Don't use (and therefore implement) uistate.open_menu, but simply call the look_around from map directly (and vice versa). This approach would grow on the stack as the player would toggle from one to the other. The stack would then need to be collapsed again when the player finally closes look_around or map. The closing would require additional cleanup or maybe just action = "QUIT"; break;.

The function calls on the stack provide no additional benefit. The variables stored there aren't needed and therefore are confusing. A stack overflow error could also occur. This is why I decided on the uistate.open_menu which doesn't grow the stack at all and only useful variables are passed and remembered.

Opening map is forbidden (If I did it correctly) when working with zones. This is to prevent what you can see in Bug below.

Testing

Usecase from

• Seamless transition from map to look around & from look around to map #74470

Cataclysm_.Dark.Days.Ahead.-.0.G-12112-g67067d0465-dirty.2024-09-14.19-45-03.mp4

Bug

When long-range teleporting, the player can do ;; (Look around, View map). This returns an invalid point to the teleport, so the teleport doesn't happen. In this case, "Look around" should be forbidden. I don't know how to do that without additional parameter bool forbid_open_map to look_around. So I didn't do it.

Additional context

[Brambor]

I decided to move avatar.open_menu to uistate.open_menu.

I finally learned to mark it as a draft in time, because somebody would sneakily merge it otherwise.

Edit: done!

[CoroNaut]

Noticed this PR was similar to a suggestion I made a while back as well, just putting this here to link it #70072. Thanks for adding this!

[Brambor]

I will change the implementation a bit yet again so that AIM can use it too.