#include <PackageHarvester.h>

Inheritance diagram for FPackageHarvester:

Classes
struct	FExportWithContext

class	FHarvestScope

Public Types
using	FExportingRealmsArray = TArray< ESaveRealm, TInlineAllocator< 2 > >

Public Member Functions
	FPackageHarvester (FSaveContext &InContext)

FExportWithContext	PopExportToProcess ()

void	TryHarvestExport (UObject *InObject, UE::SavePackageUtilities::FObjectStatus &ObjectStatus)

void	ProcessExport (const FExportWithContext &InProcessContext)

FHarvestScope	EnterRootReferencesScope ()

void	HarvestExportDataName (FName Name)

void	HarvestPackageHeaderName (FName Name)

void	HarvestSearchableName (TObjectPtr< UObject > TypeObject, FName Name)

void	HarvestDependency (TObjectPtr< UObject > InObj, bool bIsNative)

bool	CurrentExportHasDependency (TObjectPtr< UObject > InObj, ESaveRealm HarvestingRealm) const

TMap< UObject , TSet< FProperty > >	ReleaseTransientPropertyOverrides ()

virtual FString	GetArchiveName () const override

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

virtual FArchive &	operator<< (UObject *&Obj) override

virtual FArchive &	operator<< (struct FWeakObjectPtr &Value) override

virtual FArchive &	operator<< (FLazyObjectPtr &LazyObjectPtr) override

virtual FArchive &	operator<< (FSoftObjectPath &Value) override

virtual FArchive &	operator<< (FName &Name) override

virtual FArchive &	operator<< (FObjectPtr &Value) override

virtual bool	ShouldSkipProperty (const FProperty *InProperty) const override

Public Member Functions inherited from UE::SavePackageUtilities::Private::FArchiveSavePackageCollector
	FArchiveSavePackageCollector ()=default

COREUOBJECT_API	FArchiveSavePackageCollector (FArchiveSavePackageData &InSavePackageData, bool bFilterEditorOnly, bool bSaveUnversioned, bool bCooking)

COREUOBJECT_API void	SetArchiveFlags (FArchiveSavePackageData &InSavePackageData, bool bFilterEditorOnly, bool bSaveUnversioned, bool bCooking)

Public Member Functions inherited from FArchiveUObject
virtual FArchive &	operator<< (FSoftObjectPtr &Value) override

virtual CORE_API FArchive &	operator<< (FText &Value)

virtual FArchive &	operator<< (FField *&Value)

template<class T >
FArchive &	operator<< (TCheckedObjPtr< T > &Value)

virtual CORE_API FArchive &	operator<< (struct FSoftObjectPtr &Value)

Public Member Functions inherited from FArchive
	FArchive ()=default

	FArchive (const FArchive &)=default

FArchive &	operator= (const FArchive &ArchiveToCopy)=default

virtual CORE_API	~FArchive ()

template<class T >
FArchive &	operator<< (TCheckedObjPtr< T > &Value)

virtual void	ForceBlueprintFinalization ()

virtual void	Serialize (void *V, int64 Length)

virtual void	SerializeBits (void *V, int64 LengthBits)

virtual void	SerializeInt (uint32 &Value, uint32 Max)

virtual CORE_API void	SerializeIntPacked (uint32 &Value)

virtual CORE_API void	SerializeIntPacked64 (uint64 &Value)

virtual void	Preload (UObject *Object)

FArchiveState &	GetArchiveState ()

const FArchiveState &	GetArchiveState () const

virtual void	Seek (int64 InPos)

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 FBulkDataSerializationParams &Params)

virtual bool	IsProxyOf (FArchive *InOther) const

virtual bool	Precache (int64 PrecacheOffset, int64 PrecacheSize)

virtual void	FlushCache ()

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

virtual void	Flush ()

virtual bool	Close ()

CORE_API void	SerializeCompressed (void *V, int64 Length, FName CompressionFormatCannotChange, ECompressionFlags Flags=COMPRESS_NoFlags, bool bTreatBufferAsFileReader=false)

CORE_API void	SerializeCompressedNew (void V, int64 Length, FName CompressionFormatToEncode, FName CompressionFormatToDecodeOldV1Files, ECompressionFlags Flags=COMPRESS_NoFlags, bool bTreatBufferAsFileReader=false, int64 OutPartialReadLength=nullptr)

CORE_API void	SerializeCompressedNew (void *V, int64 Length)

CORE_API void	ByteSwap (void *V, int32 Length)

FArchive &	ByteOrderSerialize (void *V, int32 Length)

void	StartSerializingDefaults ()

void	StopSerializingDefaults ()

virtual void	MarkScriptSerializationStart (const UObject *Obj)

virtual void	MarkScriptSerializationEnd (const UObject *Obj)

template<typename FmtType , typename... Types>
void	Logf (const FmtType &Fmt, Types... Args)

virtual CORE_API void	UsingCustomVersion (const struct FGuid &Guid)

virtual FArchive *	GetCacheableArchive ()

void	SetCookData (FArchiveCookData *InCookData)

FArchiveCookData *	GetCookData ()

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

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

virtual bool	AttachExternalReadDependency (FExternalReadCallback &ReadCallback)

template<SIZE_T Size>
bool	FastPathLoad (void *InDest)

virtual void	PushFileRegionType (EFileRegionType Type)

virtual void	PopFileRegionType ()

CORE_API void	SetArchiveState (const FArchiveState &InState)

CORE_API void	SetError ()

CORE_API void	ClearError ()

CORE_API void	SetCriticalError ()

virtual FArchiveState &	GetInnermostState ()

virtual void	CountBytes (SIZE_T InNum, SIZE_T InMax)

virtual FLinker *	GetLinker ()

virtual int64	Tell ()

virtual int64	TotalSize ()

virtual bool	AtEnd ()

bool	IsByteSwapping ()

void	ThisContainsCode ()

void	ThisContainsMap ()

CORE_API void	ThisRequiresLocalizationGather ()

virtual UObject *	GetArchetypeFromLoader (const UObject *Obj)

UE_FORCEINLINE_HINT FPackageFileVersion	UEVer () const

UE_FORCEINLINE_HINT int32	LicenseeUEVer () const

UE_FORCEINLINE_HINT FEngineVersionBase	EngineVer () const

virtual CORE_API uint32	EngineNetVer () const

virtual CORE_API uint32	GameNetVer () const

CORE_API int32	CustomVer (const struct FGuid &Key) const

UE_FORCEINLINE_HINT bool	IsLoading () const

UE_FORCEINLINE_HINT bool	IsLoadingFromCookedPackage () const

UE_FORCEINLINE_HINT bool	IsSaving () const

bool	IsTransacting () const

UE_FORCEINLINE_HINT bool	IsTextFormat () const

UE_FORCEINLINE_HINT bool	WantBinaryPropertySerialization () const

UE_FORCEINLINE_HINT bool	UseUnversionedPropertySerialization () const

UE_FORCEINLINE_HINT bool	IsForcingUnicode () const

UE_FORCEINLINE_HINT bool	IsPersistent () const

UE_FORCEINLINE_HINT bool	GetError () const

UE_FORCEINLINE_HINT bool	IsError () const

UE_FORCEINLINE_HINT bool	IsCriticalError () const

UE_FORCEINLINE_HINT bool	ContainsCode () const

UE_FORCEINLINE_HINT bool	ContainsMap () const

bool	RequiresLocalizationGather () const

UE_FORCEINLINE_HINT bool	ForceByteSwapping () const

UE_FORCEINLINE_HINT bool	IsSerializingDefaults () const

UE_FORCEINLINE_HINT bool	IsIgnoringArchetypeRef () const

UE_FORCEINLINE_HINT bool	DoDelta () const

UE_FORCEINLINE_HINT bool	DoIntraPropertyDelta () const

UE_FORCEINLINE_HINT bool	IsIgnoringOuterRef () const

UE_FORCEINLINE_HINT bool	IsIgnoringClassGeneratedByRef () const

UE_FORCEINLINE_HINT bool	IsIgnoringClassRef () const

UE_FORCEINLINE_HINT bool	IsAllowingLazyLoading () const

UE_FORCEINLINE_HINT bool	IsObjectReferenceCollector () const

UE_FORCEINLINE_HINT bool	IsModifyingWeakAndStrongReferences () const

UE_FORCEINLINE_HINT bool	IsCountingMemory () const

UE_FORCEINLINE_HINT uint32	GetPortFlags () const

UE_FORCEINLINE_HINT bool	HasAnyPortFlags (uint32 Flags) const

UE_FORCEINLINE_HINT bool	HasAllPortFlags (uint32 Flags) const

uint32	GetDebugSerializationFlags () const

UE_FORCEINLINE_HINT bool	ShouldSkipBulkData () const

UE_FORCEINLINE_HINT int64	GetMaxSerializeSize () const

virtual CORE_API const FCustomVersionContainer &	GetCustomVersions () const

virtual CORE_API void	SetCustomVersions (const FCustomVersionContainer &CustomVersionContainer)

virtual CORE_API void	ResetCustomVersions ()

CORE_API void	SetCustomVersion (const struct FGuid &Key, int32 Version, FName FriendlyName)

void	SetByteSwapping (bool Enabled)

void	SetPortFlags (uint32 InPortFlags)

virtual void	SetDebugSerializationFlags (uint32 InCustomFlags)

bool	IsFilterEditorOnly () const

virtual void	SetFilterEditorOnly (bool InFilterEditorOnly)

bool	IsSavingOptionalObject () const

virtual void	SetSavingOptionalObject (bool InSavingOptionalObject)

bool	IsSaveGame () const

UE_FORCEINLINE_HINT bool	IsNetArchive () const

UE_FORCEINLINE_HINT bool	IsCooking () const

UE_FORCEINLINE_HINT const ITargetPlatform *	CookingTarget () const

void	SetSavePackageData (FArchiveSavePackageData *InSavePackageData)

FArchiveSavePackageData *	GetSavePackageData ()

UE_FORCEINLINE_HINT FArchiveCookContext *	GetCookContext ()

virtual bool	UseToResolveEnumerators () const

virtual void	SetSerializedProperty (FProperty *InProperty)

UE_FORCEINLINE_HINT class FProperty *	GetSerializedProperty () const

CORE_API void	GetSerializedPropertyChain (TArray< class FProperty * > &OutProperties) const

UE_FORCEINLINE_HINT const FArchiveSerializedPropertyChain *	GetSerializedPropertyChain () const

virtual CORE_API void	SetSerializedPropertyChain (const FArchiveSerializedPropertyChain InSerializedPropertyChain, class FProperty InSerializedPropertyOverride=nullptr)

virtual void	SetSerializeContext (FUObjectSerializeContext *InLoadContext)

virtual CORE_API void	Reset ()

virtual CORE_API void	SetIsLoading (bool bInIsLoading)

virtual CORE_API void	SetIsLoadingFromCookedPackage (bool bInIsLoadingFromCookedPackage)

virtual CORE_API void	SetIsSaving (bool bInIsSaving)

virtual CORE_API void	SetIsTransacting (bool bInIsTransacting)

virtual CORE_API void	SetIsTextFormat (bool bInIsTextFormat)

virtual CORE_API void	SetWantBinaryPropertySerialization (bool bInWantBinaryPropertySerialization)

virtual CORE_API void	SetUseUnversionedPropertySerialization (bool bInUseUnversioned)

virtual CORE_API void	SetForceUnicode (bool bInForceUnicode)

virtual CORE_API void	SetIsPersistent (bool bInIsPersistent)

virtual CORE_API void	SetUEVer (FPackageFileVersion InVer)

virtual CORE_API void	SetLicenseeUEVer (int32 InVer)

virtual CORE_API void	SetEngineVer (const FEngineVersionBase &InVer)

virtual CORE_API void	SetEngineNetVer (const uint32 InEngineNetVer)

virtual CORE_API void	SetGameNetVer (const uint32 InGameNetVer)

UE_FORCEINLINE_HINT bool	ShouldSkipCompilingAssets () const

CORE_API void	SetShouldSkipUpdateCustomVersion (bool bShouldSkip)

UE_FORCEINLINE_HINT bool	ShouldSkipUpdateCustomVersion () const

CORE_API void	SetMigratingRemoteObjects (bool bMigrating)

UE_FORCEINLINE_HINT constexpr bool	IsMigratingRemoteObjects () const

virtual const FUObjectMigrationContext *	GetMigrationContext () const

Static Public Member Functions
static bool	IsObjNative (UObject *InObj)

static bool	ShouldObjectBeHarvestedInOptionalRealm (TObjectPtr< UObject > InObj, FSaveContext &InSaveContext)

Static Public Member Functions inherited from FArchiveUObject
static COREUOBJECT_API FArchive &	SerializeLazyObjectPtr (FArchive &Ar, FLazyObjectPtr &Value)

static COREUOBJECT_API FArchive &	SerializeObjectPtr (FArchive &Ar, FObjectPtr &Value)

static COREUOBJECT_API FArchive &	SerializeSoftObjectPtr (FArchive &Ar, FSoftObjectPtr &Value)

static COREUOBJECT_API FArchive &	SerializeSoftObjectPath (FArchive &Ar, FSoftObjectPath &Value)

static COREUOBJECT_API FArchive &	SerializeWeakObjectPtr (FArchive &Ar, FWeakObjectPtr &Value)

Additional Inherited Members
Public Attributes inherited from FArchive
FFastPathLoadBuffer *	ActiveFPLB

FFastPathLoadBuffer	InlineFPLB

uint8	ArContainsCode: 1

uint8	ArContainsMap: 1

UE_DEPRECATED(5.6, "Public access to ArRequiresLocalizationGather has been deprecated - please use Ar.RequiresLocalizationGather() and Ar.ThisRequiresLocalizationGather() for getting and setting respectively.") uint8 ArRequiresLocalizationGather 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	ArIsSavingOptionalObject: 1

uint8	ArIsSaveGame: 1

uint8	ArIsNetArchive: 1

uint8	ArUseCustomPropertyList: 1

int32	ArSerializingDefaults

uint32	ArPortFlags

int64	ArMaxSerializeSize

uint8	ArMergeOverrides: 1

uint8	ArPreserveArrayElements: 1

const struct FCustomPropertyListNode *	ArCustomPropertyList

Protected Member Functions inherited from FArchive
void	SetShouldSkipCompilingAssets (bool Enabled)

Static Protected Member Functions inherited from FArchive
static CORE_API void	LinkProxy (FArchiveState &Inner, FArchiveState &Proxy)

static CORE_API void	UnlinkProxy (FArchiveState &Inner, FArchiveState &Proxy)

Detailed Description

Helper class used to gather all package exports, imports and dependencies to build linker tables when saving packages Gather Export, Imports, Referenced Names, SoftObjectPaths, Custom Object Versions

Member Typedef Documentation

◆ FExportingRealmsArray

using FPackageHarvester::FExportingRealmsArray = TArray<ESaveRealm, TInlineAllocator<2> >

Constructor & Destructor Documentation

◆ FPackageHarvester()

FPackageHarvester::FPackageHarvester ( FSaveContext & InContext )

Member Function Documentation

◆ CurrentExportHasDependency()

bool FPackageHarvester::CurrentExportHasDependency	(	TObjectPtr< UObject >	InObj,
		ESaveRealm	HarvestingRealm
	)		const

◆ EnterRootReferencesScope()

FPackageHarvester::FHarvestScope FPackageHarvester::EnterRootReferencesScope ( )

◆ GetArchiveName()

FString FPackageHarvester::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.

◆ HarvestDependency()

void FPackageHarvester::HarvestDependency	(	TObjectPtr< UObject >	InObj,
		bool	bIsNative
	)

◆ HarvestExportDataName()

void FPackageHarvester::HarvestExportDataName ( FName Name )

◆ HarvestPackageHeaderName()

void FPackageHarvester::HarvestPackageHeaderName ( FName Name )

◆ HarvestSearchableName()

void FPackageHarvester::HarvestSearchableName	(	TObjectPtr< UObject >	TypeObject,
		FName	Name
	)

◆ IsObjNative()

bool FPackageHarvester::IsObjNative ( UObject * InObj )

static

Return whether the Object and all its Outers are native.

◆ MarkSearchableName()

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

overridevirtual

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.

◆ operator<<() [1/6]

FArchive & FPackageHarvester::operator<< ( FLazyObjectPtr & Value )

overridevirtual

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

Value The value to serialize.

Returns: This instance.

Reimplemented from FArchiveUObject.

◆ operator<<() [2/6]

FArchive & FPackageHarvester::operator<< ( FName & Value )

overridevirtual

Serializes an FName value from or into this archive.

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

Parameters

Value The value to serialize.

Returns: This instance.

Reimplemented from FArchiveUObject.

◆ operator<<() [3/6]

FArchive & FPackageHarvester::operator<< ( FObjectPtr & Value )

overridevirtual

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

Value The value to serialize.

Returns: This instance.

Reimplemented from FArchiveUObject.

◆ operator<<() [4/6]

FArchive & FPackageHarvester::operator<< ( FSoftObjectPath & Value )

overridevirtual

Serializes soft object paths from or into this archive.

Parameters

Value Soft object path to serialize.

Returns: This instance.

Reimplemented from FArchiveUObject.

◆ operator<<() [5/6]

FArchive & FPackageHarvester::operator<< ( struct FWeakObjectPtr & Value )

overridevirtual

Serializes FWeakObjectPtr value from or into this archive.

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

Parameters

Value The value to serialize.

Returns: This instance.

Reimplemented from FArchiveUObject.

◆ operator<<() [6/6]

FArchive & FPackageHarvester::operator<< ( UObject *& Value )

overridevirtual

Serializes an UObject value from or into this archive.

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

Parameters

Value The value to serialize.

Returns: This instance.

Reimplemented from FArchiveUObject.

◆ PopExportToProcess()

FPackageHarvester::FExportWithContext FPackageHarvester::PopExportToProcess ( )

◆ ProcessExport()

void FPackageHarvester::ProcessExport ( const FExportWithContext & InProcessContext )

Add objects/names/others that are referenced when an object is being saved

◆ ReleaseTransientPropertyOverrides()

TMap< UObject *, TSet< FProperty * > > FPackageHarvester::ReleaseTransientPropertyOverrides ( )

◆ ShouldObjectBeHarvestedInOptionalRealm()

bool FPackageHarvester::ShouldObjectBeHarvestedInOptionalRealm	(	TObjectPtr< UObject >	InObj,
		FSaveContext &	InSaveContext
	)

static

Report whether the object should be put in the optional realm even if harvesting realm is non-optional.

◆ ShouldSkipProperty()

bool FPackageHarvester::ShouldSkipProperty ( const FProperty * InProperty ) const

overridevirtual

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

Reimplemented from FArchive.

◆ TryHarvestExport()

void FPackageHarvester::TryHarvestExport	(	UObject *	InObject,
		UE::SavePackageUtilities::FObjectStatus &	ObjectStatus
	)

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

Engine/Source/Runtime/CoreUObject/Private/UObject/SavePackage/PackageHarvester.h
Engine/Source/Runtime/CoreUObject/Private/UObject/SavePackage/PackageHarvester.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ FExportingRealmsArray

Constructor & Destructor Documentation

◆ FPackageHarvester()

Member Function Documentation

◆ CurrentExportHasDependency()

◆ EnterRootReferencesScope()

◆ GetArchiveName()

◆ HarvestDependency()

◆ HarvestExportDataName()

◆ HarvestPackageHeaderName()

◆ HarvestSearchableName()

◆ IsObjNative()

◆ MarkSearchableName()

◆ operator<<() [1/6]

◆ operator<<() [2/6]

◆ operator<<() [3/6]

◆ operator<<() [4/6]

◆ operator<<() [5/6]

◆ operator<<() [6/6]

◆ PopExportToProcess()

◆ ProcessExport()

◆ ReleaseTransientPropertyOverrides()

◆ ShouldObjectBeHarvestedInOptionalRealm()

◆ ShouldSkipProperty()

◆ TryHarvestExport()