Serialization

Choose your operating system:

Windows

macOS

Linux

Filters

Classes

Name

Description

Public class

DataAccessWrapper

Wraps access to the FVirtualizedUntypedBulkData data for FVirtualizedBulkDataReader so that it can be done before the FBufferReaderBase constructor is called

Public class

FArchiveCountMem

Archive for counting memory usage.

Public class

FArchiveCrc32

Calculates a checksum from the input provided to the archive.

Public struct

FArchiveDiffInfo

Public class

FArchiveDiffMap

Public struct

FArchiveDiffStats

Structure that holds stats from comparing two packages

Public class

FArchiveFindCulprit

Archive for finding who references an object.

Public class

FArchiveHasReferences

Public class

FArchiveObjectCrc32

Calculates a checksum on an object's serialized data stream.

Public class

FArchiveObjectGraph

This is from FArchiveTraceRoute -This only creates object graph of all objects This can be used by other classes such as FTraceReferences - trace references of one object

Public class

FArchiveObjectPropertyMapper

Class for collecting references to objects, along with the properties that references that object.

Public class

FArchiveReferenceMarker

This archive marks all objects referenced by the specified "root set" of objects.

Public class

FArchiveReplaceObjectAndStructPropertyRef

Specialized version of FArchiveReplaceObjectRef that replaces references to FFields that were owned by any of the old UStructs in the Replacement Map with their respective new versions that belong to the new UStrtucts in the Replacement Map.

Public class

FArchiveReplaceObjectRef

Archive for replacing a reference to an object.

Public class

FArchiveReplaceObjectRefBase

Base class for object replacement archives

Public class

FArchiveReplaceOrClearExternalReferences

Identical to FArchiveReplaceObjectRef, but for references to private objects in other packages we clear the reference instead of preserving it (unless it makes it into the replacement map)

Public class

FArchiveScriptReferenceCollector

Public class

FArchiveShowReferences

Archive for displaying all objects referenced by a particular object.

Public class

FArchiveStackTrace

Archive that stores a callstack for each of the Serialize calls and has the ability to compare itself to an existing package on disk and dump all the differences to log.

Public class

FArchiveStackTraceIgnoreScope

Public class

FArchiveStackTraceReader

Public class

FArchiveTraceRoute

DEPRECATED: This class is out of date and misses many GC references, replace with FReferenceChainSearch.

Public class

FArchiveUObject

Base FArchive for serializing UObjects.

Public class

FArchiveUObjectFromStructuredArchive

Public class

FArchiveUObjectFromStructuredArchiveImpl

Public class

FAsyncLoadingFlushContext

Flush the async loader in a non-blocking manner.

Public struct

FAsyncLoadingThreadSettings

Structure that holds the async loading thread ini settings

Public struct

FAutoRegisterLocalizationDataGatheringCallback

Struct to automatically register a callback when it's constructed

Public struct

FAutoRegisterTextReferenceCollectorCallback

Struct to automatically register a callback when it's constructed

Public class

FBulkDataAllocation

This is a wrapper for the BulkData memory allocation so we can use a single pointer to either reference a straight memory allocation or in the case that the BulkData object represents a memory mapped file region, a FOwnedBulkDataPtr.

Public class

FBulkDataBase

Public class

FBulkDataBuffer

Used to manage a raw data buffer provided by BulkData while providing access to it via a TArrayView.

Public class

FBulkDataIORequest

Public struct

FBulkDataOrId

Public class

FBulkDataReader

Custom archive class for reading directly from bulk data.

Public struct

FBulkDataStreamingToken

Some areas of code currently find FUntypedBulkData too bloated for use so were storing smaller parts of it and performing the file IO manually.

Public class

FBulkDataWriter

Custom archive class for writing directly to bulk data.

Public struct

FByteBulkDataOld

Public struct

FCompressionSettings

A wrapper around the oodle compression settings used by FVirtualizedUntypedBulkData.

Public struct

FData

Results of GetData call.

Public class

FDeferredMessageLog

Thread safe proxy for the FMessageLog while performing async loading.

Public class

FDerivedData

Public class

FDuplicateDataReader

Reads duplicated objects from a memory buffer, replacing object references to duplicated objects.

Public class

FDuplicateDataWriter

Writes duplicated objects to a memory buffer, duplicating referenced inner objects and adding the duplicates to the DuplicatedObjects map.

Public struct

FDuplicatedObject

Information about a duplicated object For use with a dense object annotation

Public struct

FExportBundleEntry

Export bundle entry.

Public struct

FExportBundleHeader

Export bundle header

Public struct

FExportMapEntry

Export map entry.

Public class

FFindReferencersArchive

Archive for mapping out the referencers of a collection of objects.

Public struct

FFloatBulkDataOld

Public class

FFormatContainer

Public struct

FIntBulkDataOld

Public struct

FMetaData

Results of GetMeta call.

Public struct

FObjectGraphNode

Public class

FObjectReader

UObject Memory Reader Archive.

Public class

FObjectWriter

UObject Memory Writer Archive.

Public struct

FOwnedBulkDataPtr

Public class

FPackageImportReference

Public class

FPackageObjectIndex

Public class

FPayloadToc

A table of contents showing the location of all virtualized bulkdata payloads in a file.

Public class

FPropertyLocalizationDataGatherer

Public class

FPropertyReferenceCollector

Simple reference processor and collector for collecting all UObjects referenced by FProperties

Public class

FPublicExportKey

Public class

FResaveSizeTracker

Implements behavior needed across multiple BulkDataRegistry implementations for GetBulkDataResaveSize

Public struct

FScriptObjectEntry

Public class

FSerializedPropertyScope

Helper class to set and restore serialized property on an archive

Public class

FTextReferenceCollector

Counts all persistent text references from within a package, using the specified comparison mode

Public struct

FTocEntry

Represents an entry to the table of contents found at the start of a payload sidecar file.

Public class

FTraceReferences

This traces referenced/referencer of an object using FArchiveObjectGraph.

Public struct

FTraceRouteRecord

Public struct

FUntypedBulkData

Public class

FUntypedBulkData2

Public class

FVirtualizedBulkDataReader

Public class

FVirtualizedBulkDataWriter

Public class

FVirtualizedUntypedBulkData

The goal of this class is to provide an editor time version of BulkData that will work with the content virtualization system.

Public struct

FWordBulkDataOld

Public struct

FZenPackageSummary

Package summary.

Public struct

FZenPackageVersioningInfo

Public class

IAsyncPackageLoader

Asynchronous package loader interface.

Public class

IBulkDataIORequest

Represents an IO request from the BulkData streaming API.

Public class

IBulkDataRegistry

Registers BulkDatas so that they can be referenced by guid during builds later in the editor process.

Public class

IEDLBootNotificationManager

Public class

TFindObjectReferencers

This class is used to find which objects reference any element from a list of "TargetObjects".

Public class

TVirtualizedBulkData

TODO: Probably remove this and change FVirtualizedUntypedBulkData to always be TVirtualizedBulkData

Typedefs

Name

Description

FBulkDataInterface

Switch between the old and new types based on USE_NEW_BULKDATA.

FBulkDataIORequestCallBack

Callback to use when making streaming requests

FByteBulkData

FByteBulkData2

Commonly used types.

FByteVirtualizedBulkData

FDerivedDataBufferAllocator

FFloatBulkData

FFloatBulkData2

FFloatVirtualizedBulkData

FIntBulkData

FIntBulkData2

FIntVirtualizedBulkData

FIoFilenameHash

A loose hash value that can be created from either a filenames or a FIoChunkId

FOnAsyncLoadingFlushComplete

FSetBulkDataRegistry

FWordBulkData

FWordBulkData2

FWordVirtualizedBulkData

Enums

Name

Description

Public enum

EArchiveReferenceMarkerFlags

Public enum

EArchiveReplaceObjectFlags

Public enum

EBulkDataFlags

Flags serialized with the bulk data.

Public enum

EBulkDataLockFlags

Enumeration for bulk data lock behavior

Public enum

EBulkDataLockStatus

Enumeration for bulk data lock status.

Public enum

EExportFilterFlags

Export filter flags.

Public enum

EPropertyLocalizationGathererResultFlags

Public enum

EPropertyLocalizationGathererTextFlags

Public enum

EZenPackageVersion

Public enum

UE::EDerivedDataFlags

Math.

Public enum

UE::Virtualization::ECompressionOptions

A set of higher level compression options that avoid the need to set the specific oodle options.

Functions

Name Description

Public function

bool

 

CanPostLoadOnAsyncLoadingThread

(
    UObject* Object
)

Checks if the object can have PostLoad called on the Async Loading Thread

Public function

void

 

ClearFlagsAndDissolveClustersFromLoadedObjects

(
    T& LoadedObjects
)

Public function

TUniquePtr< ...

 

CreateBulkDataIoDispatcherRequest

(
    const FIoChunkId& InChunkID,
    int64 InOffsetInBulkData,
    int64 InBytesToRead,
    FBulkDataIORequestCallBack* In...,
    uint8* InUserSuppliedMemory,
    int32 InPriority
)

Creates a bulk data request from the I/O store backend.

Public function

 

FinalizeAr

(
    SomeAr
)

Public function

void

 

FindAllRuntimeScriptPackages

(
    TArray< UPackage* >& OutPacka...
)

Public function

UE::DerivedD...

 

GetGlobalBuildInputResolver()

Public function

bool

 

IsFullyLoadedObj

(
    UObject* Obj
)

Public function

bool

 

IsGarbageCollectionLocked()

Returns true if we're inside a FGCScopeLock

Public function

bool

 

IsNativeCodePackage

(
    UPackage* Package
)

Public function

void

 

IsTimeLimitExceededPrint

(
    double InTickStartTime,
    double CurrentTime,
    double LastTestTime,
    float InTimeLimit,
    const TCHAR* InLastTypeOfWorkP...,
    UObject* InLastObjectWorkWasPe...
)

Public function

FIoFilenameH...

 

MakeIoFilenameHash

(
    const FPackagePath& Filename
)

Helpers to create the hash from a FPackagePath.

Public function

FIoFilenameH...

 

MakeIoFilenameHash

(
    const FString& Filename
)

Helpers to create the hash from a filename.

Public function

FIoFilenameH...

 

MakeIoFilenameHash

(
    const FIoChunkId& ChunkID
)

Helpers to create the hash from a chunk id.

Public function

constexpr bo...

 

operator!

(
    EPropertyLocalizationGathererResult...
)

Public function

constexpr bo...

 

operator!

(
    EPropertyLocalizationGathererTextFl...
)

Public function

constexpr bo...

 

operator!

(
    EArchiveReplaceObjectFlags E
)

Public function

constexpr bo...

 

operator!

(
    EArchiveReferenceMarkerFlags E
)

Public function

constexpr EA...

 

operator&

(
    EArchiveReplaceObjectFlags Lhs,
    EArchiveReplaceObjectFlags Rhs
)

Public function

constexpr EP...

 

operator&

(
    EPropertyLocalizationGathererResult...,
    EPropertyLocalizationGathererResult...
)

Public function

constexpr EP...

 

operator&

(
    EPropertyLocalizationGathererTextFl...,
    EPropertyLocalizationGathererTextFl...
)

Public function

constexpr EA...

 

operator&

(
    EArchiveReferenceMarkerFlags Lhs,
    EArchiveReferenceMarkerFlags Rhs
)

Public function

EPropertyLoc...

 

operator&=

(
    EPropertyLocalizationGathererTextFl...,
    EPropertyLocalizationGathererTextFl...
)

Public function

EPropertyLoc...

 

operator&=

(
    EPropertyLocalizationGathererResult...,
    EPropertyLocalizationGathererResult...
)

Public function

EArchiveRefe...

 

operator&=

(
    EArchiveReferenceMarkerFlags& Lhs,
    EArchiveReferenceMarkerFlags Rhs
)

Public function

EArchiveRepl...

 

operator&=

(
    EArchiveReplaceObjectFlags& Lhs,
    EArchiveReplaceObjectFlags Rhs
)

Public function

constexpr EA...

 

operator^

(
    EArchiveReferenceMarkerFlags Lhs,
    EArchiveReferenceMarkerFlags Rhs
)

Public function

constexpr EP...

 

operator^

(
    EPropertyLocalizationGathererResult...,
    EPropertyLocalizationGathererResult...
)

Public function

constexpr EP...

 

operator^

(
    EPropertyLocalizationGathererTextFl...,
    EPropertyLocalizationGathererTextFl...
)

Public function

constexpr EA...

 

operator^

(
    EArchiveReplaceObjectFlags Lhs,
    EArchiveReplaceObjectFlags Rhs
)

Public function

EPropertyLoc...

 

operator^=

(
    EPropertyLocalizationGathererTextFl...,
    EPropertyLocalizationGathererTextFl...
)

Public function

EPropertyLoc...

 

operator^=

(
    EPropertyLocalizationGathererResult...,
    EPropertyLocalizationGathererResult...
)

Public function

EArchiveRefe...

 

operator^=

(
    EArchiveReferenceMarkerFlags& Lhs,
    EArchiveReferenceMarkerFlags Rhs
)

Public function

EArchiveRepl...

 

operator^=

(
    EArchiveReplaceObjectFlags& Lhs,
    EArchiveReplaceObjectFlags Rhs
)

Public function

constexpr EA...

 

operator|

(
    EArchiveReplaceObjectFlags Lhs,
    EArchiveReplaceObjectFlags Rhs
)

Public function

constexpr EP...

 

operator|

(
    EPropertyLocalizationGathererResult...,
    EPropertyLocalizationGathererResult...
)

Public function

constexpr EA...

 

operator|

(
    EArchiveReferenceMarkerFlags Lhs,
    EArchiveReferenceMarkerFlags Rhs
)

Public function

constexpr EP...

 

operator|

(
    EPropertyLocalizationGathererTextFl...,
    EPropertyLocalizationGathererTextFl...
)

Public function

EArchiveRefe...

 

operator|=

(
    EArchiveReferenceMarkerFlags& Lhs,
    EArchiveReferenceMarkerFlags Rhs
)

Public function

EArchiveRepl...

 

operator|=

(
    EArchiveReplaceObjectFlags& Lhs,
    EArchiveReplaceObjectFlags Rhs
)

Public function

EPropertyLoc...

 

operator|=

(
    EPropertyLocalizationGathererTextFl...,
    EPropertyLocalizationGathererTextFl...
)

Public function

EPropertyLoc...

 

operator|=

(
    EPropertyLocalizationGathererResult...,
    EPropertyLocalizationGathererResult...
)

Public function

constexpr EA...

 

operator~

(
    EArchiveReferenceMarkerFlags E
)

Public function

constexpr EA...

 

operator~

(
    EArchiveReplaceObjectFlags E
)

Public function

constexpr EP...

 

operator~

(
    EPropertyLocalizationGathererResult...
)

Public function

constexpr EP...

 

operator~

(
    EPropertyLocalizationGathererTextFl...
)

Public function

void

 

ResetAsyncLoadingStats()

Public function

SomeObject

 

Serialize

(
    Ar
)

Public function

void

 

SerializeBulkDataSizeInt

(
    FArchive& Ar,
    int64& Value,
    EBulkDataFlags InBulkDataFlags
)

Serialize the given Value as an int32 or int64 depending on InBulkDataFlags&BULKDATA_Size64Bit.

Public function

void

 

SetGlobalBuildInputResolver

(
    UE::DerivedData::IBuildInputResolve...
)

Public function

constexpr bo...

 

UE::operator!

(
    EDerivedDataFlags E
)

Public function

constexpr ED...

 

UE::operator&

(
    EDerivedDataFlags Lhs,
    EDerivedDataFlags Rhs
)

Public function

EDerivedData...

 

UE::operator&=

(
    EDerivedDataFlags& Lhs,
    EDerivedDataFlags Rhs
)

Public function

constexpr ED...

 

UE::operator^

(
    EDerivedDataFlags Lhs,
    EDerivedDataFlags Rhs
)

Public function

EDerivedData...

 

UE::operator^=

(
    EDerivedDataFlags& Lhs,
    EDerivedDataFlags Rhs
)

Public function

constexpr ED...

 

UE::operator|

(
    EDerivedDataFlags Lhs,
    EDerivedDataFlags Rhs
)

Public function

EDerivedData...

 

UE::operator|=

(
    EDerivedDataFlags& Lhs,
    EDerivedDataFlags Rhs
)

Public function

constexpr ED...

 

UE::operator~

(
    EDerivedDataFlags E
)

Public function

constexpr bo...

 

UE::Virtualization::operator!

(
    FVirtualizedUntypedBulkData::EFlags...
)

Public function

constexpr FV...

 

UE::Virtualization::operator&

(
    FVirtualizedUntypedBulkData::EFlags...,
    FVirtualizedUntypedBulkData::EFlags...
)

Public function

FVirtualized...

 

UE::Virtualization::operator&=

(
    FVirtualizedUntypedBulkData::EFlags...,
    FVirtualizedUntypedBulkData::EFlags...
)

Public function

constexpr FV...

 

UE::Virtualization::operator^

(
    FVirtualizedUntypedBulkData::EFlags...,
    FVirtualizedUntypedBulkData::EFlags...
)

Public function

FVirtualized...

 

UE::Virtualization::operator^=

(
    FVirtualizedUntypedBulkData::EFlags...,
    FVirtualizedUntypedBulkData::EFlags...
)

Public function

constexpr FV...

 

UE::Virtualization::operator|

(
    FVirtualizedUntypedBulkData::EFlags...,
    FVirtualizedUntypedBulkData::EFlags...
)

Public function

FVirtualized...

 

UE::Virtualization::operator|=

(
    FVirtualizedUntypedBulkData::EFlags...,
    FVirtualizedUntypedBulkData::EFlags...
)

Public function

constexpr FV...

 

UE::Virtualization::operator~

(
    FVirtualizedUntypedBulkData::EFlags...
)

Variables

Name Description

Public variable

const FString

 

Default

Default flags

Public variable

const FString

 

Export

Public variable

uint32

 

GFlushAsyncLoadingCount

Public variable

double

 

GFlushAsyncLoadingTime

Stats for ChartCreation.cpp.

Public variable

uint32

 

GSyncLoadCount

Public variable

float

 

GTimeLimitExceededMinTime

Public variable

float

 

GTimeLimitExceededMultiplier

Public variable

int32

 

GWarnIfTimeLimitExceeded

Time limit.

Public variable

const FIoFilena...

 

INVALID_IO_FILENAME_HASH

Public variable

const FString

 

MemoryMapped

Public variable

const FString

 

Optional

Public variable

const FName

 

PrestreamPackageClassNameLoad

Public variable

FObjectAndNameA...

 

SomeAr

Implements a proxy archive that serializes UObjects and FNames as string data.

Public variable

 

STATCAT_Advanced