UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Attributes | List of all members
FObjectSavePackageSerializeContext Class Reference

#include <ObjectSaveContext.h>

Public Member Functions

 FObjectSavePackageSerializeContext (FObjectSaveContextData &InData)
 
 FObjectSavePackageSerializeContext (const FObjectSavePackageSerializeContext &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
 
EObjectSaveContextPhase GetPhase () const
 
bool IsProceduralSave () const
 
bool IsFromAutoSave () const
 
bool IsUpdatingLoadedPath () const
 
uint32 GetSaveFlags () const
 
bool IsFirstConcurrentSave () const
 

Protected Attributes

FObjectSaveContextData & Data
 

Detailed Description

Interface used by FArchiveSavePackageData during Serialize(FArchive& Ar) to access the save parameters.

Constructor & Destructor Documentation

◆ FObjectSavePackageSerializeContext() [1/2]

FObjectSavePackageSerializeContext::FObjectSavePackageSerializeContext ( FObjectSaveContextData &  InData)
inlineexplicit

◆ FObjectSavePackageSerializeContext() [2/2]

FObjectSavePackageSerializeContext::FObjectSavePackageSerializeContext ( const FObjectSavePackageSerializeContext &  Other)
inline

Member Function Documentation

◆ GetCookingDLC()

UE::Cook::ECookingDLC FObjectSavePackageSerializeContext::GetCookingDLC ( ) const
inline

◆ GetCookType()

UE::Cook::ECookType FObjectSavePackageSerializeContext::GetCookType ( ) const
inline

◆ GetPhase()

EObjectSaveContextPhase FObjectSavePackageSerializeContext::GetPhase ( ) const
inline

Return which phase of SavePackage callbacks are active.

See also
EObjectSaveContextPhase.

◆ GetSaveFlags()

uint32 FObjectSavePackageSerializeContext::GetSaveFlags ( ) const
inline

Return the save flags (ESaveFlags) of the save.

◆ GetTargetFilename()

const TCHAR * FObjectSavePackageSerializeContext::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 * FObjectSavePackageSerializeContext::GetTargetPlatform ( ) const
inline

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

◆ IsCookByTheBook()

bool FObjectSavePackageSerializeContext::IsCookByTheBook ( ) const
inline

◆ IsCooking()

bool FObjectSavePackageSerializeContext::IsCooking ( ) const
inline

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

◆ IsCookOnTheFly()

bool FObjectSavePackageSerializeContext::IsCookOnTheFly ( ) const
inline

◆ IsCookTypeUnknown()

bool FObjectSavePackageSerializeContext::IsCookTypeUnknown ( ) const
inline

◆ IsFirstConcurrentSave()

bool FObjectSavePackageSerializeContext::IsFirstConcurrentSave ( ) const
inline

Always true normally. When a system is executing multiple PreSaves concurrently before a single save, will return false for all but the first PreSave.

◆ IsFromAutoSave()

bool FObjectSavePackageSerializeContext::IsFromAutoSave ( ) const
inline

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

◆ IsProceduralSave()

bool FObjectSavePackageSerializeContext::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 FObjectSavePackageSerializeContext::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.

Member Data Documentation

◆ Data

FObjectSaveContextData& FObjectSavePackageSerializeContext::Data
protected
The documentation for this class was generated from the following file: