Navigation
API > API/Runtime > API/Runtime/Engine
Data structure used to setup an input mode that allows the UI to respond to user input, and if the UI doesn't handle it player input / player controller gets a chance.
| Name | FInputModeGameAndUI |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Classes/GameFramework/PlayerController.h |
| Include Path | #include "GameFramework/PlayerController.h" |
Syntax
struct FInputModeGameAndUI : public FInputModeDataBase
Inheritance Hierarchy
- FInputModeDataBase → FInputModeGameAndUI
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FInputModeGameAndUI() |
GameFramework/PlayerController.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FInputModeGameAndUI() |
GameFramework/PlayerController.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FInputModeGameAndUI & SetHideCursorDuringCapture
(
bool InHideCursorDuringCapture |
Whether to hide the cursor during temporary mouse capture caused by a mouse down | GameFramework/PlayerController.h | |
FInputModeGameAndUI & SetLockMouseToViewportBehavior
(
EMouseLockMode InMouseLockMode |
Sets the mouse locking behavior of the viewport | GameFramework/PlayerController.h | |
FInputModeGameAndUI & SetWidgetToFocus
(
TSharedPtr< SWidget > InWidgetToFocus |
Widget to focus | GameFramework/PlayerController.h |
Overridden from FInputModeDataBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FString & GetDebugDisplayName() |
Returns the name of this input mode for debug display when you call the "showdebug input" command. | GameFramework/PlayerController.h | |
virtual bool ShouldFlushInputOnViewportFocus() |
GameFramework/PlayerController.h |
Protected
Overridden from FInputModeDataBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ApplyInputMode
(
FReply& SlateOperations, |
Derived classes override this function to apply the necessary settings for the desired input mode | GameFramework/PlayerController.h |