1. Epic GamesDeveloper
  3. Serialization

Serialization

API > API/Runtime > API/Runtime/IrisCore > API/Runtime/IrisCore/Iris

Classes

  Type Name Description
Public struct UStruct FBoolNetSerializerConfig    
Public struct FBoolNetSerializerNetSerializerInfo    
Public struct UStruct FDateTimeNetSerializerConfig    
Public struct FDateTimeNetSerializerNetSerializerInfo    
Public struct UStruct FDoubleNetSerializerConfig    
Public struct FDoubleNetSerializerNetSerializerInfo    
Public class FElementAllocationPolicy Default AllocationPolicy for FNetSerializerArrayStorage helper class  
Public struct UStruct FEnumInt16NetSerializerConfig    
Public struct FEnumInt16NetSerializerNetSerializerInfo    
Public struct UStruct FEnumInt32NetSerializerConfig    
Public struct FEnumInt32NetSerializerNetSerializerInfo    
Public struct UStruct FEnumInt64NetSerializerConfig    
Public struct FEnumInt64NetSerializerNetSerializerInfo    
Public struct UStruct FEnumInt8NetSerializerConfig    
Public struct FEnumInt8NetSerializerNetSerializerInfo    
Public struct UStruct FEnumUint16NetSerializerConfig    
Public struct FEnumUint16NetSerializerNetSerializerInfo    
Public struct UStruct FEnumUint32NetSerializerConfig    
Public struct FEnumUint32NetSerializerNetSerializerInfo    
Public struct UStruct FEnumUint64NetSerializerConfig    
Public struct FEnumUint64NetSerializerNetSerializerInfo    
Public struct UStruct FEnumUint8NetSerializerConfig    
Public struct FEnumUint8NetSerializerNetSerializerInfo    
Public struct UStruct FFloatNetSerializerConfig    
Public struct FFloatNetSerializerNetSerializerInfo    
Public struct UStruct FGuidNetSerializerConfig    
Public struct FGuidNetSerializerNetSerializerInfo    
Public class FInstancedStructDescriptorCache    
Public struct UStruct FInstancedStructNetSerializerConfig    
Public struct FInt16NetSerializerNetSerializerInfo    
Public struct UStruct FInt16RangeNetSerializerConfig    
Public struct FInt16RangeNetSerializerNetSerializerInfo    
Public struct FInt32NetSerializerNetSerializerInfo    
Public struct UStruct FInt32RangeNetSerializerConfig    
Public struct FInt32RangeNetSerializerNetSerializerInfo    
Public struct FInt64NetSerializerNetSerializerInfo    
Public struct UStruct FInt64RangeNetSerializerConfig    
Public struct FInt64RangeNetSerializerNetSerializerInfo    
Public struct FInt8NetSerializerNetSerializerInfo    
Public struct UStruct FInt8RangeNetSerializerConfig Integer range serializers.  
Public struct FInt8RangeNetSerializerNetSerializerInfo    
Public struct UStruct FIntNetSerializerConfig Integer serializers.  
Public struct FIrisPackageMapExports In order to properly capture exported data when calling in to old style NetSerialize methods we need to capture and inject certain types.  
Public struct FIrisPackageMapExportsQuantizedType    
Public struct FIrisPackageMapExportsUtil Util to facilitate capture and export of supported types when calling into old NetSerialize() methods.  
Public struct UStruct FNameAsNetTokenNetSerializerConfig    
Public struct FNameAsNetTokenNetSerializerNetSerializerInfo    
Public struct UStruct FNameNetSerializerConfig    
Public struct FNameNetSerializerNetSerializerInfo    
Public struct FNetApplyArgs Serializers that want to be selective about which members to modify in the target instance when applying state should implement Apply where the serializer is responsible for setting the members of the target instance.  
Public class FNetBitStreamReader    
Public class FNetBitStreamRollbackScope RollbackScope, if the provided BitWriter is in an invalid state when exiting the scope, the BitWriter will be restored to the state it had when entering the FNetBitStreamRollbackScope  
Public class FNetBitStreamWriter    
Public class FNetBitStreamWriteScope Simple helper to a temporary write at a specific offset in the stream and return to the original position when exiting the scope.  
Public struct FNetCloneDynamicStateArgs Forwarding serializers and serializers in need of dynamic state must implement CloneDynamicState and FreeDynamicState.  
Public struct FNetCollectReferencesArgs Parameters passed to a NetSerializer's CollectNetReferences function.  
Public struct FNetDequantizeArgs Parameters passed to a NetSerializer's Dequantize function.  
Public struct FNetDeserializeArgs Parameters passed to a NetSerializer's Deserialize function.  
Public struct FNetDeserializeDeltaArgs Parameters passed to a NetSerializer's DeserializeDelta function.  
Public class FNetErrorContext    
Public struct FNetFreeDynamicStateArgs Forwarding serializers and serializers in need of dynamic state must implement CloneDynamicState and FreeDynamicState.  
Public struct FNetIsEqualArgs Parameters passed to a NetSerializer's IsEqual function.  
Public class FNetJournal Simple journal to track last few entries of read data.  
Public struct FNetQuantizeArgs Parameters passed to a NetSerializer's Quantize function.  
Public class FNetReferenceCollector    
Public class FNetSerializationContext    
Public struct FNetSerializeArgs Parameters passed to a NetSerializer's Serialize function.  
Public struct FNetSerializeDeltaArgs Parameters passed to a NetSerializer's SerializeDelta function.  
Public struct FNetSerializer The end result of a UE_NET_IMPLEMENT_SERIALIZER call on a struct adhering to the conventions of the TNetSerializerBuilder.  
Public class FNetSerializerAlignedStorage Helper class to manage storage of untyped dynamic storage with arbitrary alignment in quantized data.  
Public class FNetSerializerArrayStorage Helper class to manage storage of dynamic arrays in quantized data FNetSerializerArrayStorage is only intended to be used from within Quantized replication states that requires dynamic storage as it has very specific expectations and limitations.  
Public struct FNetSerializerBaseArgs Things that need to be passed to most functions that are part of a NetSerializer.  
Public struct FNetSerializerChangeMaskParam    
Public struct UStruct FNetSerializerConfig    
Public class FNetSerializerRegistryDelegates Helper class for registering NetSerializers.  
Public struct FNetValidateArgs Parameters passed to a NetSerializer's Validate function.  
Public struct UStruct FNopNetSerializerConfig The NopNetSerializer have all the serializer functions implemented as no-ops.  
Public struct FNopNetSerializerNetSerializerInfo    
Public struct UStruct FObjectNetSerializerConfig    
Public struct FObjectNetSerializerNetSerializerInfo    
Public struct UStruct FPackedInt32NetSerializerConfig    
Public struct FPackedInt32NetSerializerNetSerializerInfo    
Public struct UStruct FPackedInt64NetSerializerConfig    
Public struct FPackedInt64NetSerializerNetSerializerInfo    
Public struct UStruct FPackedUint32NetSerializerConfig    
Public struct FPackedUint32NetSerializerNetSerializerInfo    
Public struct UStruct FPackedUint64NetSerializerConfig    
Public struct FPackedUint64NetSerializerNetSerializerInfo    
Public struct UStruct FPolymorphicArrayStructNetSerializerConfig    
Public struct FPolymorphicNetSerializerScriptStructCache    
Public struct UStruct FPolymorphicStructNetSerializerConfig    
Public struct FPolymorphicStructNetSerializerInternal Wrapper to allow access to the internal context.  
Public struct UStruct FRotator3dNetSerializerConfig    
Public struct FRotator3dNetSerializerNetSerializerInfo    
Public struct UStruct FRotator3fNetSerializerConfig    
Public struct FRotator3fNetSerializerNetSerializerInfo    
Public struct UStruct FRotatorAsByteNetSerializerConfig    
Public struct FRotatorAsByteNetSerializerNetSerializerInfo    
Public struct UStruct FRotatorAsShortNetSerializerConfig    
Public struct FRotatorAsShortNetSerializerNetSerializerInfo    
Public struct UStruct FRotatorNetSerializerConfig    
Public struct FRotatorNetSerializerNetSerializerInfo    
Public struct UStruct FScriptInterfaceNetSerializerConfig    
Public struct FScriptInterfaceNetSerializerNetSerializerInfo    
Public struct UStruct FSoftClassPathNetSerializerConfig    
Public struct FSoftClassPathNetSerializerNetSerializerInfo    
Public struct UStruct FSoftObjectNetSerializerConfig    
Public struct FSoftObjectNetSerializerNetSerializerInfo    
Public struct UStruct FSoftObjectPathNetSerializerConfig    
Public struct FSoftObjectPathNetSerializerNetSerializerInfo    
Public struct UStruct FStringNetSerializerConfig    
Public struct FStringNetSerializerNetSerializerInfo    
Public struct UStruct FStructNetSerializerConfig    
Public struct FStructNetSerializerNetSerializerInfo    
Public struct FUint16NetSerializerNetSerializerInfo    
Public struct UStruct FUint16RangeNetSerializerConfig    
Public struct FUint16RangeNetSerializerNetSerializerInfo    
Public struct FUint32NetSerializerNetSerializerInfo    
Public struct UStruct FUint32RangeNetSerializerConfig    
Public struct FUint32RangeNetSerializerNetSerializerInfo    
Public struct FUint64NetSerializerNetSerializerInfo    
Public struct UStruct FUint64RangeNetSerializerConfig    
Public struct FUint64RangeNetSerializerNetSerializerInfo    
Public struct FUint8NetSerializerNetSerializerInfo    
Public struct UStruct FUint8RangeNetSerializerConfig    
Public struct FUint8RangeNetSerializerNetSerializerInfo    
Public struct UStruct FUintNetSerializerConfig Unsigned integer serializers.  
Public struct UStruct FUnitQuat4dNetSerializerConfig    
Public struct FUnitQuat4dNetSerializerNetSerializerInfo    
Public struct UStruct FUnitQuat4fNetSerializerConfig    
Public struct FUnitQuat4fNetSerializerNetSerializerInfo    
Public struct UStruct FUnitQuatNetSerializerConfig    
Public struct FUnitQuatNetSerializerNetSerializerInfo    
Public struct UStruct FVector3dNetSerializerConfig    
Public struct FVector3dNetSerializerNetSerializerInfo    
Public struct UStruct FVector3fNetSerializerConfig    
Public struct FVector3fNetSerializerNetSerializerInfo    
Public struct UStruct FVectorNetQuantize100NetSerializerConfig    
Public struct FVectorNetQuantize100NetSerializerNetSerializerInfo For FVector_NetQuantize100. Replicates components scaled by 128 as rounded integers. No clamping- if the values are very large they will be sent as full floats.  
Public struct UStruct FVectorNetQuantize10NetSerializerConfig    
Public struct FVectorNetQuantize10NetSerializerNetSerializerInfo For FVector_NetQuantize10. Replicates components scaled by 8 as rounded integers. No clamping- if the values are very large they will be sent as full floats.  
Public struct UStruct FVectorNetQuantizeNetSerializerConfig    
Public struct FVectorNetQuantizeNetSerializerNetSerializerInfo For FVector_NetQuantize. Replicates the components as rounded integers. No clamping- if the values are very large they will be sent as full floats.  
Public struct UStruct FVectorNetQuantizeNormalNetSerializerConfig    
Public struct FVectorNetQuantizeNormalNetSerializerNetSerializerInfo For FVector_NetQuantizeNormal. Replicates components with 16 bits per component.  
Public struct UStruct FVectorNetSerializerConfig    
Public struct FVectorNetSerializerNetSerializerInfo    
Public struct UStruct FWeakObjectNetSerializerConfig    
Public struct FWeakObjectNetSerializerNetSerializerInfo    
Public class TInlinedElementAllocationPolicy The InlinedElementAllocationPolicy allocates up to a specified number of elements in the same allocation as the container.  
Public class TNetSerializer    
Public class TNetSerializerBuilder    
Public struct TPolymorphicArrayStructNetSerializerImpl TPolymorphicArrayStructNetSerializerImpl  
Public struct TPolymorphicStructNetSerializerImpl TPolymorphicStructNetSerializerImpl  
Public class UClass MinimalAPI Transient UIrisObjectReferencePackageMap Custom packagemap implementation used to be able to capture exports such as UObject* references, names and NetTokens from external serialization.  

Typedefs

Name Description
FInt16NetSerializerConfig  
FInt32NetSerializerConfig  
FInt64NetSerializerConfig  
FInt8NetSerializerConfig  
FUint16NetSerializerConfig  
FUint32NetSerializerConfig  
FUint64NetSerializerConfig  
FUint8NetSerializerConfig  
NetApplyFunction  
NetCloneDynamicStateFunction  
NetCollectNetReferencesFunction  
NetDequantizeFunction  
NetDeserializeDeltaFunction  
NetDeserializeFunction  
NetFreeDynamicStateFunction  
NetIsEqualFunction  
NetQuantizeFunction  
NetSerializeDeltaFunction  
NetSerializeFunction  
NetSerializerConfigParam  
NetSerializerValuePointer  
NetValidateFunction  

Enums

  Type Name Description
Public enum ENetSerializerConfigTraits    
Public enum UE::Net::ENetReferenceCollectorTraits Copyright Epic Games, Inc. All Rights Reserved.  
Public enum UE::Net::ENetSerializerTraits Various traits that can be set for a FNetSerializer.  
Public enum UE::Net::ESparseBitArraySerializationHint Copyright Epic Games, Inc. All Rights Reserved.  

Functions

  Type Name Description
Public function    
Public function uint32  
Public function uint32 Always report the actual bitstream position, even on overflow. This normally allows for better comparisons between sending and receiving side when bitstream errors occur.
Public function bool

UE::Net::DeserializeSameValue ( FNetBitStreamReader& Reader,
T& OutValue,
const T OtherValue
)

 Deserializes what was serialized using SerializeSameValue.
Public function uint32 Deserializes a signed unit float that was serialized using SerializeSignedUnitFloat with the same BitCount.
Public function    
Public function    
Public function SIZE_T  
Public function void  
Public function void  
Public function void  
Public function bool  
Public function void  
Public function void  
Public function void  
Public function bool  
Public function int64 Read a full uint64 to the provided FNetBitStreamReader
Public function uint64 Read a full uint64 to the provided FNetBitStreamReader
Public function bool

UE::Net::SerializeSameValue ( FNetBitStreamWriter& Writer,
const T Value,
const T OtherValue
)

 Serializes a single bit indicating whether the value is equal to another value or not.
Public function void Serializes a signed unit float quantized with QuantizeSignedUnitFloat with the same BitCount.
Public function  

UE::Net::UE_NET_DECLARE_SERIALIZER ( FInstancedStructNetSerializer,
IRISCORE_API
)

  
Public function void Write a full uint64 to the provided FNetBitStreamWriter
Public function void Write a full uint64 to the provided FNetBitStreamWriter

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page