UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FModuleInputContainer Struct Reference

#include <ModuleInput.h>

Public Types

using FInputNameMap = TMap< FName, int >
 
using FInputValues = TArray< FModuleInputValue >
 

Public Member Functions

 FModuleInputContainer ()
 
int GetNumInputs () const
 
FModuleInputValue GetValueAtIndex (int Index) const
 
void SetValueAtIndex (int Index, const FModuleInputValue &InValue, EModuleInputQuantizationType InInputQuantizationType, bool Quantize=true)
 
void MergeValueAtIndex (int Index, const FModuleInputValue &InValue, EModuleInputQuantizationType InInputQuantizationType)
 
void CombineValueAtIndex (int Index, const FModuleInputValue &InValue, EModuleInputQuantizationType InInputQuantizationType)
 
FModuleInputContaineroperator= (const FModuleInputContainer &Other)
 
UE_API void Initialize (TArray< FModuleInputSetup > &SetupData, FInputNameMap &NameMapOut)
 
UE_API void ZeroValues ()
 
UE_API void Serialize (FArchive &Ar, UPackageMap *Map, bool &bOutSuccess, EModuleInputQuantizationType InInputQuantizationType)
 
UE_API int AddInput (EModuleInputValueType Type)
 
UE_API void RemoveAllInputs ()
 
UE_API void Lerp (const FModuleInputContainer &Min, const FModuleInputContainer &Max, float Alpha)
 
UE_API void Merge (const FModuleInputContainer &From)
 
UE_API void Combine (const FModuleInputContainer &With)
 
UE_API void Decay (const float DecayAmount)
 
UE_API void ClearConsumedInputs ()
 
TArray< FModuleInputValue > & AccessInputValues ()
 

Member Typedef Documentation

◆ FInputNameMap

◆ FInputValues

Constructor & Destructor Documentation

◆ FModuleInputContainer()

FModuleInputContainer::FModuleInputContainer ( )
inline

Member Function Documentation

◆ AccessInputValues()

TArray< FModuleInputValue > & FModuleInputContainer::AccessInputValues ( )
inline

◆ AddInput()

int FModuleInputContainer::AddInput ( EModuleInputValueType  Type)

◆ ClearConsumedInputs()

void FModuleInputContainer::ClearConsumedInputs ( )

Clear input once it has been consumed if input is marked as sutch. Prevents same input being fed into simulation when the PT tick is running multiple times per GT tick

◆ Combine()

void FModuleInputContainer::Combine ( const FModuleInputContainer With)

◆ CombineValueAtIndex()

void FModuleInputContainer::CombineValueAtIndex ( int  Index,
const FModuleInputValue InValue,
EModuleInputQuantizationType  InInputQuantizationType 
)
inline

◆ Decay()

void FModuleInputContainer::Decay ( const float  DecayAmount)

Decay input during resimulation by DecayAmount which increases over resimulation frames from 0.0 -> 1.0 when the input is being reused

◆ GetNumInputs()

int FModuleInputContainer::GetNumInputs ( ) const
inline

◆ GetValueAtIndex()

FModuleInputValue FModuleInputContainer::GetValueAtIndex ( int  Index) const
inline

◆ Initialize()

void FModuleInputContainer::Initialize ( TArray< FModuleInputSetup > &  SetupData,
FInputNameMap NameMapOut 
)

◆ Lerp()

void FModuleInputContainer::Lerp ( const FModuleInputContainer Min,
const FModuleInputContainer Max,
float  Alpha 
)

◆ Merge()

void FModuleInputContainer::Merge ( const FModuleInputContainer From)

◆ MergeValueAtIndex()

void FModuleInputContainer::MergeValueAtIndex ( int  Index,
const FModuleInputValue InValue,
EModuleInputQuantizationType  InInputQuantizationType 
)
inline

◆ operator=()

FModuleInputContainer & FModuleInputContainer::operator= ( const FModuleInputContainer Other)
inline

◆ RemoveAllInputs()

void FModuleInputContainer::RemoveAllInputs ( )

◆ Serialize()

void FModuleInputContainer::Serialize ( FArchive Ar,
UPackageMap Map,
bool bOutSuccess,
EModuleInputQuantizationType  InInputQuantizationType 
)

◆ SetValueAtIndex()

void FModuleInputContainer::SetValueAtIndex ( int  Index,
const FModuleInputValue InValue,
EModuleInputQuantizationType  InInputQuantizationType,
bool  Quantize = true 
)
inline

◆ ZeroValues()

void FModuleInputContainer::ZeroValues ( )

The documentation for this struct was generated from the following files: