FInputModeGameOnly

Data structure used to setup an input mode that allows only the player input / player controller to respond to user input.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FInputModeDataBase

FInputModeGameOnly

References

Module

Engine

Header

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

Include

#include "GameFramework/PlayerController.h"

Syntax

struct FInputModeGameOnly : public FInputModeDataBase

Remarks

Data structure used to setup an input mode that allows only the player input / player controller to respond to user input.

Variables

Name Description

Protected variable

bool

 

bConsumeCaptureMouseDown

Constructors

Name Description

Public function

FInputModeGameOnly()

Functions

Name Description

Public function

FInputModeGa...

 

SetConsumeCaptureMouseDown

(
    bool InConsumeCaptureMouseDown
)

Whether the mouse down that causes capture should be consumed, and not passed to player input processing

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