Serialization

Windows
MacOS
Linux

Filters

Classes

Name

Description

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

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 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 struct

FCustomVersion

Structure to hold unique custom key with its version.

Public class

FCustomVersionContainer

Container for all available/serialized custom versions.

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 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

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 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 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

FStructuredArchiveChildReader

FStructuredArchiveChildReader

Public class

FStructuredArchiveFormatter

Interface to format data to and from an underlying archive.

Public class

FStructuredArchiveFromArchive

Public class

TCheckedObjPtr

TCheckedObjPtr

Public struct

TNamedValue

Class to contain a named value for serialization.

Typedefs

Name

Description

FArchiveFormatterType

Typedef for which formatter type to support

FArrayWriter

Archive objects that are also a TArray.

FCustomVersionArray

FCustomVersionSet

FExternalReadCallback

Enums

Name

Description

Public enum

EArchiveValueType

Specifies the type of a value in a slot. Used by FContextFreeArchiveFormatter for introspection.

Public enum

EBufferWriterFlags

Public enum

ELargeMemoryReaderFlags

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

TNamedValue<...

 

MakeNamedValue

(
    FArchiveFieldName Name,
    T& Value
)

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

Public function

constexpr bo...

 

operator!

(
    EBufferWriterFlags E
)

Public function

constexpr bo...

 

operator!

Public function

constexpr EB...

 

operator&

(
    EBufferWriterFlags Lhs,
    EBufferWriterFlags Rhs
)

Public function

constexpr EL...

 

operator&

Public function

ELargeMemory...

 

operator&=

Public function

EBufferWrite...

 

operator&=

(
    EBufferWriterFlags& Lhs,
    EBufferWriterFlags 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^=

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|=

Public function

constexpr EB...

 

operator~

(
    EBufferWriterFlags E
)

Public function

constexpr EL...

 

operator~

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