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 > Plugins > EnhancedInput > FInputActionValue

Light Theme

Dark Theme

FInputActionValue

Windows

MacOS

Linux

References

Module	EnhancedInput
Header	/Engine/Plugins/Experimental/EnhancedInput/Source/EnhancedInput/Public/InputActionValue.h
Include	#include "InputActionValue.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType),
Meta=(HasNativeMake="EnhancedInput.EnhancedInputLibrary.MakeInputActionValue", HasNativeBreak="EnhancedInput.EnhancedInputLibrary.BreakInputActionValue"))
struct FInputActionValue

Variables

		Name	Description
	FVector	Value
	EInputActionVal...	ValueType

Constructors

	Name	Description
	FInputActionValue()	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, Axis3D InValue )	Build a specific type with an arbitrary Axis3D value.

Functions

	Name	Description
FInputAction...	ConvertToType ( const FInputActionValue& Other )
FInputAction...	ConvertToType ( EInputActionValueType Type )	In-place type conversion.
FInputAction...	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.
FInputAction...	Get()
FInputAction...	Get()
float	GetMagnitude()
float	GetMagnitudeSq()
EInputAction...	GetValueType()
EInputAction...	GetValueTypeFromKey ( FKey Key )
bool	IsNonZero ( float Tolerance )
void	Reset()	Resets Value without affecting ValueType.
FString	ToString()	Type sensitive debug stringify.

Operators

	Name	Description
FInputAction...	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.
FInputAction...	operator+= ( const FInputActionValue& Rhs )
FInputAction...	operator= ( const FInputActionValue& )

Typedefs

Name	Description
Axis1D	Using Button = bool;
Axis2D
Axis3D

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

Take our survey

Dismiss