FInputModeUIOnly

Data structure used to setup an input mode that allows only the UI to respond to user input.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FInputModeDataBase

FInputModeUIOnly

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/GameFramework/PlayerController.h

Include

#include "GameFramework/PlayerController.h"

Syntax

struct FInputModeUIOnly : public FInputModeDataBase

Remarks

Data structure used to setup an input mode that allows only the UI to respond to user input.

Variables

Name Description

Protected variable

EMouseLockMode

 

MouseLockMode

Protected variable

TSharedPtr< SWi...

 

WidgetToFocus

Constructors

Name Description

Public function

FInputModeUIOnly()

Functions

Name Description

Public function

FInputModeUI...

 

SetLockMouseToViewportBehavior

(
    EMouseLockMode InMouseLockMode
)

Sets the mouse locking behavior of the viewport

Public function

FInputModeUI...

 

SetWidgetToFocus

(
    TSharedPtr< SWidget > InWidgetToFoc...
)

Widget to focus

Overridden from FInputModeDataBase

Name Description

Protected function Virtual Const

void

 

ApplyInputMode

(
    FReply& SlateOperations,
    UGameViewportClient& GameViewportC...
)

Derived classes override this function to apply the necessary settings for the desired input mode