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

Light Theme

Dark Theme

FArchiveProxy

Base class for archive proxies.

Windows

MacOS

Linux

Inheritance Hierarchy

FArchiveState

FArchive

FArchiveProxy

FArchiveFromStructuredArchiveImpl

FArchiveUObjectFromStructuredArchiveImpl

FChaosArchive

FMaterialResourceProxyReader

FNameAsStringProxyArchive

FPropertyProxyArchive

FShaderSaveArchive

References

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

Syntax

class FArchiveProxy : public FArchive

Remarks

Base class for archive proxies.

Archive proxies are archive types that modify the behavior of another archive type.

Variables

		Name	Description
	FArchive &	InnerArchive	Holds the archive that this archive is a proxy to.

Constructors

	Name	Description
	FArchiveProxy ( FArchive& InInnerArchive )	Creates and initializes a new instance of the archive proxy.

Functions

		Name	Description
	void	SetArchiveState ( const ::FArchiveState& InState )

Overridden from FArchive

	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
bool	Close()
void	DetachBulkData ( FUntypedBulkData* BulkData, bool bEnsureBulkDataIsLoaded )	Detaches the passed in bulk data object from the linker.
void	Flush()
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.
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.
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	PopSerializedProperty ( FProperty* InProperty, const bool bIsEditorOnlyProperty )	Pops editor-only marker from the stack of currently serialized properties
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 )
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	PushSerializedProperty ( FProperty* InProperty, const bool bIsEditorOnlyProperty )	Pushes editor-only marker to the stack of currently serialized properties
void	Seek ( int64 InPos )
void	Serialize ( void* V, int64 Length )
void	SerializeBits ( void* Bits, int64 LengthBits )
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< FCompressedChunk >* Co..., ECompressionFlags CompressionFlags )	Sets mapping from offsets/ sizes that are going to be used for seeking and serialization to what is actually stored on disk.

Overridden from FArchiveState

	Name	Description
bool	AtEnd()
void	CountBytes ( SIZE_T InNum, SIZE_T InMax )
UObject *...	GetArchetypeFromLoader ( const UObject* Obj )	Called to retrieve the archetype from the event driven loader.
FString	GetArchiveName()	Returns the name of the Archive.
const FCusto...	GetCustomVersions()	Gets the custom version numbers for this archive.
bool	GetError()
FLinker *...	GetLinker()	If this archive is a FLinkerLoad or FLinkerSave, returns a pointer to the ULinker portion.
FString	GetLocalizationNamespace()	Get the localization namespace that this archive should use when serializing text properties.
bool	IsEditorOnlyPropertyOnTheStack()	Returns true if the stack of currently serialized properties contains an editor-only property
void	ResetCustomVersions()	Resets the custom version numbers for this archive.
void	SetCustomVersions ( const FCustomVersionContainer& Cus... )	Sets the custom version numbers for this archive.
void	SetFilterEditorOnly ( bool InFilterEditorOnly )	Sets a flag indicating that this archive needs to filter editor-only content.
void	SetLocalizationNamespace ( const FString& InLocalizationNames... )	Set the localization namespace that this archive should use when serializing text properties.
void	SetSerializedProperty ( FProperty* InProperty )	Overrides the property that is currently being serialized
void	SetSerializedPropertyChain ( const FArchiveSerializedPropertyCha..., FProperty* InSerializedPropert... )	Set the raw serialized property chain for this archive, optionally overriding the serialized property too (or null to use the head of the property chain)
bool	ShouldSkipProperty ( const FProperty* InProperty )	Checks whether the archive wants to skip the property independent of the other flags
int64	Tell()
int64	TotalSize()
bool	UseToResolveEnumerators()	Checks whether the archive is used to resolve out-of-date enum indexes If function returns true, the archive should be called only for objects containing user defined enum

Operators

	Name	Description
FArchive &	operator<< ( FSoftObjectPtr& Value )	Serializes asset pointer from or into this archive.
FArchive &	operator<< ( FSoftObjectPath& Value )	Serializes soft object paths from or into this archive.
FArchive &	operator<< ( FLazyObjectPtr& Value )	Serializes a lazy object pointer 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<< ( FField*& Value )	Serializes a Field value from or into this archive.
FArchive &	operator<< ( FWeakObjectPtr& Value )	Serializes FWeakObjectPtr value from or into this archive.

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

Take our survey

Dismiss