1. Epic GamesDeveloper
  3. Serialization

Serialization

Unreal Engine C++ API Reference > Runtime > CoreUObject

Filters

Classes

  Type Name Description
Public class DataAccessWrapper Wraps access to the FEditorBulkData data for FEditorBulkDataReader so that it can be done before the FBufferReaderBase constructor is called  
Public class FArchiveCallstacks    
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 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 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 struct FArchiveSavePackageDataBuffer This is the structure that should be used by most callers of an archive (other than SavePackage which handles the full complexity) that need to provide SavePackage or Cook information to the archive.  
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 FArchiveStackTraceDisabledScope Disables collecting both offsets and stack traces when collecting serialize callstacks.  
Public class FArchiveStackTraceIgnoreScope Ignores saving the stack trace when collecting serialize offsets .  
Public class FArchiveStackTraceMemoryWriter    
Public class FArchiveStackTraceReader    
Public class FArchiveStackTraceWriter    
Public class FArchiveUObject Base FArchive for serializing UObjects.  
Public class FArchiveUObjectFromStructuredArchive    
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 FBulkData @documentation  
Public class FBulkDataBatchRequest A batch request is a handle to one or more I/O requests.  
Public class FBulkDataBuffer Used to manage a raw data buffer provided by BulkData while providing access to it via a TArrayView.  
Public class FBulkDataCookedIndex    
Public struct FBulkDataMapEntry    
Public class FBulkDataReader Custom archive class for reading directly from bulk data.  
Public class FBulkDataRequest Handle to a bulk data I/O request.  
Public struct FBulkDataSerializationParams Parameters when serializing bulk data.  
Public class FBulkDataWriter Custom archive class for writing directly to bulk data.  
Public class FBulkMetaData Bulk meta data, size, offset, flags and lock status packed in 16 bytes.  
Public struct FBulkMetaResource Serialized bulk meta data.  
Public struct FCompressionSettings A wrapper around the oodle compression settings used by FEditorBulkData.  
Public class FCookedData    
Public struct FData Results of GetData call.  
Public class FDeferredMessageLog Thread safe proxy for the FMessageLog while performing async loading.  
Public struct FDeleteByFree    
Public struct FDependencyBundleEntry    
Public struct FDependencyBundleHeader    
Public class FDerivedData Derived Data Reference  
Public class FDerivedDataIoBatch Batch of requests to access Derived Data References.  
Public class FDerivedDataIoOptions Options for operations on a Derived Data Reference.  
Public struct FDerivedDataIoPriority Priority for scheduling an operation on a Derived Data Reference.  
Public class FDerivedDataIoRequest Request on a Derived Data Reference that may be used to query the associated response.  
Public class FDerivedDataIoResponse Tracks one or more associated requests dispatched by FDerivedDataIoBatch.  
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 FEditorBulkData The goal of this class is to provide an editor time version of BulkData that will work with the asset virtualization system.  
Public class FEditorBulkDataReader    
Public class FEditorBulkDataWriter    
Public struct FExportBundleEntry Export bundle entry.  
Public struct FExportMapEntry The sizeof FMinimalName may be variable but FMappedName should always be larger, so FScriptObjectEntry has a fixed size.  
Public class FFindReferencersArchive Archive for mapping out the referencers of a collection of objects.  
Public class FFormatContainer    
Public struct FMetaData Results of GetMeta call.  
Public struct FObjectAndNameAsStringProxyArchive Implements a proxy archive that serializes UObjects and FNames as string data.  
Public class FObjectReader UObject Memory Reader Archive.  
Public class FObjectWriter UObject Memory Writer Archive.  
Public struct FOwnedBulkDataPtr @documentation  
Public struct FPackageData    
Public class FPackageImportReference    
Public class FPackageObjectIndex    
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 struct FTestUndeclaredScriptStructObjectReferencesTest Helper struct to test if struct serializer object reference declaration tests work properly.  
Public class FTextReferenceCollector Counts all persistent text references from within a package, using the specified comparison mode  
Public struct FZenPackageImportedPackageNamesContainer    
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 TBulkData Templated bulk data.A bulk data array of typed elements.  
Public class TBulkDataScopedReadLock Note that these lock structures only work with the templated versions of FBulkData, such as FByteBulkData or FFloatBulkData because they need to know the format of the bulkdata payload which the base class FBulkData cannot provide.  
Public class TBulkDataScopedWriteLock Locks the given bulkdata object for read/write access.  
Public class TFindObjectReferencers This class is used to find which objects reference any element from a list of "TargetObjects".  

Typedefs

Name Description
FBulkDataBatchReadRequest Handle to a bulk data I/O batch read request.
FBulkDataIORequestCallBack Callback to use when making streaming requests
FByteBulkData  
FDerivedDataIoComplete  
FFloatBulkData  
FIntBulkData  
FIoFilenameHash A loose hash value that can be created from either a filenames or a FIoChunkId
FOnAsyncLoadingFlushComplete  
FSetBulkDataRegistry  
FWordBulkData  

Enums

  Type 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 EBulkDataPayloadType    
Public enum EExportFilterFlags Export filter flags.  
Public enum EPropertyLocalizationGathererResultFlags    
Public enum EPropertyLocalizationGathererTextFlags    
Public enum EZenPackageVersion    
Public enum UE::BulkDataRegistry::ERegisterResult Define ERegisterResult even if !WITH_EDITOR to make it easier to use in EditorBulkData.cpp.  
Public enum UE::EDerivedDataFlags Flags that modify how this derived data is saved and how it may be loaded.  
Public enum UE::EDerivedDataIoStatus Status of an operation on a Derived Data Reference.  
Public enum UE::Serialization::ECompressionOptions A set of higher level compression options that avoid the need to set the specific oodle options.  

Functions

  Type Name Description
Public function bool Checks if the object can have PostLoad called on the Async Loading Thread
Public function void  
Public function  

DECLARE_CYCLE_STAT ( TEXT("Flush AllAsync Loads GT"),
STAT_FAsyncPackage_FlushAllAsyncLoadingGameThread,
STATGROUP_AsyncLoadGameThread
)

  
Public function  

DECLARE_CYCLE_STAT ( TEXT("Flush Async Loading GT"),
STAT_FAsyncPackage_FlushAsyncLoadingGameThread,
STATGROUP_AsyncLoadGameThread
)

  
Public function  

DECLARE_CYCLE_STAT ( TEXT("TickAsyncLoading GT"),
STAT_FAsyncPackage_TickAsyncLoadingGameThread,
STATGROUP_AsyncLoadGameThread
)

  
Public function  

DECLARE_CYCLE_STAT ( TEXT("PostLoadObjects GT"),
STAT_FAsyncPackage_PostLoadObjectsGameThread,
STATGROUP_AsyncLoadGameThread
)

  
Public function  

DECLARE_CYCLE_STAT ( TEXT("Async Loading Time"),
STAT_AsyncLoadingTime,
STATGROUP_AsyncLoad
)

  
Public function  

DECLARE_CYCLE_STAT_WITH_FLAGS ( TEXT("CreateClusters GT"),
STAT_FAsyncPackage_CreateClustersGameThread,
STATGROUP_AsyncLoadGameThread,
EStatFlags::Verbose
)

  
Public function  

DECLARE_CYCLE_STAT_WITH_FLAGS ( TEXT("PostLoadInstances GT"),
STAT_FAsyncPackage_PostLoadInstancesGameThread,
STATGROUP_AsyncLoadGameThread,
EStatFlags::Verbose
)

  
Public function    
Public function    
Public function    
Public function void If we change the size of FBulkDataCookedIndex we will need to update FBulkDataMapEntry.
Public function UE::DerivedData::IBuildInputResolver *  
Public function bool Returns true if we're inside a FGCScopeLock
Public function bool  
Public function void

IsTimeLimitExceededPrint ( double InTickStartTime,
double CurrentTime,
double LastTestTime,
double InTimeLimit,
const TCHAR* InLastTypeOfWorkPerformed,
UObject* InLastObjectWorkWasPerformedOn
)

  
Public function FStringBuilderBase &  
Public function const TCHAR *  
Public function FString  
Public function IAsyncPackageLoader *

MakeAsyncPackageLoader2 ( FIoDispatcher& InIoDispatcher,
IAsyncPackageLoader* UncookedPackageLoader
)

 Creates a new instance of the AsyncPackageLoader #2.
Public function FIoFilenameHash

MakeIoFilenameHash ( const FString& Filename
)

 Helpers to create the hash from a filename.
Public function FIoFilenameHash

MakeIoFilenameHash ( const FPackagePath& Filename
)

 Helpers to create the hash from a FPackagePath.
Public function FIoFilenameHash

MakeIoFilenameHash ( const FIoChunkId& ChunkID
)

 Helpers to create the hash from a chunk id.
Public function void  
Public function void  
Public function void  
Public function void  
Public function    
Public function  

UE::Serialization::ENUM_CLASS_FLAGS ( FEditorBulkData::EFlags
)

  

Variables

  Type Name Description
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 FIoFilenameHash INVALID_IO_FILENAME_HASH  
Public variable const FName PrestreamPackageClassNameLoad  
Public variable   STATCAT_Advanced  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.