FInputActionValue

Choose your operating system:

Windows

macOS

Linux

References

Module

EnhancedInput

Header

/Engine/Plugins/Experimental/EnhancedInput/Source/EnhancedInput/Public/InputActionValue.h

Include

#include "InputActionValue.h"

Syntax

USTRUCT(BlueprintType,
        Meta=(HasNativeMake="EnhancedInput.EnhancedInputLibrary.MakeInputActionValue", HasNativeBreak="EnhancedInput.EnhancedInputLibrary.BreakInputActionValue"))
struct FInputActionValue

Variables

Name Description

Protected variable

FVector

 

Value

Protected variable

EInputActionVal...

 

ValueType

Constructors

Name Description

Public function

FInputActionValue()

Support all relevant default constructors (FInputActionValue isn't movable)

Public function

FInputActionValue

(
    const FInputActionValue&
)

Public function

FInputActionValue

(
    FKey KeyDefault
)

Construct default value for a key.

Public function

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.

Public function

FInputActionValue

(
    Axis1D InValue
)

Public function

FInputActionValue

(
    Axis2D InValue
)

Public function

FInputActionValue

(
    Axis3D InValue
)

Public function

FInputActionValue

(
    EInputActionValueType InValueType,
    Axis3D InValue
)

Build a specific type with an arbitrary Axis3D value.

Functions

Name Description

Public function

FInputAction...

 

ConvertToType

(
    const FInputActionValue& Other
)

Public function

FInputAction...

 

ConvertToType

(
    EInputActionValueType Type
)

In-place type conversion.

Public function Const

FInputAction...

 

Get()

Public function Const

bool

 

Get()

Supported getter specializations.

Public function Const

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.

Public function Const

FInputAction...

 

Get()

Public function Const

FInputAction...

 

Get()

Public function Const

float

 

GetMagnitude()

Public function Const

float

 

GetMagnitudeSq()

Public function Const

EInputAction...

 

GetValueType()

Public function Static

EInputAction...

 

GetValueTypeFromKey

(
    FKey Key
)

Public function Const

bool

 

IsNonZero

(
    float Tolerance
)

Public function

void

 

Reset()

Resets Value without affecting ValueType.

Public function Const

FString

 

ToString()

Type sensitive debug stringify.

Operators

Name Description

Public function

FInputAction...

 

operator*=

(
    float Scalar
)

Scalar operators.

Public function Const

float

 

operator[]

(
    int32 Index
)

Read only index based value accessor, doesn't care about type. Expect 0 when accessing unused components.

Public function

FInputAction...

 

operator+=

(
    const FInputActionValue& Rhs
)

Public function

FInputAction...

 

operator=

(
    const FInputActionValue&
)

Typedefs

Name

Description

Axis1D

Using Button = bool;

Axis2D

Axis3D