Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FArchiveProxy Class Reference

#include <ArchiveProxy.h>

+ Inheritance diagram for FArchiveProxy:
+ Collaboration diagram for FArchiveProxy:

Public Member Functions

 FArchiveProxy (FArchive &InInnerArchive)
 
 ~FArchiveProxy ()
 
 FArchiveProxy (FArchiveProxy &&)=delete
 
 FArchiveProxy (const FArchiveProxy &)=delete
 
FArchiveProxyoperator= (FArchiveProxy &&)=delete
 
FArchiveProxyoperator= (const FArchiveProxy &)=delete
 
virtual FArchiveoperator<< (FName &Value) override
 
virtual FArchiveoperator<< (FText &Value) override
 
virtual FArchiveoperator<< (UObject *&Value) override
 
virtual FArchiveoperator<< (FObjectPtr &Value) override
 
virtual FArchiveoperator<< (FLazyObjectPtr &Value) override
 
virtual FArchiveoperator<< (FSoftObjectPath &Value) override
 
virtual FArchiveoperator<< (FSoftObjectPtr &Value) override
 
virtual FArchiveoperator<< (FWeakObjectPtr &Value) override
 
virtual FArchiveoperator<< (FField *&Value) override
 
virtual void Serialize (void *V, int64 Length) override
 
virtual void SerializeBits (void *Bits, int64 LengthBits) override
 
virtual void SerializeInt (uint32 &Value, uint32 Max) override
 
virtual void SerializeIntPacked (uint32 &Value) override
 
virtual void Preload (UObject *Object) override
 
virtual void CountBytes (SIZE_T InNum, SIZE_T InMax) override
 
virtual FString GetArchiveName () const override
 
virtual FLinkerGetLinker () override
 
virtual int64 Tell () override
 
virtual int64 TotalSize () override
 
virtual bool AtEnd () override
 
virtual void Seek (int64 InPos) override
 
virtual void AttachBulkData (UObject *Owner, FBulkData *BulkData) override
 
virtual void DetachBulkData (FBulkData *BulkData, bool bEnsureBulkDataIsLoaded) override
 
virtual bool SerializeBulkData (class FBulkData &BulkData, const struct FBulkDataSerializationParams &Params) override
 
virtual bool Precache (int64 PrecacheOffset, int64 PrecacheSize) override
 
virtual bool SetCompressionMap (TArray< FCompressedChunk > *CompressedChunks, ECompressionFlags CompressionFlags) override
 
virtual void Flush () override
 
virtual bool Close () override
 
virtual void MarkScriptSerializationStart (const UObject *Obj) override
 
virtual void MarkScriptSerializationEnd (const UObject *Obj) override
 
virtual const FCustomVersionContainerGetCustomVersions () const override
 
virtual void SetCustomVersions (const FCustomVersionContainer &NewVersions) override
 
virtual void ResetCustomVersions () override
 
virtual void MarkSearchableName (const UObject *TypeObject, const FName &ValueName) const override
 
virtual UObjectGetArchetypeFromLoader (const UObject *Obj) override
 
virtual bool AttachExternalReadDependency (FExternalReadCallback &ReadCallback) override
 
virtual bool ShouldSkipProperty (const FProperty *InProperty) const override
 
virtual bool UseToResolveEnumerators () const override
 
virtual void FlushCache () override
 
virtual void ForceBlueprintFinalization () override
 
virtual void SetFilterEditorOnly (bool InFilterEditorOnly) override
 
FORCEINLINE void SetSerializedProperty (FProperty *InProperty) override
 
void SetSerializedPropertyChain (const FArchiveSerializedPropertyChain *InSerializedPropertyChain, struct FProperty *InSerializedPropertyOverride=nullptr) override
 
virtual FORCEINLINE void PushSerializedProperty (struct FProperty *InProperty, const bool bIsEditorOnlyProperty)
 
virtual FORCEINLINE void PopSerializedProperty (struct FProperty *InProperty, const bool bIsEditorOnlyProperty)
 
virtual FORCEINLINE bool IsProxyOf (FArchive *InOther) const
 
virtual FArchiveGetCacheableArchive () override
 
virtual::FArchiveState & GetInnermostState () override
 
- Public Member Functions inherited from FArchive
 FArchive ()=default
 
 FArchive (const FArchive &)=default
 
FArchiveoperator= (const FArchive &ArchiveToCopy)=default
 
 ~FArchive ()=default
 
template<class T >
FORCEINLINE FArchiveoperator<< (TCheckedObjPtr< T > &Value)
 
FArchiveStateGetArchiveState ()
 
const FArchiveStateGetArchiveState () const
 
virtual void AttachBulkData (UE::Serialization::FEditorBulkData *BulkData)
 
virtual void DetachBulkData (UE::Serialization::FEditorBulkData *BulkData, bool bEnsureBulkDataIsLoaded)
 
void SerializeCompressed (void *V, int64 Length, FName CompressionFormatCannotChange, ECompressionFlags Flags=COMPRESS_NoFlags, bool bTreatBufferAsFileReader=false)
 
void SerializeCompressedNew (void *V, int64 Length, FName CompressionFormatToEncode, FName CompressionFormatToDecodeOldV1Files, ECompressionFlags Flags=COMPRESS_NoFlags, bool bTreatBufferAsFileReader=false, int64 *OutPartialReadLength=nullptr)
 
void SerializeCompressedNew (void *V, int64 Length)
 
void ByteSwap (void *V, int32 Length)
 
FORCEINLINE FArchiveByteOrderSerialize (void *V, int32 Length)
 
void StartSerializingDefaults ()
 
void StopSerializingDefaults ()
 
template<typename FmtType , typename... Types>
void Logf (const FmtType &Fmt, Types... Args)
 
virtual void UsingCustomVersion (const struct FGuid &Guid)
 
template<SIZE_T Size>
FORCEINLINE bool FastPathLoad (void *InDest)
 
virtual void PushFileRegionType (EFileRegionType Type)
 
virtual void PopFileRegionType ()
 
void SetArchiveState (const FArchiveState &InState)
 
void SetError ()
 
void ClearError ()
 
FORCEINLINE bool IsByteSwapping ()
 
void ThisContainsCode ()
 
void ThisContainsMap ()
 
void ThisRequiresLocalizationGather ()
 
FORCEINLINE FPackageFileVersion UEVer () const
 
FORCEINLINE int32 UE4Ver () const
 
FORCEINLINE int32 LicenseeUEVer () const
 
FORCEINLINE FEngineVersionBase EngineVer () const
 
uint32 EngineNetVer () const
 
uint32 GameNetVer () const
 
int32 CustomVer (const struct FGuid &Key) const
 
FORCEINLINE bool IsLoading () const
 
FORCEINLINE bool IsLoadingFromCookedPackage () const
 
FORCEINLINE bool IsSaving () const
 
FORCEINLINE bool IsTransacting () const
 
FORCEINLINE bool IsTextFormat () const
 
FORCEINLINE bool WantBinaryPropertySerialization () const
 
FORCEINLINE bool UseUnversionedPropertySerialization () const
 
FORCEINLINE bool IsForcingUnicode () const
 
FORCEINLINE bool IsPersistent () const
 
FORCEINLINE bool GetError () const
 
FORCEINLINE bool IsError () const
 
FORCEINLINE bool IsCriticalError () const
 
FORCEINLINE bool ContainsCode () const
 
FORCEINLINE bool ContainsMap () const
 
FORCEINLINE bool RequiresLocalizationGather () const
 
FORCEINLINE bool ForceByteSwapping () const
 
FORCEINLINE bool IsSerializingDefaults () const
 
FORCEINLINE bool IsIgnoringArchetypeRef () const
 
FORCEINLINE bool DoDelta () const
 
FORCEINLINE bool DoIntraPropertyDelta () const
 
FORCEINLINE bool IsIgnoringOuterRef () const
 
FORCEINLINE bool IsIgnoringClassGeneratedByRef () const
 
FORCEINLINE bool IsIgnoringClassRef () const
 
FORCEINLINE bool IsAllowingLazyLoading () const
 
FORCEINLINE bool IsObjectReferenceCollector () const
 
FORCEINLINE bool IsModifyingWeakAndStrongReferences () const
 
FORCEINLINE bool IsCountingMemory () const
 
FORCEINLINE uint32 GetPortFlags () const
 
FORCEINLINE bool HasAnyPortFlags (uint32 Flags) const
 
FORCEINLINE bool HasAllPortFlags (uint32 Flags) const
 
FORCEINLINE uint32 GetDebugSerializationFlags () const
 
FORCEINLINE bool ShouldSkipBulkData () const
 
FORCEINLINE int64 GetMaxSerializeSize () const
 
void SetCustomVersion (const struct FGuid &Key, int32 Version, FName FriendlyName)
 
void SetByteSwapping (bool Enabled)
 
void SetPortFlags (uint32 InPortFlags)
 
void SetDebugSerializationFlags (uint32 InCustomFlags)
 
bool IsFilterEditorOnly () const
 
bool IsSaveGame () const
 
FORCEINLINE bool IsNetArchive () const
 
FORCEINLINE bool IsCooking () const
 
FORCEINLINE const ITargetPlatformCookingTarget () const
 
void SetCookData (FArchiveCookData *InCookData)
 
FArchiveCookDataGetCookData ()
 
FORCEINLINE FArchiveCookContextGetCookContext ()
 
FORCEINLINE struct FPropertyGetSerializedProperty () const
 
void GetSerializedPropertyChain (TArray< struct FProperty * > &OutProperties) const
 
FORCEINLINE const FArchiveSerializedPropertyChainGetSerializedPropertyChain () const
 
virtual void SetSerializeContext (FUObjectSerializeContext *InLoadContext)
 
virtual FUObjectSerializeContextGetSerializeContext ()
 
virtual void Reset ()
 
virtual void SetIsLoading (bool bInIsLoading)
 
virtual void SetIsLoadingFromCookedPackage (bool bInIsLoadingFromCookedPackage)
 
virtual void SetIsSaving (bool bInIsSaving)
 
virtual void SetIsTransacting (bool bInIsTransacting)
 
virtual void SetIsTextFormat (bool bInIsTextFormat)
 
virtual void SetWantBinaryPropertySerialization (bool bInWantBinaryPropertySerialization)
 
virtual void SetUseUnversionedPropertySerialization (bool bInUseUnversioned)
 
virtual void SetForceUnicode (bool bInForceUnicode)
 
virtual void SetIsPersistent (bool bInIsPersistent)
 
virtual void SetUEVer (FPackageFileVersion InVer)
 
FORCEINLINE void SetUE4Ver (int32 InVer)
 
virtual void SetLicenseeUEVer (int32 InVer)
 
virtual void SetEngineVer (const FEngineVersionBase &InVer)
 
virtual void SetEngineNetVer (const uint32 InEngineNetVer)
 
virtual void SetGameNetVer (const uint32 InGameNetVer)
 
FORCEINLINE bool ShouldSkipCompilingAssets () const
 

Protected Attributes

FArchiveInnerArchive
 

Additional Inherited Members

- Public Attributes inherited from FArchive
FFastPathLoadBufferActiveFPLB
 
FFastPathLoadBuffer InlineFPLB
 
uint8 ArContainsCode: 1
 
uint8 ArContainsMap: 1
 
uint8 ArRequiresLocalizationGather: 1
 
uint8 ArForceByteSwapping: 1
 
uint8 ArIgnoreArchetypeRef: 1
 
uint8 ArNoDelta: 1
 
uint8 ArNoIntraPropertyDelta: 1
 
uint8 ArIgnoreOuterRef: 1
 
uint8 ArIgnoreClassGeneratedByRef: 1
 
uint8 ArIgnoreClassRef: 1
 
uint8 ArAllowLazyLoading: 1
 
uint8 ArIsObjectReferenceCollector: 1
 
uint8 ArIsModifyingWeakAndStrongReferences: 1
 
uint8 ArIsCountingMemory: 1
 
uint8 ArShouldSkipBulkData: 1
 
uint8 ArIsFilterEditorOnly: 1
 
uint8 ArIsSaveGame: 1
 
uint8 ArIsNetArchive: 1
 
uint8 ArUseCustomPropertyList: 1
 
int32 ArSerializingDefaults
 
uint32 ArPortFlags
 
int64 ArMaxSerializeSize
 
const struct FCustomPropertyListNodeArCustomPropertyList
 
- Protected Member Functions inherited from FArchive
void SetShouldSkipCompilingAssets (bool Enabled)
 
- Static Protected Member Functions inherited from FArchive
static void LinkProxy (FArchiveState &Inner, FArchiveState &Proxy)
 
static void UnlinkProxy (FArchiveState &Inner, FArchiveState &Proxy)
 

Detailed Description

Base class for archive proxies.

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

Definition at line 14 of file ArchiveProxy.h.

Constructor & Destructor Documentation

◆ FArchiveProxy() [1/3]

FArchiveProxy::FArchiveProxy ( FArchive & InInnerArchive)

Creates and initializes a new instance of the archive proxy.

Parameters
InInnerArchiveThe inner archive to proxy.
+ Here is the caller graph for this function:

◆ ~FArchiveProxy()

FArchiveProxy::~FArchiveProxy ( )

◆ FArchiveProxy() [2/3]

FArchiveProxy::FArchiveProxy ( FArchiveProxy && )
delete

◆ FArchiveProxy() [3/3]

FArchiveProxy::FArchiveProxy ( const FArchiveProxy & )
delete

Member Function Documentation

◆ AtEnd()

virtual bool FArchiveProxy::AtEnd ( )
inlineoverridevirtual

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

Reimplemented from FArchive.

Definition at line 137 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ AttachBulkData()

virtual void FArchiveProxy::AttachBulkData ( UObject * Owner,
FBulkData * BulkData )
inlineoverridevirtual

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

Parameters
OwnerUObject owning the bulk data
BulkDataBulk data object to associate

Reimplemented from FArchive.

Definition at line 147 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ AttachExternalReadDependency()

virtual bool FArchiveProxy::AttachExternalReadDependency ( FExternalReadCallback & ReadCallback)
inlineoverridevirtual

Adds external read dependency

Returns
true if dependency has been added, false if Archive does not support them

Reimplemented from FArchive.

Definition at line 217 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ Close()

virtual bool FArchiveProxy::Close ( )
inlineoverridevirtual

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

Reimplemented from FArchive.

Definition at line 177 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ CountBytes()

virtual void FArchiveProxy::CountBytes ( SIZE_T InNum,
SIZE_T InMax )
inlineoverridevirtual

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

Reimplemented from FArchive.

Definition at line 110 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ DetachBulkData()

virtual void FArchiveProxy::DetachBulkData ( FBulkData * BulkData,
bool bEnsureBulkDataIsLoaded )
inlineoverridevirtual

Detaches the passed in bulk data object from the linker.

Parameters
BulkDataBulk data object to detach
bEnsureBulkDataIsLoadedWhether to ensure that the bulk data is loaded before detaching

Reimplemented from FArchive.

Definition at line 152 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ Flush()

virtual void FArchiveProxy::Flush ( )
inlineoverridevirtual

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

Reimplemented from FArchive.

Definition at line 172 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ FlushCache()

virtual void FArchiveProxy::FlushCache ( )
inlineoverridevirtual

Flushes cache and frees internal data.

Reimplemented from FArchive.

Definition at line 232 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ ForceBlueprintFinalization()

virtual void FArchiveProxy::ForceBlueprintFinalization ( )
inlineoverridevirtual

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.

Reimplemented from FArchive.

Definition at line 237 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ GetArchetypeFromLoader()

virtual UObject * FArchiveProxy::GetArchetypeFromLoader ( const UObject * Obj)
inlineoverridevirtual

Called to retrieve the archetype from the event driven loader. If this returns null, then call GetArchetype yourself.

Reimplemented from FArchive.

Definition at line 212 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ GetArchiveName()

virtual FString FArchiveProxy::GetArchiveName ( ) const
overridevirtual

Returns the name of the Archive. Useful for getting the name of the package a struct or object is in when a loading error occurs.

This is overridden for the specific Archive Types

Reimplemented from FArchive.

◆ GetCacheableArchive()

virtual FArchive * FArchiveProxy::GetCacheableArchive ( )
inlineoverridevirtual

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. If the archive is actually a temporary proxy to another archive, and has a shorter lifecycle than the source archive, it should return either a pointer to the underlying archive, or if the data becomes inaccessible when the proxy object disappears (as is the case with text format archives) then nullptr

Reimplemented from FArchive.

Definition at line 296 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ GetCustomVersions()

virtual const FCustomVersionContainer & FArchiveProxy::GetCustomVersions ( ) const
inlineoverridevirtual

Gets the custom version numbers for this archive. These are used to check for system or game-specific version numbers.

Returns
The container of custom versions in the archive.

Reimplemented from FArchive.

Definition at line 192 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ GetInnermostState()

virtual::FArchiveState & FArchiveProxy::GetInnermostState ( )
inlineoverridevirtual

Returns lowest level archive state, proxy archives will override this.

Reimplemented from FArchive.

Definition at line 301 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ GetLinker()

virtual FLinker * FArchiveProxy::GetLinker ( )
inlineoverridevirtual

If this archive is a FLinkerLoad or FLinkerSave, returns a pointer to the ULinker portion.

Returns
The linker, or nullptr if the archive is not a linker.

Reimplemented from FArchive.

Definition at line 117 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ IsProxyOf()

virtual FORCEINLINE bool FArchiveProxy::IsProxyOf ( FArchive * InOther) const
inlinevirtual

Determine if the given archive is a valid "child" of this archive. In general, this means "is exactly the same" but this function allows a derived archive to support "child" or "internal" archives which are different objects that proxy the original one in some way.

Parameters
BulkDataBulk data object to detach
bEnsureBulkDataIsLoadedWhether to ensure that the bulk data is loaded before detaching

Reimplemented from FArchive.

Definition at line 291 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ MarkScriptSerializationEnd()

virtual void FArchiveProxy::MarkScriptSerializationEnd ( const UObject * Obj)
inlineoverridevirtual

Called when an object stops serializing property data using script serialization.

Reimplemented from FArchive.

Definition at line 187 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ MarkScriptSerializationStart()

virtual void FArchiveProxy::MarkScriptSerializationStart ( const UObject * Obj)
inlineoverridevirtual

Called when an object begins serializing property data using script serialization.

Reimplemented from FArchive.

Definition at line 182 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ MarkSearchableName()

virtual void FArchiveProxy::MarkSearchableName ( const UObject * TypeObject,
const FName & ValueName ) const
inlineoverridevirtual

Called to register a reference to a specific name value, of type TypeObject (UEnum or UStruct normally). Const so it can be called from PostSerialize

Reimplemented from FArchive.

Definition at line 207 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ operator<<() [1/9]

virtual FArchive & FArchiveProxy::operator<< ( FField *& Value)
inlineoverridevirtual

Serializes a Field value from or into this archive.

This operator can be implemented by sub-classes that wish to serialize UObject instances.

Parameters
ValueThe value to serialize.
Returns
This instance.

Reimplemented from FArchive.

Definition at line 79 of file ArchiveProxy.h.

◆ operator<<() [2/9]

virtual FArchive & FArchiveProxy::operator<< ( FLazyObjectPtr & Value)
inlineoverridevirtual

Serializes a lazy object pointer value from or into this archive.

Most of the time, FLazyObjectPtrs are serialized as UObject*, but some archives need to override this.

Parameters
ValueThe value to serialize.
Returns
This instance.

Reimplemented from FArchive.

Definition at line 55 of file ArchiveProxy.h.

◆ operator<<() [3/9]

virtual FArchive & FArchiveProxy::operator<< ( FName & Value)
inlineoverridevirtual

Serializes an FName value from or into this archive.

This operator can be implemented by sub-classes that wish to serialize FName instances.

Parameters
ValueThe value to serialize.
Returns
This instance.

Reimplemented from FArchive.

Reimplemented in FNameAsStringProxyArchive, and FNameAsStringIndexProxyArchive.

Definition at line 31 of file ArchiveProxy.h.

◆ operator<<() [4/9]

virtual FArchive & FArchiveProxy::operator<< ( FObjectPtr & Value)
inlineoverridevirtual

Serializes a wrapped object pointer value from or into this archive.

Most of the time, FObjectPtrs are serialized as UObject*, but some archives need to override this.

Parameters
ValueThe value to serialize.
Returns
This instance.

Reimplemented from FArchive.

Definition at line 49 of file ArchiveProxy.h.

◆ operator<<() [5/9]

virtual FArchive & FArchiveProxy::operator<< ( FSoftObjectPath & Value)
inlineoverridevirtual

Serializes soft object paths from or into this archive.

Parameters
ValueSoft object path to serialize.
Returns
This instance.

Reimplemented from FArchive.

Definition at line 61 of file ArchiveProxy.h.

◆ operator<<() [6/9]

virtual FArchive & FArchiveProxy::operator<< ( FSoftObjectPtr & Value)
inlineoverridevirtual

Serializes asset pointer from or into this archive.

Most of the time, FSoftObjectPtr are serialized as UObject *, but some archives need to override this.

Parameters
ValueThe asset pointer to serialize.
Returns
This instance.

Reimplemented from FArchive.

Definition at line 67 of file ArchiveProxy.h.

◆ operator<<() [7/9]

virtual FArchive & FArchiveProxy::operator<< ( FText & Value)
inlineoverridevirtual

Serializes an FText value from or into an archive.

Parameters
ArThe archive to serialize from or to.
ValueThe value to serialize.

Reimplemented from FArchive.

Definition at line 37 of file ArchiveProxy.h.

◆ operator<<() [8/9]

virtual FArchive & FArchiveProxy::operator<< ( FWeakObjectPtr & Value)
inlineoverridevirtual

Serializes FWeakObjectPtr value from or into this archive.

This operator can be implemented by sub-classes that wish to serialize FWeakObjectPtr instances.

Parameters
ValueThe value to serialize.
Returns
This instance.

Reimplemented from FArchive.

Definition at line 73 of file ArchiveProxy.h.

◆ operator<<() [9/9]

virtual FArchive & FArchiveProxy::operator<< ( UObject *& Value)
inlineoverridevirtual

Serializes an UObject value from or into this archive.

This operator can be implemented by sub-classes that wish to serialize UObject instances.

Parameters
ValueThe value to serialize.
Returns
This instance.

Reimplemented from FArchive.

Definition at line 43 of file ArchiveProxy.h.

◆ operator=() [1/2]

FArchiveProxy & FArchiveProxy::operator= ( const FArchiveProxy & )
delete

◆ operator=() [2/2]

FArchiveProxy & FArchiveProxy::operator= ( FArchiveProxy && )
delete

◆ PopSerializedProperty()

virtual FORCEINLINE void FArchiveProxy::PopSerializedProperty ( struct FProperty * InProperty,
const bool bIsEditorOnlyProperty )
inlinevirtual

Pops editor-only marker from the stack of currently serialized properties

Reimplemented from FArchive.

Definition at line 278 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ Precache()

virtual bool FArchiveProxy::Precache ( int64 PrecacheOffset,
int64 PrecacheSize )
inlineoverridevirtual

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.

The function returns whether the precache operation has completed or not which is an important hint for code knowing that it deals with potential async I/O. The archive is free to either not implement this function or only partially precache so it is required that given sufficient time the function will return true. Archives not based on async I/O should always return true.

This function will not change the current archive position.

Parameters
PrecacheOffsetOffset at which to begin precaching.
PrecacheSizeNumber of bytes to precache
Returns
false if precache operation is still pending, true otherwise

Reimplemented from FArchive.

Definition at line 162 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ Preload()

virtual void FArchiveProxy::Preload ( UObject * Object)
inlineoverridevirtual

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

Reimplemented from FArchive.

Definition at line 105 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ PushSerializedProperty()

virtual FORCEINLINE void FArchiveProxy::PushSerializedProperty ( struct FProperty * InProperty,
const bool bIsEditorOnlyProperty )
inlinevirtual

Pushes editor-only marker to the stack of currently serialized properties

Reimplemented from FArchive.

Definition at line 272 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ ResetCustomVersions()

virtual void FArchiveProxy::ResetCustomVersions ( )
inlineoverridevirtual

Resets the custom version numbers for this archive.

Reimplemented from FArchive.

Definition at line 202 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ Seek()

virtual void FArchiveProxy::Seek ( int64 InPos)
inlineoverridevirtual

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

Reimplemented from FArchive.

Definition at line 142 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ Serialize()

virtual void FArchiveProxy::Serialize ( void * V,
int64 Length )
inlineoverridevirtual

Reimplemented from FArchive.

Definition at line 85 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ SerializeBits()

virtual void FArchiveProxy::SerializeBits ( void * Bits,
int64 LengthBits )
inlineoverridevirtual

Reimplemented from FArchive.

Definition at line 90 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ SerializeBulkData()

virtual bool FArchiveProxy::SerializeBulkData ( class FBulkData & BulkData,
const struct FBulkDataSerializationParams & Params )
inlineoverridevirtual

Serialize bulk data.

Parameters
BulkDataBulk data object to serialize
ParamsSerialization parameters
Returns
true if the bulk data was serialized, false to fallback to default serialization (inline)

Reimplemented from FArchive.

Definition at line 157 of file ArchiveProxy.h.

◆ SerializeInt()

virtual void FArchiveProxy::SerializeInt ( uint32 & Value,
uint32 Max )
inlineoverridevirtual

Reimplemented from FArchive.

Definition at line 95 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ SerializeIntPacked()

virtual void FArchiveProxy::SerializeIntPacked ( uint32 & Value)
inlineoverridevirtual

Packs int value into bytes of 7 bits with 8th bit for 'more'

Reimplemented from FArchive.

Definition at line 100 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ SetCompressionMap()

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

Sets mapping from offsets/ sizes that are going to be used for seeking and serialization to what is actually stored on disk. If the archive supports dealing with compression in this way it is going to return true.

Parameters
CompressedChunksPointer to array containing information about [un]compressed chunks
CompressionFlagsFlags determining compression format associated with mapping
Returns
true if archive supports translating offsets & uncompressing on read, false otherwise

Reimplemented from FArchive.

Definition at line 167 of file ArchiveProxy.h.

◆ SetCustomVersions()

virtual void FArchiveProxy::SetCustomVersions ( const FCustomVersionContainer & CustomVersionContainer)
inlineoverridevirtual

Sets the custom version numbers for this archive.

Parameters
CustomVersionContainer- The container of custom versions to copy into the archive.

Reimplemented from FArchive.

Definition at line 197 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ SetFilterEditorOnly()

virtual void FArchiveProxy::SetFilterEditorOnly ( bool InFilterEditorOnly)
inlineoverridevirtual

Sets a flag indicating that this archive needs to filter editor-only content.

Parameters
InFilterEditorOnlyWhether to filter editor-only content.

Reimplemented from FArchive.

Definition at line 242 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ SetSerializedProperty()

FORCEINLINE void FArchiveProxy::SetSerializedProperty ( FProperty * InProperty)
inlineoverridevirtual

Overrides the property that is currently being serialized

Note
: You likely want to call PushSerializedProperty/PopSerializedProperty instead
Parameters
InPropertyPointer to the property that is currently being serialized

Reimplemented from FArchive.

Definition at line 259 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ SetSerializedPropertyChain()

void FArchiveProxy::SetSerializedPropertyChain ( const FArchiveSerializedPropertyChain * InSerializedPropertyChain,
struct FProperty * InSerializedPropertyOverride = nullptr )
inlineoverridevirtual

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)

Reimplemented from FArchive.

Definition at line 265 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ ShouldSkipProperty()

virtual bool FArchiveProxy::ShouldSkipProperty ( const FProperty * InProperty) const
inlineoverridevirtual

Checks whether the archive wants to skip the property independent of the other flags

Reimplemented from FArchive.

Definition at line 222 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ Tell()

virtual int64 FArchiveProxy::Tell ( )
inlineoverridevirtual

Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.

Reimplemented from FArchive.

Definition at line 127 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ TotalSize()

virtual int64 FArchiveProxy::TotalSize ( )
inlineoverridevirtual

Returns total size of the backing data storage.

Reimplemented from FArchive.

Definition at line 132 of file ArchiveProxy.h.

+ Here is the call graph for this function:

◆ UseToResolveEnumerators()

virtual bool FArchiveProxy::UseToResolveEnumerators ( ) const
inlineoverridevirtual

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

Returns
true if the archive is used to resolve out-of-date enum indexes

Reimplemented from FArchive.

Definition at line 227 of file ArchiveProxy.h.

+ Here is the call graph for this function:

Member Data Documentation

◆ InnerArchive

FArchive& FArchiveProxy::InnerArchive
protected

Holds the archive that this archive is a proxy to.

Definition at line 309 of file ArchiveProxy.h.


The documentation for this class was generated from the following file: