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

#include <ArchiveSaveCompressedProxy.h>

+ Inheritance diagram for FArchiveSaveCompressedProxy:
+ Collaboration diagram for FArchiveSaveCompressedProxy:

Public Member Functions

 FArchiveSaveCompressedProxy (TArray< uint8 > &InCompressedData, ECompressionFlags InCompressionFlags)
 
 FArchiveSaveCompressedProxy (TArray< uint8 > &InCompressedData, FName InCompressionFormat, ECompressionFlags InCompressionFlags=COMPRESS_None)
 
virtual ~FArchiveSaveCompressedProxy ()
 
virtual void Flush ()
 
virtual void Serialize (void *Data, int64 Count)
 
virtual void Seek (int64 InPos)
 
virtual int64 Tell ()
 
- Public Member Functions inherited from FArchive
 FArchive ()=default
 
 FArchive (const FArchive &)=default
 
FArchiveoperator= (const FArchive &ArchiveToCopy)=default
 
 ~FArchive ()=default
 
virtual FArchiveoperator<< (FName &Value)
 
virtual FArchiveoperator<< (FText &Value)
 
virtual FArchiveoperator<< (UObject *&Value)
 
virtual FArchiveoperator<< (FField *&Value)
 
template<class T >
FORCEINLINE FArchiveoperator<< (TCheckedObjPtr< T > &Value)
 
virtual FArchiveoperator<< (struct FLazyObjectPtr &Value)
 
virtual FArchiveoperator<< (struct FObjectPtr &Value)
 
virtual FArchiveoperator<< (struct FSoftObjectPtr &Value)
 
virtual FArchiveoperator<< (struct FSoftObjectPath &Value)
 
virtual FArchiveoperator<< (struct FWeakObjectPtr &Value)
 
virtual void ForceBlueprintFinalization ()
 
virtual void SerializeBits (void *V, int64 LengthBits)
 
virtual void SerializeInt (uint32 &Value, uint32 Max)
 
virtual void SerializeIntPacked (uint32 &Value)
 
virtual void Preload (UObject *Object)
 
FArchiveStateGetArchiveState ()
 
const FArchiveStateGetArchiveState () const
 
virtual void AttachBulkData (UObject *Owner, FBulkData *BulkData)
 
virtual void AttachBulkData (UE::Serialization::FEditorBulkData *BulkData)
 
virtual void DetachBulkData (FBulkData *BulkData, bool bEnsureBulkDataIsLoaded)
 
virtual void DetachBulkData (UE::Serialization::FEditorBulkData *BulkData, bool bEnsureBulkDataIsLoaded)
 
virtual bool SerializeBulkData (FBulkData &BulkData, const struct FBulkDataSerializationParams &Params)
 
virtual bool IsProxyOf (FArchive *InOther) const
 
virtual bool Precache (int64 PrecacheOffset, int64 PrecacheSize)
 
virtual void FlushCache ()
 
virtual bool SetCompressionMap (TArray< struct FCompressedChunk > *CompressedChunks, ECompressionFlags CompressionFlags)
 
virtual bool Close ()
 
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 ()
 
virtual void MarkScriptSerializationStart (const UObject *Obj)
 
virtual void MarkScriptSerializationEnd (const UObject *Obj)
 
virtual void MarkSearchableName (const UObject *TypeObject, const FName &ValueName) const
 
template<typename FmtType , typename... Types>
void Logf (const FmtType &Fmt, Types... Args)
 
virtual void UsingCustomVersion (const struct FGuid &Guid)
 
virtual FArchiveGetCacheableArchive ()
 
virtual void PushSerializedProperty (struct FProperty *InProperty, const bool bIsEditorOnlyProperty)
 
virtual void PopSerializedProperty (struct FProperty *InProperty, const bool bIsEditorOnlyProperty)
 
virtual bool AttachExternalReadDependency (FExternalReadCallback &ReadCallback)
 
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 ()
 
virtual FArchiveStateGetInnermostState ()
 
virtual void CountBytes (SIZE_T InNum, SIZE_T InMax)
 
virtual FString GetArchiveName () const
 
virtual FLinkerGetLinker ()
 
virtual int64 TotalSize ()
 
virtual bool AtEnd ()
 
FORCEINLINE bool IsByteSwapping ()
 
void ThisContainsCode ()
 
void ThisContainsMap ()
 
void ThisRequiresLocalizationGather ()
 
virtual UObjectGetArchetypeFromLoader (const UObject *Obj)
 
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
 
virtual const FCustomVersionContainerGetCustomVersions () const
 
virtual void SetCustomVersions (const FCustomVersionContainer &CustomVersionContainer)
 
virtual void ResetCustomVersions ()
 
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
 
virtual void SetFilterEditorOnly (bool InFilterEditorOnly)
 
bool IsSaveGame () const
 
FORCEINLINE bool IsNetArchive () const
 
FORCEINLINE bool IsCooking () const
 
FORCEINLINE const ITargetPlatformCookingTarget () const
 
void SetCookData (FArchiveCookData *InCookData)
 
FArchiveCookDataGetCookData ()
 
FORCEINLINE FArchiveCookContextGetCookContext ()
 
virtual bool UseToResolveEnumerators () const
 
virtual bool ShouldSkipProperty (const FProperty *InProperty) const
 
virtual void SetSerializedProperty (FProperty *InProperty)
 
FORCEINLINE struct FPropertyGetSerializedProperty () const
 
void GetSerializedPropertyChain (TArray< struct FProperty * > &OutProperties) const
 
FORCEINLINE const FArchiveSerializedPropertyChainGetSerializedPropertyChain () const
 
virtual void SetSerializedPropertyChain (const FArchiveSerializedPropertyChain *InSerializedPropertyChain, struct FProperty *InSerializedPropertyOverride=nullptr)
 
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
 

Private Types

enum  EVS2015Redirector { Redirect }
 

Private Member Functions

 FArchiveSaveCompressedProxy (EVS2015Redirector, TArray< uint8 > &InCompressedData, ECompressionFlags InCompressionFlags)
 

Private Attributes

TArray< uint8 > & CompressedData
 
int32 CurrentIndex
 
uint8TmpDataStart
 
uint8TmpDataEnd
 
uint8TmpData
 
bool bShouldSerializeToArray
 
int64 RawBytesSerialized
 
FName CompressionFormat
 
ECompressionFlags CompressionFlags
 

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

FArchive Proxy to transparently write out compressed data to an array.

Definition at line 19 of file ArchiveSaveCompressedProxy.h.

Member Enumeration Documentation

◆ EVS2015Redirector

This enum and the following constructor is a workaround for VC compiler bug that prevents using attributes on constructors without inline implementation. This should be removed when the deprecated ctor is removed.

Enumerator
Redirect 

Definition at line 25 of file ArchiveSaveCompressedProxy.h.

Constructor & Destructor Documentation

◆ FArchiveSaveCompressedProxy() [1/3]

FArchiveSaveCompressedProxy::FArchiveSaveCompressedProxy ( EVS2015Redirector ,
TArray< uint8 > & InCompressedData,
ECompressionFlags InCompressionFlags )
private

◆ FArchiveSaveCompressedProxy() [2/3]

FArchiveSaveCompressedProxy::FArchiveSaveCompressedProxy ( TArray< uint8 > & InCompressedData,
ECompressionFlags InCompressionFlags )
inline

Constructor, initializing all member variables and allocating temp memory.

Parameters
InCompressedData[ref] Array of bytes that is going to hold compressed data
InCompressionFormatCompression format to use

Definition at line 39 of file ArchiveSaveCompressedProxy.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ FArchiveSaveCompressedProxy() [3/3]

FArchiveSaveCompressedProxy::FArchiveSaveCompressedProxy ( TArray< uint8 > & InCompressedData,
FName InCompressionFormat,
ECompressionFlags InCompressionFlags = COMPRESS_None )

◆ ~FArchiveSaveCompressedProxy()

virtual FArchiveSaveCompressedProxy::~FArchiveSaveCompressedProxy ( )
virtual

Destructor, flushing array if needed. Also frees temporary memory.

Member Function Documentation

◆ Flush()

virtual void FArchiveSaveCompressedProxy::Flush ( )
virtual

Flushes tmp data to array.

Reimplemented from FArchive.

◆ Seek()

virtual void FArchiveSaveCompressedProxy::Seek ( int64 InPos)
virtual

Seeking is only implemented internally for writing out compressed data and asserts otherwise.

Parameters
InPosPosition to seek to

Reimplemented from FArchive.

◆ Serialize()

virtual void FArchiveSaveCompressedProxy::Serialize ( void * Data,
int64 Count )
virtual

Serializes data to archive. This function is called recursively and determines where to serialize to and how to do so based on internal state.

Parameters
DataPointer to serialize to
CountNumber of bytes to read

Reimplemented from FArchive.

◆ Tell()

virtual int64 FArchiveSaveCompressedProxy::Tell ( )
virtual
Returns
current position in uncompressed stream in bytes.

Reimplemented from FArchive.

Member Data Documentation

◆ bShouldSerializeToArray

bool FArchiveSaveCompressedProxy::bShouldSerializeToArray
private

Whether to serialize to temporary buffer of array.

Definition at line 86 of file ArchiveSaveCompressedProxy.h.

◆ CompressedData

TArray<uint8>& FArchiveSaveCompressedProxy::CompressedData
private

Array to write compressed data to.

Definition at line 76 of file ArchiveSaveCompressedProxy.h.

◆ CompressionFlags

ECompressionFlags FArchiveSaveCompressedProxy::CompressionFlags
private

Flags to use for compression.

Definition at line 92 of file ArchiveSaveCompressedProxy.h.

◆ CompressionFormat

FName FArchiveSaveCompressedProxy::CompressionFormat
private

Format to use for compression.

Definition at line 90 of file ArchiveSaveCompressedProxy.h.

◆ CurrentIndex

int32 FArchiveSaveCompressedProxy::CurrentIndex
private

Current index in array.

Definition at line 78 of file ArchiveSaveCompressedProxy.h.

◆ RawBytesSerialized

int64 FArchiveSaveCompressedProxy::RawBytesSerialized
private

Number of raw (uncompressed) bytes serialized.

Definition at line 88 of file ArchiveSaveCompressedProxy.h.

◆ TmpData

uint8* FArchiveSaveCompressedProxy::TmpData
private

Pointer to current position in temporary buffer.

Definition at line 84 of file ArchiveSaveCompressedProxy.h.

◆ TmpDataEnd

uint8* FArchiveSaveCompressedProxy::TmpDataEnd
private

Pointer to end of temporary buffer.

Definition at line 82 of file ArchiveSaveCompressedProxy.h.

◆ TmpDataStart

uint8* FArchiveSaveCompressedProxy::TmpDataStart
private

Pointer to start of temporary buffer.

Definition at line 80 of file ArchiveSaveCompressedProxy.h.


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