set_custom_mouse_cursor() while set_mouse_mode(Input.MOUSE_MODE_HIDDEN) results in incorrect cursor when the cursor is made visible again

[ErwinBr]

Describe the project you are working on:

A classic point & click adventure game.

Describe the problem or limitation you are having in your project:

My custom mouse cursor in my game changes by setting set_custom_mouse_cursor when hovering over interactive objects and hotspots. When the game is "busy" with displaying dialogue, for example, the mouse is hidden with set_mouse_mode(Input.MOUSE_MODE_HIDDEN). Users can however still mouse around. Unfortunately this results in the wrong mouse cursor being displayed when we return to normal, as a hidden cursor does not seem to be updated. I now have to manage a lot of exception handling to mitigate the issue, and it's a pain to get it right.

Describe the feature / enhancement and how it helps to overcome the problem or limitation:

Simply being able to change the custom mouse cursor while it's hidden would help tremendously.

Describe how your proposal will work, with code, pseudocode, mockups, and/or diagrams:

N/A

If this enhancement will not be used often, can it be worked around with a few lines of script?:

I need to do a lot of exception handling resulting In messy code for something which could be easily solved. (I assume!)

Is there a reason why this should be core and not an add-on in the asset library?:

I believe the nature of this feature/enhancement would lend more to a change in the core model rather than an add-on.

[Calinou]

This check is currently done on Windows, macOS and Linux. HTML5 doesn't check for the mouse mode before setting a custom cursor image.

godot/platform/windows/display_server_windows.cpp

Lines 1335 to 1337 in 1a53ee6

	if (mouse_mode == MOUSE_MODE_VISIBLE || mouse_mode == MOUSE_MODE_CONFINED) {
	SetCursor(cursors[p_shape]);
	}

godot/platform/osx/display_server_osx.mm

Lines 2968 to 2970 in 1a53ee6

	if (mouse_mode == MOUSE_MODE_VISIBLE || mouse_mode == MOUSE_MODE_CONFINED) {
	[cursor set];
	}

godot/platform/linuxbsd/display_server_x11.cpp

Lines 1826 to 1830 in 1a53ee6

	if (mouse_mode == MOUSE_MODE_VISIBLE || mouse_mode == MOUSE_MODE_CONFINED) {
	for (Map<WindowID, WindowData>::Element *E = windows.front(); E; E = E->next()) {
	XDefineCursor(x11_display, E->get().x11_window, cursors[p_shape]);
	}
	}

Feel free to remove the check, build the engine and test it to see if it works as expected.

[Calinou]

I can't reproduce this issue on both 3.3.2 and master Git 8d4f56a with the following minimal reproduction projects on Linux. This is likely a Windows-specific issue.

• test_mouse_cursor_hidden.zip (master)
• test_mouse_cursor_hidden_3.x.zip (3.x)

I'll move this to the main Godot repository as this is a bug, rather than a feature proposal.