Serialization

Windows
MacOS
Linux

Filters

Classes

Name

Description

Public struct

CProvidesDefaultUObject

Access to a global default object is required in order to patch vtables Normally this can be provided by a default-constructed object.

Public struct

CProvidesStaticClass

Public struct

CProvidesStaticStruct

Public struct

CTypeLayout

Public struct

ECustomVersionSerializationFormat

Public class

FArchive

Base class for archives that can be used for loading, saving, and garbage collecting in a byte order neutral way.

Public struct

FArchiveFieldName

Define a structure to encapsulate a field name, which compiles to an empty object if WITH_TEXT_ARCHIVE_SUPPORT = 0.

Public class

FArchiveFromStructuredArchive

Public class

FArchiveFromStructuredArchiveImpl

Public class

FArchiveLoadCompressedProxy

FArchive Proxy to transparently load compressed data from an array.

Public class

FArchiveProxy

Base class for archive proxies.

Public class

FArchiveSaveCompressedProxy

FArchive Proxy to transparently write out compressed data to an array.

Public struct

FArchiveSerializedPropertyChain

Structure containing the stack of properties that are currently being serialized by an archive

Public struct

FArchiveState

Public class

FArrayReader

Public class

FBitArchive

Base class for serializing bitstreams.

Public struct

FBitReader

Reads bitstreams.

Public struct

FBitReaderMark

For pushing and popping FBitWriter positions.

Public struct

FBitWriter

Writes bitstreams.

Public struct

FBitWriterMark

For pushing and popping FBitWriter positions.

Public class

FBufferArchive

Buffer archiver.

Public class

FBufferReader

Similar to FMemoryReader , but able to internally manage the memory for the buffer.

Public class

FBufferReaderBase

Similar to FMemoryReader , but able to internally manage the memory for the buffer.

Public class

FBufferWriter

Similar to FMemoryWriter , but able to internally manage the memory for the buffer.

Public struct

FCompressedChunkInfo

Implements a helper structure for compression support

Public class

FCurrentCustomVersions

Provides access to code-defined custom versions registered via FCustomVersionRegistration .

Public struct

FCustomVersion

Structure to hold unique custom key with its version.

Public class

FCustomVersionContainer

Container for all available/serialized custom versions.

Public struct

FCustomVersionDifference

Public class

FCustomVersionRegistration

This class will cause the registration of a custom version number and key with the global FCustomVersionContainer when instantiated, and unregister when destroyed.

Public struct

FElementId

Public struct

FFieldLayoutDesc

Public class

FHashedName

Public class

FLargeMemoryData

Data storage for the large memory reader and writer.

Public class

FLargeMemoryReader

Archive for reading a large amount of arbitrary data from memory

Public class

FLargeMemoryWriter

Archive for storing a large amount of arbitrary data to memory

Public class

FMemoryArchive

Base class for serializing arbitrary data in memory.

Public class

FMemoryImage

Public class

FMemoryImageAllocatorBase

Public struct

FMemoryImageNamePointer

Public struct

FMemoryImageResult

Public class

FMemoryImageSection

Public class

FMemoryImageString

Public struct

FMemoryImageVTablePointer

Public class

FMemoryImageWriter

Public class

FMemoryReader

Archive for reading arbitrary data from the specified memory location

Public class

FMemoryReaderView

Archive for reading arbitrary data from the specified array view

Public struct

FMemoryToStringContext

Public class

FMemoryUnfreezeContent

Public class

FMemoryWriter

Archive for storing arbitrary data to the specified memory location

Public struct

FNameAsStringProxyArchive

Implements a proxy archive that serializes FNames as string data.

Public struct

FPlatformTypeLayoutParameters

Public class

FPointerTableBase

Public class

FPtrTableBase

Public struct

FRegisterTypeLayoutDesc

Public class

FSlotBase

The base class of all slot types.

Public class

FSlotPosition

Represents a position of a slot within the hierarchy.

Public class

FStaticMemoryReader

Archive for reading arbitrary data from the specified memory location

Public class

FStructuredArchive

Manages the state of an underlying FStructuredArchiveFormatter , and provides a consistent API for reading and writing to a structured archive.

Public class

FStructuredArchiveArray

Represents an array in the structured archive.

Public class

FStructuredArchiveChildReader

FStructuredArchiveChildReader

Public class

FStructuredArchiveFormatter

Interface to format data to and from an underlying archive.

Public class

FStructuredArchiveFromArchive

Public class

FStructuredArchiveMap

Represents a map in the structured archive.

Public class

FStructuredArchiveRecord

Represents a record in the structured archive.

Public class

FStructuredArchiveSlot

Contains a value in the archive; either a field or array/map element.

Public class

FStructuredArchiveStream

Represents an unsized sequence of slots in the structured archive (similar to an array, but without a known size).

Public struct

FTypeLayoutDesc

Public class

FVoidPtrTable

Public struct

TAssignDestroyHelper

Public class

TCheckedObjPtr

TCheckedObjPtr

Public struct

TGetBaseTypeHelper

Public struct

TGetDefaultObjectHelper

Public struct

TGetFreezeImageFieldHelper

Public struct

TGetFreezeImageHelper

Public struct

TGetTypeLayoutHelper

Public struct

THasCustomDefaultObject

Public struct

THasTypeLayout

Public class

TIndexedPtrBase

Note that IndexedPtr types don't declare a default intrinsic type layout.

Public struct

TInitializeBaseHelper

Public class

TMemoryImageAllocator

Public class

TMemoryImagePtr

Public struct

TNamedAttribute

Class to contain a named attribute for serialization.

Public struct

TNamedValue

Class to contain a named value for serialization.

Public struct

TOptionalNamedAttribute

Class to contain a named attribute for serialization, with a default.

Public class

TPatchedPtrBase

Public struct

TProvidesStaticStruct

Public class

TPtrTable

Public class

TPtrTableBase

Public class

TRefCountPtrTable

Public struct

TStaticGetTypeLayoutHelper

Public class

TUniqueMemoryImagePtr

Public struct

TUsePropertyFreezing

Public struct

TValidateInterfaceHelper

Typedefs

Enums

Functions

Name Description

Public function

void

 

appBitsCpy

(
    uint8 * Dest,
    int32 DestBit,
    uint8 * Src,
    int32 SrcBit,
    int32 BitCount
)

Public function

T

 

Arctor

(
    FArchive & Ar
)

Template for archive constructors.

Public function

void

 

CopyFormattedData

(
    FStructuredArchiveFormatter & Input...,
    FStructuredArchiveFormatter & Outpu...
)

Copies formatted data from one place to another.

Public function

void

 

DeleteObjectFromLayout

(
    T* Object,
    FPointerTableBase * PtrTable,
    bool bIsFrozen
)

Public function

Type

 

EFieldLayoutFlags::MakeFlags

(
    uint32 Flags
)

Public function

Type

 

EFieldLayoutFlags::MakeFlagsEditorOnly

(
    uint32 Flags
)

Public function

Type

 

EFieldLayoutFlags::MakeFlagsRayTracing

(
    uint32 Flags
)

Public function

bool

 

ETypeLayoutInterface::HasVTable

(
    Type InType
)

Public function

uint32

 

Freeze::AppendHash

(
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FSHA1 & Hasher
)

Public function

uint32

 

Freeze::AppendHashForNameAndSize

(
    const TCHAR * Name,
    uint32 Size,
    FSHA1 & Hasher
)

Public function

uint32

 

Freeze::AppendHashPair

(
    const FTypeLayoutDesc & KeyTypeDesc,
    const FTypeLayoutDesc & ValueTypeDe...,
    const FPlatformTypeLayoutParameters ...,
    FSHA1 & Hasher
)

Public function

uint32

 

Freeze::DefaultAppendHash

(
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FSHA1 & Hasher
)

Public function

uint32

 

Freeze::DefaultGetTargetAlignment

(
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...
)

Public function

void

 

Freeze::DefaultToString

(
    const void * Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::DefaultUnfrozenCopy

(
    const FMemoryUnfreezeContent & Cont...,
    const void * Object,
    const FTypeLayoutDesc & TypeDesc,
    void * OutDst
)

Public function

void

 

Freeze::DefaultWriteMemoryImage

(
    FMemoryImageWriter & Writer,
    const void * Object,
    const FTypeLayoutDesc & TypeDesc,
    const FTypeLayoutDesc & DerivedType...
)

Public function

void

 

Freeze::DefaultWriteMemoryImageField

(
    FMemoryImageWriter & Writer,
    const void * Object,
    const void * FieldObject,
    const FTypeLayoutDesc & TypeDesc,
    const FTypeLayoutDesc & DerivedType...
)

Public function

void

 

Freeze::ExtractBitFieldValue

(
    const void * Value,
    uint32 SrcBitOffset,
    uint32 DestBitOffset,
    uint32 NumBits,
    uint64 & InOutValue
)

Helper functions

Public function

uint8

 

Freeze::FindFieldNameLength

(
    const TCHAR * Name
)

Finds the length of the field name, omitting any _DEPRECATED suffix.

Public function

uint32

 

Freeze::GetTargetAlignment

(
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...
)

Public function

FSHAHash

 

Freeze::HashLayout

(
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...
)

Public function

uint32

 

Freeze::HashLayout

(
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FSHAHash & OutHash
)

Public function

uint32

 

Freeze::HashLayouts

(
    const TArray < const FTypeLayoutDesc ...,
    const FPlatformTypeLayoutParameters ...,
    FSHAHash & OutHash
)

Public function

bool

 

Freeze::IncludeField

(
    const FFieldLayoutDesc * FieldD...,
    const FPlatformTypeLayoutParameters ...
)

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    void *const* DummyObject,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FSHA1 & Hasher
)

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    const T* DummyObject,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FSHA1 & Hasher
)

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    const TIndexedPtrBase < T, PtrType >...,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FSHA1 & Hasher
)

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    const TMemoryImagePtr < T >* Du...,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FSHA1 & Hasher
)

Public function

uint32

 

Freeze::IntrinsicGetTargetAlignment

(
    void *const* DummyObject,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...
)

Public function

uint32

 

Freeze::IntrinsicGetTargetAlignment

(
    const TIndexedPtrBase < T, PtrType >...,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...
)

Public function

uint32

 

Freeze::IntrinsicGetTargetAlignment

(
    const TMemoryImagePtr < T >* Du...,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...
)

Public function

uint32

 

Freeze::IntrinsicGetTargetAlignment

(
    const T* DummyObject,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...
)

Public function

void

 

Freeze::IntrinsicToString

(
    long Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    long long Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    void * Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    unsigned short Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    unsigned int Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    unsigned long Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    unsigned long long Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    float Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    double Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    wchar_t Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    char16_t Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    int8 Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    unsigned char Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    short Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    int Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    const T& Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    const FHashedName & Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    const TMemoryImagePtr < T >& Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    char Object,
    const FTypeLayoutDesc & TypeDesc,
    const FPlatformTypeLayoutParameters ...,
    FMemoryToStringContext & OutContext
)

Public function

void

 

Freeze::IntrinsicUnfrozenCopy

(
    const FMemoryUnfreezeContent & Cont...,
    const TIndexedPtrBase < T, PtrType >...,
    void * OutDst
)

Public function

void

 

Freeze::IntrinsicUnfrozenCopy

(
    const FMemoryUnfreezeContent & Cont...,
    const TMemoryImagePtr < T >& Object,
    void * OutDst
)

Public function

void

 

Freeze::IntrinsicUnfrozenCopy

(
    const FMemoryUnfreezeContent & Cont...,
    const T& Object,
    void * OutDst
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter & Writer,
    const TIndexedPtrBase < T, PtrType >...,
    const FTypeLayoutDesc & TypeDesc
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter & Writer,
    const TMemoryImagePtr < T >& Object,
    const FTypeLayoutDesc &
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter & Writer,
    void *,
    const FTypeLayoutDesc &
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter & Writer,
    const T& Object,
    const FTypeLayoutDesc & TypeDesc
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter & Writer,
    const void * Object,
    uint32 Size
)

Public function

uint32

 

GetBaseOffset()

Public function

const T *...

 

GetDefault()

Get default object of a class.

Public function

uint32

 

GetTypeHash

(
    const FMemoryImageString & S
)

Case insensitive string hash function.

Public function

const FTypeL ...

 

GetTypeLayoutDesc

(
    const FPointerTableBase *,
    const T& Object
)

Public function

void

 

InternalDeleteObjectFromLayout

(
    void * Object,
    const FTypeLayoutDesc & TypeDesc,
    bool bIsFrozen
)

Public function

TEnableIf <&#...

 

InternalGetDefaultObject()

Public function

TEnableIf < T ...

 

InternalGetDefaultObject()

Public function Static

void

 

InternalInitializeBaseHelper

(
    FTypeLayoutDesc & TypeDesc
)

Public function Static

void

 

InternalInitializeBasesHelper

(
    FTypeLayoutDesc & TypeDesc
)

Public function Static

void

 

InternalInitializeBasesHelper

(
    FTypeLayoutDesc & TypeDesc
)

Public function

TNamedAttrib ...

 

MakeNamedAttribute

(
    FArchiveFieldName Name,
    T& Value
)

Helper function to construct a TNamedAttribute , deducing the value type.

Public function

TNamedValue <...

 

MakeNamedValue

(
    FArchiveFieldName Name,
    T& Value
)

Helper function to construct a TNamedValue , deducing the value type.

Public function

TOptionalNam ...

 

MakeOptionalNamedAttribute

(
    FArchiveFieldName Name,
    T& Value,
    const typename TIdentity < T >::Type...
)

Helper function to construct a TOptionalNamedAttribute , deducing the value type.

Public function

constexpr bo ...

 

operator!

(
    EBufferWriterFlags E
)

Public function

constexpr bo ...

 

operator!

Public function

bool

 

operator!=

(
    const FMemoryImageVTablePointer & L...,
    const FMemoryImageVTablePointer & R...
)

Public function

bool

 

operator!=

(
    const FMemoryImageNamePointer & Lhs,
    const FMemoryImageNamePointer & Rhs
)

Public function

bool

 

operator!=

(
    const FTypeLayoutDesc & Lhs,
    const FTypeLayoutDesc & Rhs
)

Public function

constexpr EL ...

 

operator&

Public function

constexpr EB ...

 

operator&

(
    EBufferWriterFlags Lhs,
    EBufferWriterFlags Rhs
)

Public function

EBufferWrite ...

 

operator&=

(
    EBufferWriterFlags & Lhs,
    EBufferWriterFlags Rhs
)

Public function

ELargeMemory ...

 

operator&=

(
    ELargeMemoryReaderFlags & Lhs,
    ELargeMemoryReaderFlags Rhs
)

Public function

constexpr EB ...

 

operator^

(
    EBufferWriterFlags Lhs,
    EBufferWriterFlags Rhs
)

Public function

constexpr EL ...

 

operator^

Public function

EBufferWrite ...

 

operator^=

(
    EBufferWriterFlags & Lhs,
    EBufferWriterFlags Rhs
)

Public function

ELargeMemory ...

 

operator^=

(
    ELargeMemoryReaderFlags & Lhs,
    ELargeMemoryReaderFlags Rhs
)

Public function

constexpr EB ...

 

operator|

(
    EBufferWriterFlags Lhs,
    EBufferWriterFlags Rhs
)

Public function

constexpr EL ...

 

operator|

Public function

EBufferWrite ...

 

operator|=

(
    EBufferWriterFlags & Lhs,
    EBufferWriterFlags Rhs
)

Public function

ELargeMemory ...

 

operator|=

(
    ELargeMemoryReaderFlags & Lhs,
    ELargeMemoryReaderFlags Rhs
)

Public function

constexpr EB ...

 

operator~

(
    EBufferWriterFlags E
)

Public function

constexpr EL ...

 

operator~

Public function

bool

 

operator==

(
    const FMemoryImageVTablePointer & L...,
    const FMemoryImageVTablePointer & R...
)

Public function

bool

 

operator==

(
    const FMemoryImageNamePointer & Lhs,
    const FMemoryImageNamePointer & Rhs
)

Public function

bool

 

operator==

(
    const FTypeLayoutDesc & Lhs,
    const FTypeLayoutDesc & Rhs
)

Public function

const FTypeL ...

 

StaticGetTypeLayoutDesc()

Variables

Name Description

Public variable

TAutoConsoleVar ...

 

CVarMaxNetStringSize

CVar specifying the maximum serialization size for strings sent/received by the netcode

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback