UCommonGameViewportClient | Unreal Engine 5.7 Documentation

CommonUI Viewport to reroute input to UI first. Needed to allow CommonUI to route / handle inputs.


Name	UCommonGameViewportClient
Type	class
Header File	/Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonGameViewportClient.h
Include Path	#include "CommonGameViewportClient.h"

Syntax

UCLASS (MinimalAPI, Within=Engine, Transient, Config=Engine)  
class UCommonGameViewportClient : public UGameViewportClient

Name	Remarks	Include Path	Unreal Specifiers
UCommonGameViewportClient ( FVTableHelper& Helper )		CommonGameViewportClient.h

Name	Remarks	Include Path
virtual void HandleRerouteAxis ( FInputDeviceId DeviceId, FKey Key, float Delta, FReply& Reply )	Default Handler for Axis input.	CommonGameViewportClient.h
virtual void HandleRerouteInput ( FInputDeviceId DeviceId, FKey Key, EInputEvent EventType, FReply& Reply )	Default Handler for Key input.	CommonGameViewportClient.h
virtual void HandleRerouteTouch ( int32 ControllerId, uint32 TouchId, ETouchType::Type TouchType, const FVector2D& TouchLocation, FReply& Reply )	Default Handler for Touch input.	CommonGameViewportClient.h
virtual void HandleRerouteTouch ( FInputDeviceId DeviceId, uint32 TouchId, ETouchType::Type TouchType, const FVector2D& TouchLocation, FReply& Reply )		CommonGameViewportClient.h
FOnRerouteAxisDelegate & OnRerouteAxis()		CommonGameViewportClient.h
FOnRerouteInputDelegate & OnRerouteBlockedInput()		CommonGameViewportClient.h
FOnRerouteInputDelegate & OnRerouteInput()		CommonGameViewportClient.h
PRAGMA_DISABLE_DEPRECATION_WARNINGSFOnRerouteTouchDelegate & OnRerouteTouch()		CommonGameViewportClient.h
PRAGMA_ENABLE_DEPRECATION_WARNINGSFOnRerouteTouchInputDelegate & OnRerouteTouchInput()		CommonGameViewportClient.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void CapturedMouseMove ( FViewport* InViewport, int32 X, int32 Y )		CommonGameViewportClient.h
virtual bool InputAxis ( const FInputKeyEventArgs& Args )		CommonGameViewportClient.h
virtual bool InputKey ( const FInputKeyEventArgs& EventArgs )		CommonGameViewportClient.h
virtual bool InputTouch ( FViewport* Viewport, const FInputDeviceId DeviceId, uint32 Handle, ETouchType::Type Type, const FVector2D& TouchLocation, float Force, uint32 TouchpadIndex, const uint64 Timestamp )		CommonGameViewportClient.h
virtual void MouseMove ( FViewport* InViewport, int32 X, int32 Y )		CommonGameViewportClient.h

Name	Remarks	Include Path	Unreal Specifiers
virtual bool IsKeyPriorityAboveUI ( const FInputKeyEventArgs& EventArgs )	Console window & fullscreen shortcut have higher priority than UI	CommonGameViewportClient.h