Serialization

Windows
MacOS
Linux

Filters

Classes

Name

Description

Public class

FArchiveCountMem

Archive for counting memory usage.

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

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

FBulkDataBase

Public struct

FBulkDataIORequest

Represents an IO request from the FUntypedBulkData streaming API.

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 class

FDeferredMessageLog

Thread safe proxy for the FMessageLog while performing async loading.

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 class

FFindReferencersArchive

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

Public struct

FFloatBulkDataOld

Public class

FFormatContainer

Public struct

FIntBulkDataOld

Public struct

FObjectGraphNode

Public class

FObjectReader

UObject Memory Reader Archive.

Public class

FObjectWriter

UObject Memory Writer Archive.

Public struct

FOwnedBulkDataPtr

Public class

FPropertyLocalizationDataGatherer

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 class

FTraceReferences

This traces referenced/referencer of an object using FArchiveObjectGraph.

Public struct

FTraceRouteRecord

Public struct

FUntypedBulkData

Public class

FUntypedBulkData2

Public struct

FWordBulkDataOld

Public class

IAsyncPackageLoader

Asynchronous package loader interface.

Public class

IEDLBootNotificationManager

Public class

TFindObjectReferencers

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

Typedefs

Name

Description

FBulkDataInterface

Switch between the old and new types based on USE_NEW_BULKDATA.

FByteBulkData

FByteBulkData2

Commonly used types.

FFloatBulkData

FFloatBulkData2

FIntBulkData

FIntBulkData2

FWordBulkData

FWordBulkData2

Enums

Name

Description

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

EPropertyLocalizationGathererResultFlags

Public enum

EPropertyLocalizationGathererTextFlags

Functions

Name Description

Public function

FBulkDataIORequest *

 

BulkDataUtils::CreateStreamingRequestForRange

(
    const FBulkDataInterface& Start,
    const FBulkDataInterface& End,
    EAsyncIOPriorityAndFlags Priority,
    FAsyncFileCallBack* CompleteCallback
)

Create an async read request for a range of bulk data The request will read all data between the two given BulkData objects.

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

*

 

FinalizeAr

(
    SomeAr
)

Public function

bool

 

IsFullyLoadedObj

(
    UObject* Obj
)

Public function

bool

 

IsGarbageCollectionLocked()

Returns true if we're inside a FGCScopeLock

Public function

bool

 

IsGarbageCollectionWaiting()

Returns true if GC wants to run

Public function

bool

 

IsNativeCodePackage

(
    UPackage* Package
)

Public function

constexpr bool

 

operator!

Public function

constexpr bool

 

operator!

Public function

constexpr EPropertyLocalizationGathererResultFlags

 

operator&

Public function

constexpr EPropertyLocalizationGathererTextFlags

 

operator&

Public function

EPropertyLocalizationGathererTextFlags &

 

operator&=

Public function

EPropertyLocalizationGathererResultFlags &

 

operator&=

Public function

constexpr EPropertyLocalizationGathererTextFlags

 

operator^

Public function

constexpr EPropertyLocalizationGathererResultFlags

 

operator^

Public function

EPropertyLocalizationGathererTextFlags &

 

operator^=

Public function

EPropertyLocalizationGathererResultFlags &

 

operator^=

Public function

constexpr EPropertyLocalizationGathererTextFlags

 

operator|

Public function

constexpr EPropertyLocalizationGathererResultFlags

 

operator|

Public function

EPropertyLocalizationGathererTextFlags &

 

operator|=

Public function

EPropertyLocalizationGathererResultFlags &

 

operator|=

Public function

constexpr EPropertyLocalizationGathererTextFlags

 

operator~

Public function

constexpr EPropertyLocalizationGathererResultFlags

 

operator~

Public function

void

 

ResetAsyncLoadingStats()

Public function

*SomeObject

 

Serialize

(
    Ar
)

Variables

Name Description

Public variable

uint32

 

GFlushAsyncLoadingCount

Public variable

double

 

GFlushAsyncLoadingTime

Stats for ChartCreation.cpp.

Public variable

uint32

 

GSyncLoadCount

Public variable

const FName

 

PrestreamPackageClassNameLoad

Public variable

*FObjectAndNameAsStringProxyArchive Ar *

 

SomeAr

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

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