Re-add temporary mouse support via mouse middle click

[LevFendi]

This is very much a sighted dev request but it might benefit partially sighted players too, not sure.

There is a case to be made for scenarios where you want to use the mouse to press GUI buttons or select and open entities while the mod is running. However the mod does not allow this because the mouse pointer is continuously forced to sync with the mod cursor and its ability to select entities or use left bracket actions are all disabled.

I had a workaround in the older version of the mod where pressing the middle mouse button would temporarily restore mouse control in the following ways:

1. The mouse pointer should no longer be forced to move to the mod cursor location. Ever. This is easy to do by adding a single check at the function doing this rather than looking at where it is called.
2. The mouse pointer should once again be allowed to select entities and tiles. I think there was a boolean property that can be toggled on or off to allow this. The related setting is this.
3. Mouse clicks should register as left/right clicks. EDIT: This seems to already be supported.

Note that this exactly matches a subset of the proposed Vanilla Mode (#334). If we opt for "just use vanilla mode if you want to use the mouse" then we lose the narrator and possibly change multiple things at once when all we really want to do is be able to use the mouse. Therefore we need this as a separate solution.

Originally this feature was made temporary by disabling it when the mod cursor is moved. If we want it to be a clean and self-contained feature we can instead just make it toggled on or off entirely by using middle mouse click.

[ahicks92]

I think the better question is if (or why) we want to keep mouse movement at all. The easy fix is to just not grab control of the mouse, and as of 2.0 the only reason left to do that may possibly be something to do with graphics syncing being as nothing in the mod relies on it anymore.

[LevFendi]

So the only remaining reason for "Why would the mod need to move the mouse pointer?" is to make mouse pointer building previews match up with the building footprints. If we don't do this, then the preview is just independently attached to the mouse pointer and probably in the wrong place while the mod's building footprint remains accurate. This is not a massive loss, but it is nice to keep the feature in while we have it.

If you prefer to make the mod simpler and more maintainable (especially for blind devs), then yes, we can remove everything that forces the mouse pointer movement.

As an alternative approach, because of our only remaining use case depending on cursor movement, we can remove the mouse pointer movement from being an on_tick thing and instead have it called as a part of "sync_build_cursor_graphics".

[ahicks92]

I would rather keep the mouse movement thing in on_tick, and the next time that graphics breaks I am going to be advocating hard for you to do my on_tick solution, not just fix the existing paths. There is a reasonably easy on_tick fix to this: debounce mouse changes and accept that the player needs to move the cursor once after save load before the mouse synchronizes.

What I need to understand is whether or not the problem with selecting for you goes deeper than this. In particular, my understanding is that with the setting you are referring to toggled, you can still select by clicking or something, if the mod were not interfering.

This will do what the mod does to selection modulo us being aggressive with actually trying to control player.selected, if run in a save without the mod:

/c game.player.game_view_settings.update_entity_selection = false

Can you run that and see if not being able to select entities is an us problem? I think you can still somehow, but maybe it genuinely entirely disables it, and if so then our issue is larger.

[LevFendi]

I am unable to control this setting with the console while the mod is enabled because we have the setting forced true or false on every tick.

In scripts/no-hover.lua, line 7 it is constantly set to false except for vanilla mode.

In control.lua, line 327 it is constantly set to true during vanilla mode as a part of move_characters.

If we want to control this with mouse button 3 (which is already partially in the code) we probably need to maintain a separate bool such as "VanillaMode.mouseUnlocked". This bool would be toggled by mouse button 3 and it would be overwritten when vanilla mode itself is toggled.

[LevFendi]

I tested the setting with the mod disabled. In this case this feature works as expected: When you turn it off, the mouse pointer is unable to alter entity selection any more and left click opens whatever you had last selected.

When I was working with this setting while developing for version 1, I made sure that the the mod itself does not depend on this setting. Instead it scans the cursor tile itself instead with the function "get_first_ent_at_tile".