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
FInputModeUIOnly Struct Reference

#include <PlayerController.h>

+ Inheritance diagram for FInputModeUIOnly:

Public Member Functions

ENGINE_API FInputModeUIOnly ()
 
virtual ENGINE_API ~FInputModeUIOnly ()
 
ENGINE_API FInputModeUIOnly & SetWidgetToFocus (TSharedPtr< SWidget > InWidgetToFocus)
 
ENGINE_API FInputModeUIOnly & SetLockMouseToViewportBehavior (EMouseLockMode InMouseLockMode)
 

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

TSharedPtr< SWidget > WidgetToFocus
 
EMouseLockMode MouseLockMode
 

Detailed Description

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

Constructor & Destructor Documentation

◆ FInputModeUIOnly()

ENGINE_API FInputModeUIOnly::FInputModeUIOnly ( )

◆ ~FInputModeUIOnly()

virtual ENGINE_API FInputModeUIOnly::~FInputModeUIOnly ( )
virtual

Member Function Documentation

◆ ApplyInputMode()

virtual ENGINE_API void FInputModeUIOnly::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.

◆ SetLockMouseToViewportBehavior()

ENGINE_API FInputModeUIOnly & FInputModeUIOnly::SetLockMouseToViewportBehavior ( EMouseLockMode  InMouseLockMode)

Sets the mouse locking behavior of the viewport

◆ SetWidgetToFocus()

ENGINE_API FInputModeUIOnly & FInputModeUIOnly::SetWidgetToFocus ( TSharedPtr< SWidget >  InWidgetToFocus)

Widget to focus

Member Data Documentation

◆ MouseLockMode

EMouseLockMode FInputModeUIOnly::MouseLockMode
protected

◆ WidgetToFocus

TSharedPtr<SWidget> FInputModeUIOnly::WidgetToFocus
protected
The documentation for this struct was generated from the following file: