Navigation
API > API/Plugins > API/Plugins/EnhancedInput
References
| Module | EnhancedInput |
| Header | /Engine/Plugins/EnhancedInput/Source/EnhancedInput/Public/InputActionValue.h |
| Include | #include "InputActionValue.h" |
Syntax
USTRUCT (BlueprintType ,
Meta=(HasNativeMake="/Script/EnhancedInput.EnhancedInputLibrary.MakeInputActionValueOfType", HasNativeBreak="/Script/EnhancedInput.EnhancedInputLibrary.BreakInputActionValue"))
struct FInputActionValue
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FVector | Value | |
 |
EInputActionValueType | ValueType |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Support all relevant default constructors (FInputActionValue isn't movable) | ||
 |
FInputActionValue
(
const FInputActionValue& |
||
 |
FInputActionValue
(
FKey KeyDefault |
Construct default value for a key. | |
 |
FInputActionValue
(
bool bInValue |
Specialized constructors for supported types Converting a value to a different type (e.g. Val = FVector(1, 1, 1); Val = true;) zeroes out any unused components to ensure getters continue to function correctly. | |
 |
FInputActionValue
(
Axis1D InValue |
||
 |
FInputActionValue
(
Axis2D InValue |
||
 |
FInputActionValue
(
Axis3D InValue |
||
 |
FInputActionValue
(
EInputActionValueType InValueType, |
Build a specific type with an arbitrary Axis3D value. |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
FInputActionValue & | ConvertToType
(
const FInputActionValue& Other |
|
 |
FInputActionValue & | ConvertToType
(
EInputActionValueType Type |
In-place type conversion. |
  |
FInputActionValue::Axis1D | Get () |
|
  |
bool | Get () |
Supported getter specializations. |
  |
T | Get () |
TODO: Would prefer a value type checked version here but this is complicated by the ability to change action value types within the editor. |
  |
FInputActionValue::Axis3D | Get () |
|
  |
FInputActionValue::Axis2D | Get () |
|
  |
float | GetMagnitude () |
|
  |
float | ||
  |
EInputActionValueType | GetValueType () |
|
  |
EInputActionValueType | GetValueTypeFromKey
(
FKey Key |
|
  |
bool | IsNonZero
(
float Tolerance |
|
 |
void | Reset () |
Resets Value without affecting ValueType. |
  |
FString | ToString () |
Type sensitive debug stringify. |
Operators
| Type | Name | Description | |
|---|---|---|---|
 |
FInputActionValue & | operator*=
(
float Scalar |
Scalar operators. |
  |
float | operator[]
(
int32 Index |
Read only index based value accessor, doesn't care about type. Expect 0 when accessing unused components. |
 |
FInputActionValue & | operator+=
(
const FInputActionValue& Rhs |
|
 |
FInputActionValue & | operator=
(
const FInputActionValue& |