Main menu overhaul (Part 1.5): mouse control fixes & improvements

[dseguin]

Summary

None

Purpose of change

• Follow up to Main menu overhaul (Part 1): Mouse controls + Vertical submenus #57764

Fixes #58086 (except the scrolling issue which is addressed by #58140).

Describe the solution

1. Trigger the "menu_move" sounds when mousing over main menu options.
2. Modify external UI elements to be mouse-aware (for prompts and popups).
3. Add a mouse-accessible method of exiting tertiary menus.
4. In general, right-click can act as ESC if there are no visible buttons for exiting a window.

Changes to uilist/query_popup:

• Highlight list items when mousing over

Changes to Settings/World/Help menus:

• Full mouse control

Example - creating a world using only the mouse:

2022-06-05.03-41-54.mp4

Example - navigating settings and help menus in-game:

2022-06-05.19-38-47.mp4

Additional testing

Additional context

TODO:

• Mouse-ify all remaining sub-menu items:
  • New Character
  • Load Character
  • World
  • Settings
  • Help

[Night-Pryanik]

Is it possible to move mods up and down in world creation menu using only mouse?

[dseguin]

Is it possible to move mods up and down in world creation menu using only mouse?

No, sorry. As far as I know click-and-drag is not possible.

[Night-Pryanik]

Maybe we should add separate up and down buttons which will move highlighted mod up and down. Just a thought.

[leemuar]

Is it possible to move mods up and down in world creation menu using only mouse?

No, sorry. As far as I know click-and-drag is not possible.

Why not?

[leemuar]

Please note I did a help window scrolling here: #58145

[leemuar]

I did some research, SELECT mouse action currently triggers when user release left mouse button. To make drag possible we only need to add tracking for the event of pressing mouse button. I'll make another PR for dragging support when Im done with my research

[dseguin]

Cheers for the feedback. New changes:

• Redo mouse control for query_popup, only register "SELECT" and "MOUSE_MOVE" when options exist
• Do not check for "MOUSE_MOVE" in uilist when using an external loop
• Undo changes to query_yn and popup (ie: PF_MOUSECTRL)
• Recalc scroll position when resizing
• Remove prefixes from QUIT keybindings
• Use run_for_point_in to process button rectangle logic

[leemuar]

run_for_point_in() is a nice thing, Ill definitely reuse it

[leemuar]

@dseguin, run_for_point_in() iterates over all items in collection, even if it already found a rectangle.
Do you think it is OK? In my cases all rectangles in the collection do not overlap, so finding first is enough to end iteration early.

I can easily copy run_for_point_in() and modify it to be like run_for_first_point_in(), I just want to know you opinion on that. Maybe Im missing some cases where iterating over all rectangles and counting all hits is actually required

[dseguin]

No problem. I've added a default parameter to return early after the first match. These are intended to be general purpose functions so I do want the option to run for any element, but for UI buttons you can just leave first_only as 'true'.

[leemuar]

Finally merged!
It's time to reuse those helper functions!

[leemuar]

Is it possible to move mods up and down in world creation menu using only mouse?

I figured out how to implement it, see #58214 (comment)