Linux game mode esc exit hotfix #16074
Conversation
nicholas-rh
force-pushed
the
linux_exit_game_mode
branch
from
8796b21
to
0d61935
Compare
This is a hotfix (may not be the ideal solution) for the current issue of not being able to exit the game mode in Linux after entering. Signed-off-by: Nicholas Frizzell <nfrizzel@redhat.com>
nicholas-rh
force-pushed
the
linux_exit_game_mode
branch
from
0d61935
to
d0e229c
Compare
There was a problem hiding this comment.
It looks okay to me. It also sounds like this fix is considered a temp fix? It may be helpful to either open an issue about what might be the "real" full fix and link it here, so that it doesn't get lost.
My remaining concern would be how this behaves on other operating systems besides linux. If linux was the odd one out, adding this code in a non-linux section would affect the others, which were presumably working.
|
Is the issue that IMGUI is swallowing the input, or that the ESC key input is not correctly captured? IMGUI at one time, was not a required gem, in which case, would projects without IMGUI gem enabled still have this issue? |
|
@kberg-amzn is this possibly related to #15891 ? |
When testing commit 9b07c7c (parent commit of this PR commit) and manually removing ImGui from project.json + rebuilding, the problem of not being to exit game mode still seems to happen, which possibly lends credence to the idea that ESC isn't being captured where it should be outside of any influence from ImGui. It's also possible there is other ImGui code still hanging around though (seems to be some hooks in Atom for example). It seems like there are several places which listen for an ESC key press and try to exit game mode, but when testing with lldb and setting breakpoints on them I was never able to get them to trigger. |
|
|
||
| if (inputChannel.GetInputChannelId() == AzFramework::InputDeviceKeyboard::Key::Escape) | ||
| { | ||
| CSystem *cSys = (CSystem*)GetISystem(); |
There was a problem hiding this comment.
standards: static_cast should be preferred here instead of a C-style cast according to the coding standards: https://github.com/o3de/sig-core/blob/main/governance/Coding-Standards-and-Style-Guide.md#casting
There was a problem hiding this comment.
Fixed in 368d220
Signed-off-by: Nicholas Frizzell <nfrizzel@redhat.com>
Sorry for the delay I haven't forgotten about this, I set up a Windows guest VM but was running into some problems so I'll double check everything for compatibility once I get an actual installation up and running. As far as temp vs. permanent fix, for this solution I mostly copied the preexisting key press event logic which was removed from the XConsole code into the equivalent ImGui handler. From a bigger architectural standpoint it may or may not actually belong there since there are other points in the code where an ESC key press to exit game mode seem to be attempted to be handled. If it doesn't then I imagine there are some other larger changes that would need to be made to rectify this. In the meantime this seems to work as a solution on Linux. |
It's possible. I removed extra imgui and legacy cry console key binding in that change. I didn't add any new key binding that might swallow input unexpectedly, but that invisible cry console was definitely ticking and doing strange things like capturing all inputs and making it appear the player had lost all input binding. It could possibly still have been critical path for escape key handling and I missed it during testing. |
spham-amzn
added
the
sig/platform
This is a temporary hotfix (may not be the ideal solution) for the current issue of not being able to exit the game mode in Linux after entering. Opening a PR for it to gather feedback.
What does this PR do?
Allow for exiting from game mode using ESC as intended.
Please add links to any issues, RFCs or other items that are relevant to this PR.
#15958
How was this PR tested?
Tested on Fedora 38, by checking to see if exiting game mode was possible by pressing ESC.