1. Epic GamesDeveloper
  3. FModuleInputValue

FModuleInputValue

API > API/Runtime > API/Runtime/ChaosVehiclesCore

   
Name FModuleInputValue
Type struct
Header File /Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Public/SimModule/ModuleInput.h
Include Path #include "SimModule/ModuleInput.h"

Syntax

USTRUCT (BlueprintType )  
struct FModuleInputValue

Constructors

Name Remarks Include Path Unreal Specifiers
Support all relevant default constructors (FModuleInputValue isn't movable) SimModule/ModuleInput.h  
  SimModule/ModuleInput.h  

FModuleInputValue ( 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. SimModule/ModuleInput.h  

FModuleInputValue ( MInteger InValue
)

   SimModule/ModuleInput.h  

FModuleInputValue ( MAxis1D InValue
)

   SimModule/ModuleInput.h  

FModuleInputValue ( EModuleInputValueType InValueType,
MAxis3D InValue
)

 Build a specific type with an arbitrary Axis3D value. SimModule/ModuleInput.h  

FModuleInputValue ( MAxis3D InValue
)

   SimModule/ModuleInput.h  

FModuleInputValue ( EModuleInputValueType InValueType,
MInteger InValue
)

 Build a specific type with an Integer value. SimModule/ModuleInput.h  

FModuleInputValue ( MAxis2D InValue
)

   SimModule/ModuleInput.h  

Typedefs

Name Type Remarks Include Path
MAxis1D double   SimModule/ModuleInput.h
MAxis2D FVector2D   SimModule/ModuleInput.h
MAxis3D FVector   SimModule/ModuleInput.h
MInteger int32   SimModule/ModuleInput.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Combine ( const FModuleInputValue& With
)

   SimModule/ModuleInput.h  
  SimModule/ModuleInput.h  
In-place type conversion. SimModule/ModuleInput.h  

void Decay ( const float DecayAmount
)

   SimModule/ModuleInput.h  

void DeltaNetSerialize ( FArchive& Ar,
UPackageMap* Map,
bool& bOutSuccess,
const FModuleInputValue& PreviousInputValue,
EModuleInputQuantizationType InInputQuantizationType
)

   SimModule/ModuleInput.h  

T Get ()

   SimModule/ModuleInput.h  

bool Get ()

 Supported getter specializations. SimModule/ModuleInput.h  

FModuleInputValue::MAxis1D Get ()

   SimModule/ModuleInput.h  

FModuleInputValue::MAxis2D Get ()

   SimModule/ModuleInput.h  

FModuleInputValue::MAxis3D Get ()

   SimModule/ModuleInput.h  

FModuleInputValue::MInteger Get ()

   SimModule/ModuleInput.h  

float GetMagnitude()

   SimModule/ModuleInput.h  

int32 GetMagnitudeInt()

   SimModule/ModuleInput.h  

float GetMagnitudeSq()

   SimModule/ModuleInput.h  

EModuleInputValueType GetValueType()

   SimModule/ModuleInput.h  

bool IsNonZero ( float Tolerance
) const

   SimModule/ModuleInput.h  

bool IsQuantizedNonZero ( EModuleInputQuantizationType InInputQuantizationType,
float Tolerance
) const

   SimModule/ModuleInput.h  

void Lerp ( const FModuleInputValue& Min,
const FModuleInputValue& Max,
float Alpha
)

   SimModule/ModuleInput.h  

void Merge ( const FModuleInputValue& From
)

   SimModule/ModuleInput.h  

void NetSerialize ( FArchive& Ar,
UPackageMap* Map,
bool& bOutSuccess,
EModuleInputQuantizationType InInputQuantizationType
)

   SimModule/ModuleInput.h  

void Reset()

 Resets Value without affecting ValueType. SimModule/ModuleInput.h  

FModuleInputValue ReturnQuantized ( EModuleInputQuantizationType InInputQuantizationType
) const

   SimModule/ModuleInput.h  

void Serialize ( FArchive& Ar,
UPackageMap* Map,
bool& bOutSuccess,
EModuleInputQuantizationType InInputQuantizationType
)

 Serialize values. SimModule/ModuleInput.h  

void Set ( const FModuleInputValue& In
)

 Set only the value without overriding the other properties in FModuleInputValue SimModule/ModuleInput.h  

void SetApplyInputDecay ( const bool bInApplyInputDecay
)

 During physics resimulation, apply decay for this input while it's being extrapolated SimModule/ModuleInput.h  

void SetClearAfterConsumed ( const bool bInClearAfterConsumed
)

 After simulation first consumes the input, clear the value doesn't persist across multiple async physics ticks SimModule/ModuleInput.h  

bool ShouldApplyInputDecay()

   SimModule/ModuleInput.h  

bool ShouldClearAfterConsumed()

   SimModule/ModuleInput.h  

FString ToString()

 Type sensitive debug stringify. SimModule/ModuleInput.h  

Protected

Name Remarks Include Path Unreal Specifiers

void SetMagnitude ( float NewSize
)

   SimModule/ModuleInput.h  

Static

Name Remarks Include Path Unreal Specifiers

static FModuleInputValue Clamp ( const FModuleInputValue& InValue,
const float InMin,
const float InMax
)

   SimModule/ModuleInput.h  

static void Quantize ( double& InOutValue,
EModuleInputQuantizationType InInputQuantizationType
)

   SimModule/ModuleInput.h  

static bool SerializeQuantized ( double& InOutValue,
FArchive& Ar,
EModuleInputQuantizationType InInputQuantizationType
)

   SimModule/ModuleInput.h  

Operators

Name Remarks Include Path Unreal Specifiers

FModuleInputValue & operator*= ( float Scalar
)

 Scalar operators. SimModule/ModuleInput.h  

float operator[] ( int32 Index
) const

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

FModuleInputValue & operator+= ( const FModuleInputValue& Rhs
)

   SimModule/ModuleInput.h  

FModuleInputValue & operator= ( const FModuleInputValue&
)

   SimModule/ModuleInput.h  

FModuleInputValue & operator-= ( const FModuleInputValue& Rhs
)

   SimModule/ModuleInput.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page