UGameViewportClient::InputKey

Check a key event received by the viewport.

Choose your operating system:

Windows

macOS

Linux

Override Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/GameViewportClient.h

Include

#include "Engine/GameViewportClient.h"

Source

/Engine/Source/Runtime/Engine/Private/GameViewportClient.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.