1. Epic GamesDeveloper
  3. FInputKeyEventArgs

FInputKeyEventArgs

Function Overloads

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/FInputKeyEventArgs

Overloads

Name Remarks Include Path Unreal Specifiers
  InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
FInputDeviceId InInputDevice,
FKey InKey,
EInputEvent InEvent
)

   InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
int32 InControllerId,
FKey InKey,
EInputEvent InEvent
)

   InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
const FInputDeviceId InInputDevice,
const FKey& InKey,
const EInputEvent InEvent,
const uint64 InEventTimestamp
)

 Constrcut a FInputKeyEventArgs based on data acquired from the Slate input events. InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
FInputDeviceId InInputDevice,
FKey InKey,
EInputEvent InEvent,
float InAmountDepressed,
bool bInIsTouchEvent
)

   InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
int32 InControllerId,
FKey InKey,
EInputEvent InEvent,
float InAmountDepressed,
bool bInIsTouchEvent
)

   InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
const FInputDeviceId InInputDevice,
const FKey& InKey,
const EInputEvent InEvent,
const float InAmountDepressed,
const bool bInIsTouchEvent,
const uint64 InEventTimestamp
)

 Construct a FInputKeyEventArgs based on data acquired from the Slate input events. InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
const FInputDeviceId InInputDevice,
const FKey& InKey,
const float InDelta,
const float InDeltaTime,
const int32 InNumSamples,
const uint64 InEventTimestamp
)

 Construct a FInputKeyEventArgs based on the old params of the ViewportClient InputAxis function. InputKeyEventArgs.h  

FInputKeyEventArgs()

   
Name FInputKeyEventArgs
Type function
Header File /Engine/Source/Runtime/Engine/Public/InputKeyEventArgs.h
Include Path #include "InputKeyEventArgs.h" 
FInputKeyEventArgs()

FInputKeyEventArgs(FViewport *, FInputDeviceId, FKey, EInputEvent)

   
Name FInputKeyEventArgs
Type function
Header File /Engine/Source/Runtime/Engine/Public/InputKeyEventArgs.h
Include Path #include "InputKeyEventArgs.h" 
FInputKeyEventArgs  
(  
    FViewport * InViewport,  
    FInputDeviceId InInputDevice,  
    FKey InKey,  
    EInputEvent InEvent  
)

FInputKeyEventArgs(FViewport *, int32, FKey, EInputEvent)

   
Name FInputKeyEventArgs
Type function
Header File /Engine/Source/Runtime/Engine/Public/InputKeyEventArgs.h
Include Path #include "InputKeyEventArgs.h" 
FInputKeyEventArgs  
(  
    FViewport * InViewport,  
    int32 InControllerId,  
    FKey InKey,  
    EInputEvent InEvent  
)

FInputKeyEventArgs(FViewport *, const FInputDeviceId, const FKey &, const EInputEvent, const uint64)

Description

Constrcut a FInputKeyEventArgs based on data acquired from the Slate input events. These event args are used to translate from Slate input event arguments into a standardized form for the ViewportClient and then the rest of the gameplay framework.

   
Name FInputKeyEventArgs
Type function
Header File /Engine/Source/Runtime/Engine/Public/InputKeyEventArgs.h
Include Path #include "InputKeyEventArgs.h" 
FInputKeyEventArgs  
(  
    FViewport * InViewport,  
    const FInputDeviceId InInputDevice,  
    const FKey & InKey,  
    const EInputEvent InEvent,  
    const uint64 InEventTimestamp  
)

Parameters

Name Remarks
InViewport The viewport which the axis movement is from.
InInputDevice The input device that triggered this axis movement
InKey The name of the axis which moved.
InEvent The key event that these args represent.
InEventTimestamp The timestamp of when this input event was originally polled in the form of CPU cycles.

FInputKeyEventArgs(FViewport *, FInputDeviceId, FKey, EInputEvent, float, bool)

   
Name FInputKeyEventArgs
Type function
Header File /Engine/Source/Runtime/Engine/Public/InputKeyEventArgs.h
Include Path #include "InputKeyEventArgs.h" 
FInputKeyEventArgs  
(  
    FViewport * InViewport,  
    FInputDeviceId InInputDevice,  
    FKey InKey,  
    EInputEvent InEvent,  
    float InAmountDepressed,  
    bool bInIsTouchEvent  
)

FInputKeyEventArgs(FViewport *, int32, FKey, EInputEvent, float, bool)

   
Name FInputKeyEventArgs
Type function
Header File /Engine/Source/Runtime/Engine/Public/InputKeyEventArgs.h
Include Path #include "InputKeyEventArgs.h" 
FInputKeyEventArgs  
(  
    FViewport * InViewport,  
    int32 InControllerId,  
    FKey InKey,  
    EInputEvent InEvent,  
    float InAmountDepressed,  
    bool bInIsTouchEvent  
)

FInputKeyEventArgs(FViewport *, const FInputDeviceId, const FKey &, const EInputEvent, const float, const bool, const uint64)

Description

Construct a FInputKeyEventArgs based on data acquired from the Slate input events. These event args are used to translate from Slate input event arguments into a standardized form for the ViewportClient and then the rest of the gameplay framework.

   
Name FInputKeyEventArgs
Type function
Header File /Engine/Source/Runtime/Engine/Public/InputKeyEventArgs.h
Include Path #include "InputKeyEventArgs.h"
Source /Engine/Source/Runtime/Engine/Private/InputKeyEventArgs.cpp 
FInputKeyEventArgs  
(  
    FViewport * InViewport,  
    const FInputDeviceId InInputDevice,  
    const FKey & InKey,  
    const EInputEvent InEvent,  
    const float InAmountDepressed,  
    const bool bInIsTouchEvent,  
    const uint64 InEventTimestamp  
)

Parameters

Name Remarks
InViewport The viewport which the axis movement is from.
InInputDevice The input device that triggered this axis movement
InKey The name of the axis which moved.
InEvent The key event that these args represent.
InAmountDepressed For axis events, the amount that the key is depressed
bInIsTouchEvent True if this event represents a touch input
InEventTimestamp The timestamp of when this input event was originally polled in the form of CPU cycles.

FInputKeyEventArgs(FViewport *, const FInputDeviceId, const FKey &, const float, const float, const int32, const uint64)

Description

Construct a FInputKeyEventArgs based on the old params of the ViewportClient InputAxis function.

   
Name FInputKeyEventArgs
Type function
Header File /Engine/Source/Runtime/Engine/Public/InputKeyEventArgs.h
Include Path #include "InputKeyEventArgs.h" 
FInputKeyEventArgs  
(  
    FViewport * InViewport,  
    const FInputDeviceId InInputDevice,  
    const FKey & InKey,  
    const float InDelta,  
    const float InDeltaTime,  
    const int32 InNumSamples,  
    const uint64 InEventTimestamp  
)

Parameters

Name Remarks
InViewport The viewport which the axis movement is from.
InInputDevice The input device that triggered this axis movement
InKey The name of the axis which moved.
InDelta The axis movement delta.
InDeltaTime The time since the last axis update.
InNumSamples The number of device samples that contributed to this Delta, useful for things like smoothing
InEventTimestamp The timestamp of when this input event was originally polled in the form of CPU cycles.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page