UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FInputModeDataBase Struct Referenceabstract

#include <PlayerController.h>

+ Inheritance diagram for FInputModeDataBase:

Protected Member Functions

virtual ~FInputModeDataBase ()
 
virtual void ApplyInputMode (class FReply &SlateOperations, class UGameViewportClient &GameViewportClient) const =0
 
virtual bool ShouldFlushInputOnViewportFocus () const
 
ENGINE_API void SetFocusAndLocking (FReply &SlateOperations, TSharedPtr< class SWidget > InWidgetToFocus, bool bLockMouseToViewport, TSharedRef< class SViewport > InViewportWidget) const
 

Friends

class APlayerController
 

Detailed Description

Abstract base class for Input Mode structures

Constructor & Destructor Documentation

◆ ~FInputModeDataBase()

virtual FInputModeDataBase::~FInputModeDataBase ( )
inlineprotectedvirtual

Member Function Documentation

◆ ApplyInputMode()

virtual void FInputModeDataBase::ApplyInputMode ( class FReply SlateOperations,
class UGameViewportClient GameViewportClient 
) const
protectedpure virtual

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

Implemented in FInputModeUIOnly, FInputModeGameAndUI, and FInputModeGameOnly.

◆ SetFocusAndLocking()

ENGINE_API void FInputModeDataBase::SetFocusAndLocking ( FReply SlateOperations,
TSharedPtr< class SWidget InWidgetToFocus,
bool  bLockMouseToViewport,
TSharedRef< class SViewport InViewportWidget 
) const
protected

Utility functions for derived classes.

◆ ShouldFlushInputOnViewportFocus()

virtual bool FInputModeDataBase::ShouldFlushInputOnViewportFocus ( ) const
inlineprotectedvirtual

Reimplemented in FInputModeGameAndUI.

Friends And Related Symbol Documentation

◆ APlayerController

friend class APlayerController
friend

The documentation for this struct was generated from the following file: