Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Serialization > FArchive

Light Theme

Dark Theme

FArchive

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

Windows

MacOS

Linux

Inheritance Hierarchy

FArchiveState

FArchive

FArchiveFileReaderGeneric

FMovieSceneArchiveFileReader

FArchiveFileWriterGeneric

FMovieSceneArchiveFileWriter

FArchiveLoadCompressedProxy

FArchiveProxy

FArchiveFromStructuredArchiveImpl

FArchiveUObjectFromStructuredArchiveImpl

FChaosArchive

FMaterialResourceProxyReader

FNameAsStringIndexProxyArchive

FNameAsStringProxyArchive

FOodleNetworkArchiveBase

	FOodleNetworkDictionaryArchive
	FPacketCaptureArchive

FPropertyProxyArchive

FShaderSaveArchive

FArchiveSaveCompressedProxy

FArchiveUObject

FAsyncWriter

FBitArchive

FBitReader

FNetBitReader

FInBunch

FBitWriter

FNetBitWriter

FOutBunch

FControlChannelOutBunch

FBufferReaderBase

	FBufferReader
	FBufferReaderWithSHA
	FBulkDataReader

FBufferWriter

FBulkDataWriter

FHttpStreamFArchive

FLocalFileStreamFArchive

FMemoryArchive

FOutputDeviceMemory::FOutputDeviceMemoryProxyArchive

FPreloadableFile

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Serialization/Archive.h
Include	#include "Serialization/Archive.h"

Syntax

class FArchive : private FArchiveState

Remarks

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

Constructors

	Name	Description
	FArchive()
	FArchive ( const FArchive& )

Destructors

	Name	Description
	~FArchive()

Functions

	Name	Description
void	AttachBulkData ( UObject* Owner, FUntypedBulkData* BulkData )	Attaches/ associates the passed in bulk data object with the linker.
bool	AttachExternalReadDependency ( FExternalReadCallback& ReadCallbac... )	Adds external read dependency
FArchive &	ByteOrderSerialize ( void* V, int32 Length )	Serialize data of Length bytes, taking into account byte swapping if needed.
void	ByteSwap ( void* V, int32 Length )	Used to do byte swapping on small items. This does not happen usually, so we don't want it inline.
bool	Close()	Attempts to close and finalize any handles used for backing data storage, returns true if it succeeded.
void	DetachBulkData ( FUntypedBulkData* BulkData, bool bEnsureBulkDataIsLoaded )	Detaches the passed in bulk data object from the linker.
bool	FastPathLoad ( void* InDest )
void	Flush()	Attempts to finish writing any buffered data to disk/permanent storage.
void	FlushCache()	Flushes cache and frees internal data.
void	ForceBlueprintFinalization()	Inform the archive that a blueprint would like to force finalization, normally this is triggered by CDO load, but if there's no CDO we force finalization.
FArchiveStat...	GetArchiveState()	Returns the low level archive state for this archive.
const FArchi...	GetArchiveState()
FArchive ...	GetCacheableArchive()	Returns a pointer to an archive that represents the same data that the current archive covers, but that can be cached and reused later In the case of standard archives, this function will just return a pointer to itself.
bool	IsProxyOf ( FArchive* InOther )	Determine if the given archive is a valid "child" of this archive.
bool	IsUsingEventDrivenLoader()	Returns whether the Event Driven Loader is enabled or not.
void	Logf ( const FmtType& Fmt, Types... Args )	Logf implementation for convenience.
void	MarkScriptSerializationEnd ( const UObject* Obj )	Called when an object stops serializing property data using script serialization.
void	MarkScriptSerializationStart ( const UObject* Obj )	Called when an object begins serializing property data using script serialization.
void	MarkSearchableName ( const UObject* TypeObject, const FName& ValueName )	Called to register a reference to a specific name value, of type TypeObject (UEnum or UStruct normally).
void	PopDebugDataString()
void	PopFileRegionType()
void	PopSerializedProperty ( FProperty* InProperty, const bool bIsEditorOnlyProperty )	Pop a property that was previously being serialized off the property stack
bool	Precache ( int64 PrecacheOffset, int64 PrecacheSize )	Hint the archive that the region starting at passed in offset and spanning the passed in size is going to be read soon and should be precached.
void	Preload ( UObject* Object )	Tells the archive to attempt to preload the specified object so data can be loaded out of it.
void	PushDebugDataString ( const FName& DebugData )	Debug stack storage if you want to add data to the archive for usage further down the serialization stack this should be used in conjunction with the FScopeAddDebugData struct
void	PushFileRegionType ( EFileRegionType Type )	Called whilst cooking to provide file region hints to the cooker.
void	PushSerializedProperty ( FProperty* InProperty, const bool bIsEditorOnlyProperty )	Push a property that is currently being serialized onto the property stack
void	Seek ( int64 InPos )	Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.
void	Serialize ( void* V, int64 Length )
void	SerializeBits ( void* V, int64 LengthBits )
void	SerializeBool ( bool& D )	Serializes a Boolean value from or into an archive.
void	SerializeCompressed ( void* V, int64 Length, FName CompressionFormat, ECompressionFlags Flags, bool bTreatBufferAsFileReader )	Serializes and compresses/ uncompresses data.
void	SerializeInt ( uint32& Value, uint32 Max )
void	SerializeIntPacked ( uint32& Value )	Packs int value into bytes of 7 bits with 8th bit for 'more'
bool	SetCompressionMap ( TArray< struct FCompressedChunk >&..., ECompressionFlags CompressionFlags )	Sets mapping from offsets/ sizes that are going to be used for seeking and serialization to what is actually stored on disk.
void	StartSerializingDefaults()	Sets a flag indicating that this archive is currently serializing class/struct defaults.
void	StopSerializingDefaults()	Indicate that this archive is no longer serializing class/struct defaults.
void	UsingCustomVersion ( const FGuid& Guid )	Registers the custom version to the archive.

Operators

	Name	Description
FArchive &	operator<< ( FField*& Value )	Serializes a Field value from or into this archive.
FArchive &	operator<< ( UObject*& Value )	Serializes an UObject value from or into this archive.
FArchive &	operator<< ( FText& Value )	Serializes an FText value from or into an archive.
FArchive &	operator<< ( FName& Value )	Serializes an FName value from or into this archive.
FArchive &	operator<< ( FLazyObjectPtr& Value )	Serializes a lazy object pointer value from or into this archive.
FArchive &	operator<< ( FSoftObjectPtr& Value )	Serializes asset pointer from or into this archive.
FArchive &	operator<< ( TCheckedObjPtr< T >& Value )	Serializes a UObject wrapped in a TCheckedObjPtr container, using the above operator, and verifies the serialized object is derived from the correct base class, to prevent illegal casting.
FArchive &	operator<< ( FWeakObjectPtr& Value )	Serializes FWeakObjectPtr value from or into this archive.
FArchive &	operator<< ( FSoftObjectPath& Value )	Serializes soft object paths from or into this archive.
FArchive &	operator= ( const FArchive& ArchiveToCopy )

Classes

	Name	Description
	FScopeAddDebugData
	FScopeSetDebugSerializationFlags

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss