UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FInputModeGameOnly Struct Reference

#include <PlayerController.h>

+ Inheritance diagram for FInputModeGameOnly:

Public Member Functions

ENGINE_API FInputModeGameOnly ()
 
virtual ENGINE_API ~FInputModeGameOnly ()
 
FInputModeGameOnly & SetConsumeCaptureMouseDown (bool InConsumeCaptureMouseDown)
 

Protected Member Functions

virtual ENGINE_API void ApplyInputMode (FReply &SlateOperations, class UGameViewportClient &GameViewportClient) const override
 
- Protected Member Functions inherited from FInputModeDataBase
virtual ~FInputModeDataBase ()
 
virtual bool ShouldFlushInputOnViewportFocus () const
 
ENGINE_API void SetFocusAndLocking (FReply &SlateOperations, TSharedPtr< class SWidget > InWidgetToFocus, bool bLockMouseToViewport, TSharedRef< class SViewport > InViewportWidget) const
 

Protected Attributes

bool bConsumeCaptureMouseDown
 

Detailed Description

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

Constructor & Destructor Documentation

◆ FInputModeGameOnly()

ENGINE_API FInputModeGameOnly::FInputModeGameOnly ( )

◆ ~FInputModeGameOnly()

virtual ENGINE_API FInputModeGameOnly::~FInputModeGameOnly ( )
virtual

Member Function Documentation

◆ ApplyInputMode()

virtual ENGINE_API void FInputModeGameOnly::ApplyInputMode ( FReply &  SlateOperations,
class UGameViewportClient &  GameViewportClient 
) const
overrideprotectedvirtual

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

Implements FInputModeDataBase.

◆ SetConsumeCaptureMouseDown()

FInputModeGameOnly & FInputModeGameOnly::SetConsumeCaptureMouseDown ( bool  InConsumeCaptureMouseDown)
inline

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

Member Data Documentation

◆ bConsumeCaptureMouseDown

bool FInputModeGameOnly::bConsumeCaptureMouseDown
protected
The documentation for this struct was generated from the following file: