1. Epic GamesDeveloper
  3. FArchiveProxy

FArchiveProxy

Base class for archive proxies.

API > API/Runtime > API/Runtime/Core

Base class for archive proxies.

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

   
Name FArchiveProxy
Type class
Header File /Engine/Source/Runtime/Core/Public/Serialization/ArchiveProxy.h
Include Path #include "Serialization/ArchiveProxy.h"

Syntax

class FArchiveProxy : public FArchive

Inheritance Hierarchy

Derived Classes

FArchiveProxy derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  Serialization/ArchiveProxy.h  
Non-copyable. Serialization/ArchiveProxy.h  

FArchiveProxy ( FArchive& InInnerArchive
)

 Creates and initializes a new instance of the archive proxy. Serialization/ArchiveProxy.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FArchiveProxy()

   Serialization/ArchiveProxy.h  

Functions

Public

Overridden from FArchive

Name Remarks Include Path Unreal Specifiers

virtual void AttachBulkData ( UObject* Owner,
FBulkData* BulkData
)

 Attaches/ associates the passed in bulk data object with the linker. Serialization/ArchiveProxy.h  

virtual bool AttachExternalReadDependency ( FExternalReadCallback& ReadCallback
)

 Adds external read dependency Serialization/ArchiveProxy.h  

virtual bool Close()

 Attempts to close and finalize any handles used for backing data storage, returns true if it succeeded. Serialization/ArchiveProxy.h  

virtual void DetachBulkData ( FBulkData* BulkData,
bool bEnsureBulkDataIsLoaded
)

 Detaches the passed in bulk data object from the linker. Serialization/ArchiveProxy.h  

virtual void Flush()

 Attempts to finish writing any buffered data to disk/permanent storage. Serialization/ArchiveProxy.h  

virtual void FlushCache()

 Flushes cache and frees internal data. Serialization/ArchiveProxy.h  

virtual 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. Serialization/ArchiveProxy.h  
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. Serialization/ArchiveProxy.h  

virtual bool IsProxyOf ( FArchive* InOther
) const

 Determine if the given archive is a valid "child" of this archive. Serialization/ArchiveProxy.h  

virtual void MarkScriptSerializationEnd ( const UObject* Obj
)

 Called when an object stops serializing property data using script serialization. Serialization/ArchiveProxy.h  

virtual void MarkScriptSerializationStart ( const UObject* Obj
)

 Called when an object begins serializing property data using script serialization. Serialization/ArchiveProxy.h  

virtual void MarkSearchableName ( const TObjectPtr< const UObject >& TypeObject,
const FName& ValueName
) const

 Called to register a reference to a specific name value, of type TypeObject (UEnum or UStruct normally). Serialization/ArchiveProxy.h  

virtual void PopDebugDataString()

   Serialization/ArchiveProxy.h  

virtual void PopSerializedProperty ( FProperty* InProperty,
const bool bIsEditorOnlyProperty
)

 Pops editor-only marker from the stack of currently serialized properties Serialization/ArchiveProxy.h  

virtual 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. Serialization/ArchiveProxy.h  

virtual void Preload ( UObject* Object
)

 Tells the archive to attempt to preload the specified object so data can be loaded out of it. Serialization/ArchiveProxy.h  

virtual 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 Serialization/ArchiveProxy.h  

virtual void PushSerializedProperty ( FProperty* InProperty,
const bool bIsEditorOnlyProperty
)

 Pushes editor-only marker to the stack of currently serialized properties Serialization/ArchiveProxy.h  

virtual void Seek ( int64 InPos
)

 Attempts to set the current offset into backing data storage, this will do nothing if there is no storage. Serialization/ArchiveProxy.h  

virtual void Serialize ( void* V,
int64 Length
)

   Serialization/ArchiveProxy.h  

virtual void SerializeBits ( void* Bits,
int64 LengthBits
)

   Serialization/ArchiveProxy.h  

virtual bool SerializeBulkData ( FBulkData& BulkData,
const FBulkDataSerializationParams& Params
)

 Serialize bulk data. Serialization/ArchiveProxy.h  

virtual void SerializeInt ( uint32& Value,
uint32 Max
)

   Serialization/ArchiveProxy.h  

virtual void SerializeIntPacked ( uint32& Value
)

 Packs int value into bytes of 7 bits with 8th bit for 'more' Serialization/ArchiveProxy.h  

virtual bool SetCompressionMap ( TArray< FCompressedChunk >* CompressedChunks,
ECompressionFlags CompressionFlags
)

 Sets mapping from offsets/ sizes that are going to be used for seeking and serialization to what is actually stored on disk. Serialization/ArchiveProxy.h  

Overridden from FArchiveState

Name Remarks Include Path Unreal Specifiers

virtual bool AtEnd()

 Returns true if the current location within the backing data storage is at the end, always returns false if there is no storage. Serialization/ArchiveProxy.h  

virtual void CountBytes ( SIZE_T InNum,
SIZE_T InMax
)

 Called to get the computed size from a size-detecting archive after it has finished serializing. Serialization/ArchiveProxy.h  

virtual UObject * GetArchetypeFromLoader ( const UObject* Obj
)

 Called to retrieve the archetype from the event driven loader. Serialization/ArchiveProxy.h  

virtual FString GetArchiveName ()

 Returns the name of the Archive. Serialization/ArchiveProxy.h  
Gets the custom version numbers for this archive. Serialization/ArchiveProxy.h  

virtual virtual::FArchiveState & GetInnermostState()

 Returns lowest level archive state, proxy archives will override this. Serialization/ArchiveProxy.h  

virtual FLinker * GetLinker()

 If this archive is a FLinkerLoad or FLinkerSave, returns a pointer to the ULinker portion. Serialization/ArchiveProxy.h  
Get the localization namespace that this archive should use when serializing text properties. Serialization/ArchiveProxy.h  

virtual bool IsEditorOnlyPropertyOnTheStack()

 Returns true if the stack of currently serialized properties contains an editor-only property Serialization/ArchiveProxy.h  

virtual void ResetCustomVersions()

 Resets the custom version numbers for this archive. Serialization/ArchiveProxy.h  

virtual void SetCustomVersions ( const FCustomVersionContainer& CustomVersionContainer
)

 Sets the custom version numbers for this archive. Serialization/ArchiveProxy.h  

virtual void SetDebugSerializationFlags ( uint32 InCustomFlags
)

 Sets the archives custom serialization modifier flags (nothing to do with PortFlags or Custom versions) Serialization/ArchiveProxy.h  

virtual void SetFilterEditorOnly ( bool InFilterEditorOnly
)

 Sets a flag indicating that this archive needs to filter editor-only content. Serialization/ArchiveProxy.h  

virtual void SetLocalizationNamespace ( const FString& InLocalizationNamespace
)

 Set the localization namespace that this archive should use when serializing text properties. Serialization/ArchiveProxy.h  

virtual void SetSerializedProperty ( FProperty* InProperty
)

 Overrides the property that is currently being serialized Serialization/ArchiveProxy.h  

virtual void SetSerializedPropertyChain ( const FArchiveSerializedPropertyChain* InSerializedPropertyChain,
FProperty* InSerializedPropertyOverride
)

 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) Serialization/ArchiveProxy.h  

virtual bool ShouldSkipProperty ( const FProperty* InProperty
) const

 Checks whether the archive wants to skip the property independent of the other flags Serialization/ArchiveProxy.h  

virtual int64 Tell ()

 Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. Serialization/ArchiveProxy.h  

virtual int64 TotalSize()

 Returns total size of the backing data storage. Serialization/ArchiveProxy.h  

virtual 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 Serialization/ArchiveProxy.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Serialization/ArchiveProxy.h  
  Serialization/ArchiveProxy.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page