FObjectPostSaveContext Class Reference

#include <ObjectSaveContext.h>

Inheritance diagram for FObjectPostSaveContext:

Public Member Functions
	FObjectPostSaveContext (FObjectSaveContextData &InData)
	FObjectPostSaveContext (const FObjectPostSaveContext &Other)
const TCHAR *	GetTargetFilename () const
bool	IsCooking () const
const ITargetPlatform *	GetTargetPlatform () const
bool	IsCookByTheBook () const
bool	IsCookOnTheFly () const
bool	IsCookTypeUnknown () const
UE::Cook::ECookType	GetCookType () const
UE::Cook::ECookingDLC	GetCookingDLC () const
bool	IsProceduralSave () const
bool	IsFromAutoSave () const
bool	IsUpdatingLoadedPath () const
uint32	GetSaveFlags () const
uint32	GetOriginalPackageFlags () const
bool	SaveSucceeded () const
bool	IsLastConcurrentSave () const
EObjectSaveContextPhase	GetPhase () const

Protected Attributes
FObjectSaveContextData &	Data

Friends
class	UObject

Detailed Description

Interface used by PostSave to access the save parameters.

Constructor & Destructor Documentation

FObjectPostSaveContext() [1/2]

FObjectPostSaveContext::FObjectPostSaveContext ( FObjectSaveContextData &  InData )

inlineexplicit

FObjectPostSaveContext() [2/2]

FObjectPostSaveContext::FObjectPostSaveContext ( const FObjectPostSaveContext &  Other )

inline

Member Function Documentation

GetCookingDLC()

UE::Cook::ECookingDLC FObjectPostSaveContext::GetCookingDLC ( ) const

inline

GetCookType()

UE::Cook::ECookType FObjectPostSaveContext::GetCookType ( ) const

inline

GetOriginalPackageFlags()

uint32 FObjectPostSaveContext::GetOriginalPackageFlags ( ) const

inline

Package->GetPackageFlags before the save, or 0 if no package.

GetPhase()

EObjectSaveContextPhase FObjectPostSaveContext::GetPhase ( ) const

inline

Return which phase of SavePackage callbacks are active.

See also

EObjectSaveContextPhase.

GetSaveFlags()

uint32 FObjectPostSaveContext::GetSaveFlags ( ) const

inline

Return the save flags (ESaveFlags) of the save.

GetTargetFilename()

const TCHAR * FObjectPostSaveContext::GetTargetFilename ( ) const

inline

The target Filename being saved into (not the temporary file for saving). The path is in the standard UnrealEngine form - it is as a relative path from the process binary directory. Empty string if the saved bytes are not being saved to a file. Never null.

GetTargetPlatform()

const ITargetPlatform * FObjectPostSaveContext::GetTargetPlatform ( ) const

inline

Return the targetplatform of the save, if cooking. Null if not cooking.

IsCookByTheBook()

bool FObjectPostSaveContext::IsCookByTheBook ( ) const

inline

IsCooking()

bool FObjectPostSaveContext::IsCooking ( ) const

inline

Report whether this is a save into a target-specific cooked format.

IsCookOnTheFly()

bool FObjectPostSaveContext::IsCookOnTheFly ( ) const

inline

IsCookTypeUnknown()

bool FObjectPostSaveContext::IsCookTypeUnknown ( ) const

inline

IsFromAutoSave()

bool FObjectPostSaveContext::IsFromAutoSave ( ) const

inline

Return whether the package is being saved due to the editor auto save feature.

IsLastConcurrentSave()

bool FObjectPostSaveContext::IsLastConcurrentSave ( ) const

inline

Always true normally. When a system is executing multiple PreSaves and PostSaves concurrently before a single save, PostSaves are executed in reverse order of the PreSaves, and this function returns false for all but the last one.

IsProceduralSave()

bool FObjectPostSaveContext::IsProceduralSave ( ) const

inline

Return whether the package is being saved due to a procedural save. Any save without the possibility of user-generated edits to the package is a procedural save (Cooking, EditorDomain). This allows us to execute transforms that only need to be executed in response to new user data.

IsUpdatingLoadedPath()

bool FObjectPostSaveContext::IsUpdatingLoadedPath ( ) const

inline

Return whether LoadedPath of the package being saved is being updated. This allows us to update the in-memory package when it is saved in editor to match its new save file.

SaveSucceeded()

bool FObjectPostSaveContext::SaveSucceeded ( ) const

inline

Return whether the Save was successful. Note that some PostSave operations are only called when this is true.

Friends And Related Symbol Documentation

UObject

friend class UObject

friend

Member Data Documentation

Data

FObjectSaveContextData& FObjectPostSaveContext::Data

protected

---

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

• Engine/Source/Runtime/CoreUObject/Public/UObject/ObjectSaveContext.h