1. Epic GamesDeveloper
  3. FFastArraySerializer

FFastArraySerializer

Base struct for wrapping the array used in Fast [TArray](API\Runtime\Core\TArray) Replication

API > API/Runtime > API/Runtime/NetCore

Base struct for wrapping the array used in Fast TArray Replication

   
Name FFastArraySerializer
Type struct
Header File /Engine/Source/Runtime/Net/Core/Classes/Net/Serialization/FastArraySerializer.h
Include Path #include "Net/Serialization/FastArraySerializer.h"

Syntax

USTRUCT ()  
struct FFastArraySerializer

Derived Classes

FFastArraySerializer derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FFastArraySerializer()

   Net/Serialization/FastArraySerializer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FFastArraySerializer()

   Net/Serialization/FastArraySerializer.h  

Structs

Name Remarks
CPostReplicatedReceiveFuncable Concept used to detect if PostReplicatedReceive is defined or not.
FFastArraySerializerHeader Struct containing common header data that is written / read when serializing Fast Arrays.
FPostReplicatedReceiveParameters If a function with the signature void PostReplicatedReceive(const FFastArraySerializer::FPostReplicatedReceiveParameters& Parameters) is defined in the derived struct It will be called after each call to NetDeltaSerialize on the receiving end, including if we have mapped some unmapped objects
TFastArraySerializeHelper Helper struct that contains common methods / logic for standard Fast Array serialization and Delta Struct Fast Array serialization.

Constants

Name Type Remarks Include Path
CVarMaxNumberOfAllowedChangesPerUpdate FAutoConsoleVariableRef   Net/Serialization/FastArraySerializer.h
CVarMaxNumberOfAllowedDeletionsPerUpdate FAutoConsoleVariableRef   Net/Serialization/FastArraySerializer.h
MaxNumberOfAllowedChangesPerUpdate int32   Net/Serialization/FastArraySerializer.h
MaxNumberOfAllowedDeletionsPerUpdate int32   Net/Serialization/FastArraySerializer.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ArrayReplicationKey int32 Counter used to track array replication. Net/Serialization/FastArraySerializer.h
  • NotReplicated
GuidReferencesMap TMap< int32, FFastArraySerializerGuidReferences > List of items that need to be re-serialized when the referenced objects are mapped Net/Serialization/FastArraySerializer.h  
GuidReferencesMap_StructDelta TMap< int32, FGuidReferencesMap > List of items that need to be re-serialized when the referenced objects are mapped. Net/Serialization/FastArraySerializer.h  
IDCounter int32 Counter used to assign IDs to new elements. Net/Serialization/FastArraySerializer.h
  • NotReplicated
  • Transient
ItemMap TMap< int32, int32 > Maps Element ReplicationID to Array Index. Net/Serialization/FastArraySerializer.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedNumItems int32 Cached item counts, used for fast sanity checking when writing. Net/Serialization/FastArraySerializer.h  
CachedNumItemsToConsiderForWriting int32   Net/Serialization/FastArraySerializer.h  
DeltaFlags EFastArraySerializerDeltaFlags   Net/Serialization/FastArraySerializer.h
  • NotReplicated
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

const EFastArraySerializerDeltaFlags GetDeltaSerializationFlags()

   Net/Serialization/FastArraySerializer.h  

void IncrementArrayReplicationKey()

   Net/Serialization/FastArraySerializer.h  

void MarkArrayDirty()

 This must be called if you just remove something from the array Net/Serialization/FastArraySerializer.h  

void MarkItemDirty ( FFastArraySerializerItem& Item
)

 This must be called if you add or change an item in the array Net/Serialization/FastArraySerializer.h  

void PostReplicatedAdd ( const TArrayView< int32 >& AddedIndices,
int32 FinalSize
)

 Called after adding all new elements and after the elements themselves are notified. Net/Serialization/FastArraySerializer.h  

void PostReplicatedChange ( const TArrayView< int32 >& ChangedIndices,
int32 FinalSize
)

 Called after updating all existing elements with new data and after the elements themselves are notified. Net/Serialization/FastArraySerializer.h  

void PreReplicatedRemove ( const TArrayView< int32 >& RemovedIndices,
int32 FinalSize
)

 Called before removing elements and after the elements themselves are notified. Net/Serialization/FastArraySerializer.h  

void SetDeltaSerializationEnabled ( const bool bEnabled
)

   Net/Serialization/FastArraySerializer.h  

bool ShouldWriteFastArrayItem ( const Type& Item,
const bool bIsWritingOnClient
) const

 Helper function for FastArrayDeltaSerialize to consolidate the logic of whether to consider writing an item in a fast TArray during network serialization. Net/Serialization/FastArraySerializer.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool FastArrayDeltaSerialize ( TArray< Type >& Items,
FNetDeltaSerializeInfo& Parms,
SerializerType& ArraySerializer
)

 Performs "standard" delta serialization on the items in the FastArraySerializer. Net/Serialization/FastArraySerializer.h  

static bool FastArrayDeltaSerialize_DeltaSerializeStructs ( TArray< Type >& Items,
FNetDeltaSerializeInfo& Parms,
SerializerType& ArraySerializer
)

 Performs "struct delta" serialization on the items in the FastArraySerializer. Net/Serialization/FastArraySerializer.h  

static const int32 GetMaxNumberOfAllowedChangesPerUpdate()

   Net/Serialization/FastArraySerializer.h  

static const int32 GetMaxNumberOfAllowedDeletionsPerUpdate()

   Net/Serialization/FastArraySerializer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page