UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
Chaos::FModuleNetData Struct Referenceabstract

#include <SimulationModuleBase.h>

+ Inheritance diagram for Chaos::FModuleNetData:

Public Member Functions

 DEFINE_CHAOSSIMTYPENAME (FModuleNetData)
 
 FModuleNetData (int InSimArrayIndex, const FString &InDebugString=FString())
 
virtual ~FModuleNetData ()
 
virtual void Serialize (FArchive &Ar)=0
 
virtual void DeltaSerialize (FArchive &Ar, const FModuleNetData *Previous)
 
virtual void DeltaSerializeWithStash (FArchive &Ar, const FModuleNetData *Previous, TMap< FName, uint32 > &InOutSerializationStash)
 
virtual void FillNetState (const ISimulationModuleBase *SimModule)=0
 
virtual void FillSimState (ISimulationModuleBase *SimModule)=0
 
virtual void Lerp (const float LerpFactor, const FModuleNetData &Max, const FModuleNetData &MaxValue)=0
 
virtual bool IsDefaultState ()
 
virtual void ApplyDefaultState ()
 
virtual FString ToString () const =0
 
- Public Member Functions inherited from Chaos::FSimulationModuleTypeContainer
void AddType (FName InType)
 
bool IsSimType (FName InType) const
 
FName GetSimType () const
 
template<typename U >
bool IsSimType () const
 
template<typename U >
U * Cast ()
 
template<typename U >
const U * Cast () const
 
- Public Member Functions inherited from Chaos::TSimulationModuleTypeableBase< FModuleNetData >
 TSimulationModuleTypeableBase ()
 

Public Attributes

int SimArrayIndex = -1
 
FString DebugString
 
- Public Attributes inherited from Chaos::FSimulationModuleTypeContainer
TSet< FName > MyTypes
 
FName MostRecentAdd = NAME_None
 

Additional Inherited Members

- Static Public Member Functions inherited from Chaos::FSimulationModuleTypeContainer
template<typename U >
static FName GetStaticSimType ()
 
- Static Public Member Functions inherited from Chaos::TSimulationModuleTypeableBase< FModuleNetData >
static FName StaticSimTypeBase ()
 

Detailed Description

Interface base class for all module network serialization

Constructor & Destructor Documentation

◆ FModuleNetData()

Chaos::FModuleNetData::FModuleNetData ( int  InSimArrayIndex,
const FString &  InDebugString = FString() 
)
inline

◆ ~FModuleNetData()

virtual Chaos::FModuleNetData::~FModuleNetData ( )
inlinevirtual

Member Function Documentation

◆ ApplyDefaultState()

virtual void Chaos::FModuleNetData::ApplyDefaultState ( )
inlinevirtual

Set the states data to default values, called during deserialization if IsDefaultState() was true during serialization

◆ DEFINE_CHAOSSIMTYPENAME()

Chaos::FModuleNetData::DEFINE_CHAOSSIMTYPENAME ( FModuleNetData  )

◆ DeltaSerialize()

virtual void Chaos::FModuleNetData::DeltaSerialize ( FArchive &  Ar,
const FModuleNetData *  Previous 
)
inlinevirtual

◆ DeltaSerializeWithStash()

virtual void Chaos::FModuleNetData::DeltaSerializeWithStash ( FArchive &  Ar,
const FModuleNetData *  Previous,
TMap< FName, uint32 > &  InOutSerializationStash 
)
inlinevirtual

◆ FillNetState()

virtual void Chaos::FModuleNetData::FillNetState ( const ISimulationModuleBase *  SimModule)
pure virtual

Implemented in Chaos::FClutchSimModuleData, Chaos::FEngineSimModuleData, Chaos::FTorqueSimModuleData, Chaos::FTransmissionSimModuleData, and Chaos::FWheelSimModuleData.

◆ FillSimState()

virtual void Chaos::FModuleNetData::FillSimState ( ISimulationModuleBase *  SimModule)
pure virtual

Implemented in Chaos::FClutchSimModuleData, Chaos::FEngineSimModuleData, Chaos::FTorqueSimModuleData, Chaos::FTransmissionSimModuleData, and Chaos::FWheelSimModuleData.

◆ IsDefaultState()

virtual bool Chaos::FModuleNetData::IsDefaultState ( )
inlinevirtual

Return true if the current state of this module is the default state, If the state is default it will not be sent over the network, instead ApplyDefaultState() will be called on the receiving end to apply the default state for this module. Important: Be sure to also implement ApplyDefaultState() function to ensure that the data gets set to their desired values when not serialized. Example: bools that are false or true by default and floats that are 0.0f doesn't need to be networked

◆ Lerp()

virtual void Chaos::FModuleNetData::Lerp ( const float  LerpFactor,
const FModuleNetData &  Max,
const FModuleNetData &  MaxValue 
)
pure virtual

Implemented in Chaos::FTorqueSimModuleData, and Chaos::FTransmissionSimModuleData.

◆ Serialize()

virtual void Chaos::FModuleNetData::Serialize ( FArchive &  Ar)
pure virtual

Implemented in Chaos::FTorqueSimModuleData, and Chaos::FTransmissionSimModuleData.

◆ ToString()

virtual FString Chaos::FModuleNetData::ToString ( ) const
pure virtual

Implemented in Chaos::FTorqueSimModuleData, and Chaos::FTransmissionSimModuleData.

Member Data Documentation

◆ DebugString

FString Chaos::FModuleNetData::DebugString

◆ SimArrayIndex

int Chaos::FModuleNetData::SimArrayIndex = -1
The documentation for this struct was generated from the following file: