UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Static Public Member Functions | List of all members
UE::Net::FReplicationInstanceOperations Struct Reference

#include <ReplicationOperations.h>

Static Public Member Functions

static IRISCORE_API bool PollAndCopyPropertyData (const FReplicationInstanceProtocol *InstanceProtocol, EReplicationFragmentTraits ExcludeTraits, EReplicationFragmentPollFlags PollOptions=EReplicationFragmentPollFlags::PollAllState)
 
static IRISCORE_API bool PollAndCopyPropertyData (const FReplicationInstanceProtocol *InstanceProtocol, EReplicationFragmentPollFlags PollOptions=EReplicationFragmentPollFlags::PollAllState)
 
static IRISCORE_API bool PollAndCopyObjectReferences (const FReplicationInstanceProtocol *InstanceProtocol, EReplicationFragmentTraits RequiredTraits, EReplicationFragmentPollFlags PollOptions=EReplicationFragmentPollFlags::None)
 
static IRISCORE_API void Quantize (FNetSerializationContext &Context, uint8 *DstObjectStateBuffer, FNetBitStreamWriter *ChangeMaskWriter, const FReplicationInstanceProtocol *InstanceProtocol, const FReplicationProtocol *Protocol)
 
static IRISCORE_API void QuantizeIfDirty (FNetSerializationContext &Context, uint8 *DstObjectStateBuffer, FNetBitStreamWriter *ChangeMaskWriter, const FReplicationInstanceProtocol *InstanceProtocol, const FReplicationProtocol *Protocol)
 
static IRISCORE_API void ResetDirtiness (const FReplicationInstanceProtocol *InstanceProtocol, const FReplicationProtocol *Protocol)
 
static IRISCORE_API void DequantizeAndApply (FNetSerializationContext &Context, const FDequantizeAndApplyParameters &Parameters)
 
static IRISCORE_API void DequantizeAndApply (FNetSerializationContext &Context, FMemStackBase &InAllocator, const uint32 *ChangeMaskData, const FReplicationInstanceProtocol *InstanceProtocol, const uint8 *SrcObjectStateBuffer, const FReplicationProtocol *Protocol)
 
static IRISCORE_API void OutputInternalStateToString (FNetSerializationContext &Context, FStringBuilderBase &StringBuilder, const uint32 *ChangeMaskData, const uint8 *SrcInternalObjectStateBuffer, const FReplicationInstanceProtocol *InstanceProtocol, const FReplicationProtocol *Protocol)
 
static IRISCORE_API void OutputInternalDefaultStateToString (FNetSerializationContext &NetSerializationContext, FStringBuilderBase &StringBuilder, const FReplicationFragments &Fragments)
 
static IRISCORE_API void OutputInternalDefaultStateMemberHashesToString (UReplicationSystem *ReplicationSystem, FStringBuilderBase &StringBuilder, const FReplicationFragments &Fragments)
 

Member Function Documentation

◆ DequantizeAndApply() [1/2]

void UE::Net::FReplicationInstanceOperations::DequantizeAndApply ( FNetSerializationContext &  Context,
const FDequantizeAndApplyParameters &  Parameters 
)
static

Dequantize the state for a replicated object with a given protocol. Data will be pushed out by using the ReplicationFragments.

◆ DequantizeAndApply() [2/2]

void UE::Net::FReplicationInstanceOperations::DequantizeAndApply ( FNetSerializationContext &  Context,
FMemStackBase &  InAllocator,
const uint32 *  ChangeMaskData,
const FReplicationInstanceProtocol *  InstanceProtocol,
const uint8 *  SrcObjectStateBuffer,
const FReplicationProtocol *  Protocol 
)
static

Dequantize the state for a replicated object with a given protocol. Data will be pushed out by using the ReplicationFragments.

◆ OutputInternalDefaultStateMemberHashesToString()

void UE::Net::FReplicationInstanceOperations::OutputInternalDefaultStateMemberHashesToString ( UReplicationSystem *  ReplicationSystem,
FStringBuilderBase &  StringBuilder,
const FReplicationFragments &  Fragments 
)
static

Serialize and output per member default state hashes to string.

◆ OutputInternalDefaultStateToString()

void UE::Net::FReplicationInstanceOperations::OutputInternalDefaultStateToString ( FNetSerializationContext &  NetSerializationContext,
FStringBuilderBase &  StringBuilder,
const FReplicationFragments &  Fragments 
)
static

Dequantize the default state for a replicated object with a given protocol and output the state to string.

◆ OutputInternalStateToString()

void UE::Net::FReplicationInstanceOperations::OutputInternalStateToString ( FNetSerializationContext &  Context,
FStringBuilderBase &  StringBuilder,
const uint32 *  ChangeMaskData,
const uint8 *  SrcInternalObjectStateBuffer,
const FReplicationInstanceProtocol *  InstanceProtocol,
const FReplicationProtocol *  Protocol 
)
static

Dequantize the state for a replicated object with a given protocol and output the state to string.

◆ PollAndCopyObjectReferences()

bool UE::Net::FReplicationInstanceOperations::PollAndCopyObjectReferences ( const FReplicationInstanceProtocol *  InstanceProtocol,
EReplicationFragmentTraits  RequiredTraits,
EReplicationFragmentPollFlags  PollOptions = EReplicationFragmentPollFlags::None 
)
static

Update object references in fragments that has object references and additional required traits. Returns true if a polled state is dirty.

◆ PollAndCopyPropertyData() [1/2]

bool UE::Net::FReplicationInstanceOperations::PollAndCopyPropertyData ( const FReplicationInstanceProtocol *  InstanceProtocol,
EReplicationFragmentPollFlags  PollOptions = EReplicationFragmentPollFlags::PollAllState 
)
static

Update all registered Fragments that updates dirtiness by polling. Returns true if a polled state is dirty.

◆ PollAndCopyPropertyData() [2/2]

bool UE::Net::FReplicationInstanceOperations::PollAndCopyPropertyData ( const FReplicationInstanceProtocol *  InstanceProtocol,
EReplicationFragmentTraits  ExcludeTraits,
EReplicationFragmentPollFlags  PollOptions = EReplicationFragmentPollFlags::PollAllState 
)
static

Update all registered Fragments that updates dirtiness by polling, except for those with any of the ExcludeTraits. Returns true if a polled state is dirty.

◆ Quantize()

void UE::Net::FReplicationInstanceOperations::Quantize ( FNetSerializationContext &  Context,
uint8 *  DstObjectStateBuffer,
FNetBitStreamWriter *  ChangeMaskWriter,
const FReplicationInstanceProtocol *  InstanceProtocol,
const FReplicationProtocol *  Protocol 
)
static

Quantize the state for a replicated object with a given InstanceProtocol using the ReplicationProtocol. DstObjectStateBuffer needs to be in a valid state before calling this function. Changemasks will be written to the ChangeMaskWriter. Dirtiness will not be reset.

See also
ResetDirtiness

◆ QuantizeIfDirty()

void UE::Net::FReplicationInstanceOperations::QuantizeIfDirty ( FNetSerializationContext &  Context,
uint8 *  DstObjectStateBuffer,
FNetBitStreamWriter *  ChangeMaskWriter,
const FReplicationInstanceProtocol *  InstanceProtocol,
const FReplicationProtocol *  Protocol 
)
static

Quantize the state for a replicated object with a given InstanceProtocol using the ReplicationProtocol. DstObjectStateBuffer needs to be in a valid state before calling this function. Changemasks will be written to the ChangeMaskWriter. Dirtiness will not be reset. This variant will only Quantize States marked as dirty

See also
ResetDirtiness

◆ ResetDirtiness()

void UE::Net::FReplicationInstanceOperations::ResetDirtiness ( const FReplicationInstanceProtocol *  InstanceProtocol,
const FReplicationProtocol *  Protocol 
)
static

Resets dirty tracking stored with the protocol, such as changemasks and init state dirtiness.

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