Set Input Mode "Game & UI" with Common UI plugin

Misak_Samokatian · February 8, 2023, 11:34pm

Thnx you all guys, this topic brought me to the right place and give great starting point! I am working with TopDown setup, Character need move to mouse click position and my widgets need work at this time.
I set in my LyraHUDLayout InputConfig to Game and Menu,
Game Mouse Capture to Capture Durning Mouse Down

and in my LyraActivatableWidget set InputConfig to Menu, Game Mouse Capture to No Capture

This working for me

xi57 · February 9, 2023, 12:19am

This is how you can do it:

The HUD and the C++ need to agree that the appropriate Input Mode is All (Game+Menu). And the mouse capture in my case was CapturePermanently_IncludingInitialMouseDown with an invisible mouse, and CaptureDuringMouseDown with a visible mouse.

More info:

github.com/x157/x157.github.io

Tutorial Request: How to Take Control of the Mouse with CommonUI

opened 03:11AM - 30 Jan 23 UTC

x157

tutorial request

As of UE 5.1, this code implicitly changes the input mode to Menu: ```c++ Play…erController->SetShowMouseCursor(true); ``` And this code does not change the input mode at all: ```c++ PlayerController->SetShowMouseCursor(false); ``` This means any time I want to show/hide the mouse as a part of normal game play I need to explicitly manage the input mode and mouse capture settings every time the mouse visibility changes. Note it's possible the forced switch only occurs if you start off in `Game` only input mode. For certain it happened to me from `Game` mode, it kept forcing me into `Menu` just from making the mouse visible. In my case, I'm trying to use a widget that is on `UI.Layer.Game` that is sometimes active and sometimes not active. I do not want all the input to stop working for the game, I just want the user to be able to click a widget if they want to, or not click it, with a sometimes visible mouse cursor during normal gameplay. Ultimately I solved the problem by overriding `ULyraHUDLayout::GetDesiredInputConfig` such that it returns a different config for when I want the mouse to be visible during gameplay compared to what it returns when I want the mouse to be invisible. (Also explicitly disable `bIsFocusable` for the HUD Layout, or it sometimes starts stealing input(?)). This also required overriding the base `ULyraActivatableWidget::GetDesiredInputConfig` to manage look input ignore settings in the various scenarios since Lyra provides no visibility into or access to set look input ignore preferences. Finally, a complete and total overhaul of `UCommonUIActionRouterBase::ApplyUIInputConfig` was required, I literally had to throw out that entire method and rewrite it all to get it to work. Part of that included not completely ignoring look/move input ignore preferences like it does by default. (In 5.1 this requires a custom engine, in 5.2 the Launcher Engine will support this by default). With all of this in place, I had to write a virtual `PlayerController->SetShowMouseCursor` (which itself is not virtual) and any time I want to show or hide the mouse in my extended `SetShowMouseCursor` I also explicitly call my (hacked to be public) overridden Action Router `ApplyUIInputConfig` with the appropriate config for a visible mouse (or invisible as the case may now be). For all of this to work, the HUD and the C++ need to agree that the appropriate Input Mode is `All` (Game+Menu). And the mouse capture in my case was `CapturePermanently_IncludingInitialMouseDown` with an invisible mouse, and `CaptureDuringMouseDown` with a visible mouse. Furthermore, since I use the mouse for Look input, I disable Look when the mouse cursor is visible, though Move is still active. --- Additional reading related to `Game` capture and mouse weirdness: https://forums.unrealengine.com/t/why-axis-value-of-moveforward-event-is-0-when-left-mouse-button-event/577686/5?u=xi57

Misak_Samokatian · February 9, 2023, 5:57am

Thnx, i was completed task without c++, my solution in my previous post. it’s working great

Peleias · April 4, 2023, 12:54am

Does this only work on Lyra? How do I find this “input config” in normal Unreal 5.1?

Tnkx

Misak_Samokatian · April 4, 2023, 5:43am

Unfortunately this is a custom addition by Epic to the CommonUI plugin in Lyra.
In Lyra you can find Input Config in
Widget > Graph Editor Mode > Class Defaults

E_PepeGamer · April 8, 2023, 5:44pm

Hi @xi57 time has passed and I am currently on 5.2 preview2. As you said in this version CommonUIActionRouterBase.h has changed and the parameter ActiveInputConfig has been moved to protected:

https://github.com/EpicGames/UnrealEngine/commit/2b34c8ce154011a327087ee7e83fdbb6dacd7907

Also looking at the file the ApplyUIInputConfig is now virtual. So regarding the topic of this thread what should I do to change the behaviour of ApplyUIInputConfig without compiling all the engine. Normally I override the classes and then I use this classes as base for blueprints, but how do i tell the engine to use my custom ApplyUIInputConfig?

xi57 · April 10, 2023, 2:22pm

There is some Unreal magic going on in the subsystem. During initialization, the subsystem will only initialize if there are no derived classes existing.

See for example:

bool UCommonUIActionRouterBase::ShouldCreateSubsystem(UObject* Outer) const
{
	TArray<UClass*> ChildClasses;
	GetDerivedClasses(GetClass(), ChildClasses, false);

	UE_LOG(LogUIActionRouter, Display, TEXT("Found %i derived classes when attemping to create action router (%s)"), ChildClasses.Num(), *GetClass()->GetName());

	// Only create an instance if there is no override implementation defined elsewhere
	return ChildClasses.Num() == 0;
}

TLDR simply by you deriving a class from UCommonUIActionRouterBase and compiling it into your project, its existence will suppress the base class from initializing, and your class will be used instead.

So all you have to do is derive a child class and implement it. It will “automagically” replace the base subsystem.

E_PepeGamer · April 18, 2023, 7:14pm

Thx for your reply, I will try.

xi57 · April 24, 2023, 9:34pm

UE 5.2 is releasing any day now, and I’ve published a new tutorial saying exactly how to take full control over the mouse in Lyra 5.2 (and thereby also CommonUI).

YT vid:

Dev notes:

shinji_alex1 · April 26, 2023, 4:07pm

Sorry if I am not fully caught up with the problem you are trying to solve. I am developing on UE/Lyra 5.1 and I have cases where I want the mouse cursor to be captured but shown.

I noticed in FUIInputConfig there is a variable called bHideCursorDuringViewportCapture and by default it is set to true. Because in its constructor bHideCursorDuringViewportCapture has its default value, no parameter is required for this variable, causing this variable to be true all the time in Lyra.

In my project, I have an ActivatableWidget inheriting from LyraActivatableWidget and added bHideCursorDuringViewportCapture as a custom property. Then in GetDesiredInputConfig function, I simply passed the property to FUIInputConfig’s constructor to set whether the mouse is shown or not.

	switch (InputConfig)
	{
	case ELyraWidgetInputMode::GameAndMenu:
		return FUIInputConfig(ECommonInputMode::All, GameMouseCaptureMode, bHideCursorDuringViewportCapture);
	case ELyraWidgetInputMode::Game:
		return FUIInputConfig(ECommonInputMode::Game, GameMouseCaptureMode, bHideCursorDuringViewportCapture);
	case ELyraWidgetInputMode::Menu:
		return FUIInputConfig(ECommonInputMode::Menu, EMouseCaptureMode::NoCapture);
	case ELyraWidgetInputMode::Default:
		checkNoEntry();
	default:
		return TOptional<FUIInputConfig>();
	}

Sorry if I misunderstood the issue you are trying to solve! Just posting it here in case it helps anyone.

AlienRenders · June 8, 2023, 7:29am

I’m trying to use CommonUI (not Lyra) and I watched the whole video. I implemented the C++ function to set the Input Config on the UCommonUIActionRouterBase and I’m still getting the double click problem.

I have no idea what to do.

edit: Ok, I got it working. I didn’t have the main CommonUI widget’s “Is Focusable” set to true. Once I set it to true, it now works.

HeyitsSavio · December 30, 2023, 4:52am

I actually found a solution by just unchecking “Supports Activation Focus” in the widget that im activating, allowing me to still read inputs from legacy input or enhanced input actions when “Game and UI input mode” is active

Inductance · January 11, 2024, 5:44am

Thank you so much!

Javottaja · February 19, 2024, 5:06pm

I’m working with blueprints (UE 5.3.2), and stumbled upon this easy solution:

Untick Enable Default Input Config, and now Set Input Mode function works like it should.
I didn’t check, so I don’t know if this is already documented.

funkyspunky91 · February 22, 2024, 1:32pm

Didn’t seem to help me.

funkyspunky91 · February 22, 2024, 1:33pm

also didnt seem to help me.

conscienc3 · April 15, 2024, 9:35am

Omg again this took me another 1,5h - yes in the end I only needed to uncheck this and it works, that common UI is not catching all input actions.

christoph.codes · July 3, 2024, 7:19pm

This fixed it for me - thanks a lot for pointing this out!

Ji_Rath · August 31, 2024, 7:27pm

It is possible this was mentioned before, but inside of a CommonActivatableWidget, there is an overridable function called GetDesiredInputConfig which can allow you to change input mode to Game, Menu, or All. It also has other settings that you can modify while that widget is active.

xopac · September 21, 2024, 1:22pm

Thank you, this did the trick for me now i’m able to received enhanced input events as usual even when widget is active