Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Engine > UConsole > UConsole::InputKey_Open

Light Theme

Dark Theme

UConsole::InputKey_Open

Process an input key event routed through unrealscript from another object.

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/Console.h
Include	#include "Engine/Console.h"
Source	/Engine/Source/Runtime/Engine/Private/UserInterface/Console.cpp

Syntax

virtual bool InputKey_Open
(
    int32 ControllerId,
    FKey Key,
    EInputEvent Event,
    float AmountDepressed,
    bool bGamepad
)

Remarks

Process an input key event routed through unrealscript from another object. This method is assigned as the value for the OnReceivedNativeInputKey delegate so that native input events are routed to this unrealscript function.

Returns

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

Parameters

Parameter	Description
ControllerId	the controller that generated this input key event
Key	the name of the key which an event occured for (KEY_Up, KEY_Down, etc.)
EventType	the type of event which occured (pressed, released, etc.)
AmountDepressed	for analog keys, the depression percent.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss