UCommonGameViewportClient::InputKey

Check a key event received by the viewport.

Windows
MacOS
Linux

Override Hierarchy

FViewportClient::InputKey()

UGameViewportClient::InputKey()

UCommonGameViewportClient::InputKey()

References

Module

CommonUI

Header

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

Include

#include "CommonGameViewportClient.h"

Source

/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Private/CommonGameViewportClient.cpp

Syntax

virtual bool InputKey
(
    const FInputKeyEventArgs & EventArgs
)

Remarks

Check a key event received by the viewport. If the viewport client uses the event, it should return true to consume it.

Returns

True to consume the key event, false to pass it on.

Parameters

Parameter

Description

EventArgs

The Input event args.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss