UCommonGameViewportClient

[CommonUI](API\Plugins\CommonUI\CommonUI) Viewport to reroute input to UI first.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

CommonUI

Header

/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonGameViewportClient.h

Include

#include "CommonGameViewportClient.h"

Syntax

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

Remarks

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

Variables

Constructors

Name Description

Public function

UCommonGameViewportClient

(
    FVTableHelper& Helper
)

Destructors

Name Description

Public function Virtual

~UCommonGameViewportClient()

Functions

Name Description

Public function Virtual

void

 

HandleRerouteAxis

(
    int32 ControllerId,
    FKey Key,
    float Delta,
    FReply& Reply
)

Default Handler for Axis input.

Public function Virtual

void

 

HandleRerouteInput

(
    int32 ControllerId,
    FKey Key,
    EInputEvent EventType,
    FReply& Reply
)

Default Handler for Key input.

Public function Virtual

void

 

HandleRerouteTouch

(
    int32 ControllerId,
    uint32 TouchId,
    ETouchType::Type TouchType,
    const FVector2D& TouchLocation,
    FReply& Reply
)

Default Handler for Touch input.

Protected function Virtual

bool

 

IsKeyPriorityAboveUI

(
    const FInputKeyEventArgs& EventArg...
)

Console window & fullscreen shortcut have higher priority than UI

Public function

FOnRerouteAx...

 

OnRerouteAxis()

Public function

FOnRerouteIn...

 

OnRerouteBlockedInput()

Public function

FOnRerouteIn...

 

OnRerouteInput()

Public function

FOnRerouteTo...

 

OnRerouteTouch()

Overridden from FViewportClient

Name Description

Public function Virtual

bool

 

InputAxis

(
    FViewport* Viewport,
    int32 ControllerId,
    FKey Key,
    float Delta,
    float DeltaTime,
    int32 NumSamples,
    bool bGamepad
)

Check an axis movement received by the viewport.

Public function Virtual

bool

 

InputKey

(
    const FInputKeyEventArgs& EventArg...
)

Check a key event received by the viewport.

Public function Virtual

bool

 

InputTouch

(
    FViewport* Viewport,
    int32 ControllerId,
    uint32 Handle,
    ETouchType::Type Type,
    const FVector2D& TouchLocation,
    float Force,
    FDateTime DeviceTimestamp,
    uint32 TouchpadIndex
)

Check a key event received by the viewport.