Navigation
API > API/Plugins > API/Plugins/CommonUI
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
Inheritance Hierarchy
- FViewportClient → FCommonViewportClient → UScriptViewportClient → UGameViewportClient → UCommonGameViewportClient
- UObjectBase → UObjectBaseUtility → UObject → UScriptViewportClient → UGameViewportClient → UCommonGameViewportClient
- FExec → UGameViewportClient → UCommonGameViewportClient
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCommonGameViewportClient
(
FVTableHelper& Helper |
CommonGameViewportClient.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void HandleRerouteAxis
(
FInputDeviceId DeviceId, |
Default Handler for Axis input. | CommonGameViewportClient.h | |
virtual void HandleRerouteInput
(
FInputDeviceId DeviceId, |
Default Handler for Key input. | CommonGameViewportClient.h | |
virtual void HandleRerouteTouch
(
int32 ControllerId, |
Default Handler for Touch input. | CommonGameViewportClient.h | |
virtual void HandleRerouteTouch
(
FInputDeviceId DeviceId, |
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 |
Overridden from FViewportClient
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CapturedMouseMove
(
FViewport* InViewport, |
CommonGameViewportClient.h | ||
virtual bool InputAxis
(
const FInputKeyEventArgs& Args |
CommonGameViewportClient.h | ||
virtual bool InputKey
(
const FInputKeyEventArgs& EventArgs |
CommonGameViewportClient.h | ||
virtual bool InputTouch
(
FViewport* Viewport, |
CommonGameViewportClient.h | ||
virtual void MouseMove
(
FViewport* InViewport, |
CommonGameViewportClient.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsKeyPriorityAboveUI
(
const FInputKeyEventArgs& EventArgs |
Console window & fullscreen shortcut have higher priority than UI | CommonGameViewportClient.h |