UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSavePackageArgs Struct Reference

#include <SavePackage.h>

Public Member Functions

bool IsCooking () const
 
const ITargetPlatformGetTargetPlatform () const
 
 FSavePackageArgs ()=default
 
 FSavePackageArgs (const FSavePackageArgs &)=default
 
 FSavePackageArgs (FSavePackageArgs &&)=default
 
FSavePackageArgsoperator= (const FSavePackageArgs &)=default
 
FSavePackageArgsoperator= (FSavePackageArgs &&)=default
 
 FSavePackageArgs (const ITargetPlatform *InTargetPlatform, FArchiveCookData *InArchiveCookData, EObjectFlags InTopLevelFlags, uint32 InSaveFlags, bool bInForceByteSwapping, bool bInWarnOfLongFilename, bool bInSlowTask, FDateTime InFinalTimeStamp, FOutputDevice *InError, FSavePackageContext *InSavePackageContext=nullptr)
 

Public Attributes

FArchiveCookDataArchiveCookData = nullptr
 
EObjectFlags TopLevelFlags = RF_NoFlags
 
uint32 SaveFlags = SAVE_None
 
bool bForceByteSwapping = false
 
bool bWarnOfLongFilename = true
 
bool bSlowTask = true
 
FDateTime FinalTimeStamp
 
FOutputDeviceError = GError
 
FSavePackageContextSavePackageContext = nullptr
 
TMap< UObject *, FObjectSaveOverride > * InOutSaveOverrides = nullptr
 

Detailed Description

Struct to encapsulate UPackage::Save arguments. These arguments are shared between packages when saving multiple packages concurrently.

Constructor & Destructor Documentation

◆ FSavePackageArgs() [1/4]

FSavePackageArgs::FSavePackageArgs ( )
default

◆ FSavePackageArgs() [2/4]

FSavePackageArgs::FSavePackageArgs ( const FSavePackageArgs )
default

◆ FSavePackageArgs() [3/4]

FSavePackageArgs::FSavePackageArgs ( FSavePackageArgs &&  )
default

◆ FSavePackageArgs() [4/4]

FSavePackageArgs::FSavePackageArgs ( const ITargetPlatform InTargetPlatform,
FArchiveCookData InArchiveCookData,
EObjectFlags  InTopLevelFlags,
uint32  InSaveFlags,
bool  bInForceByteSwapping,
bool  bInWarnOfLongFilename,
bool  bInSlowTask,
FDateTime  InFinalTimeStamp,
FOutputDevice InError,
FSavePackageContext InSavePackageContext = nullptr 
)
inline

Member Function Documentation

◆ GetTargetPlatform()

const ITargetPlatform * FSavePackageArgs::GetTargetPlatform ( ) const
inline

◆ IsCooking()

bool FSavePackageArgs::IsCooking ( ) const
inline

◆ operator=() [1/2]

FSavePackageArgs & FSavePackageArgs::operator= ( const FSavePackageArgs )
default

◆ operator=() [2/2]

FSavePackageArgs & FSavePackageArgs::operator= ( FSavePackageArgs &&  )
default

Member Data Documentation

◆ ArchiveCookData

FArchiveCookData* FSavePackageArgs::ArchiveCookData = nullptr

◆ bForceByteSwapping

bool FSavePackageArgs::bForceByteSwapping = false

◆ bSlowTask

bool FSavePackageArgs::bSlowTask = true

If true, the Save will send progress events that are displayed in the editor.

◆ bWarnOfLongFilename

bool FSavePackageArgs::bWarnOfLongFilename = true

◆ Error

FOutputDevice* FSavePackageArgs::Error = GError

Receives error/warning messages sent by the Save, to log and respond to their severity level.

◆ FinalTimeStamp

FDateTime FSavePackageArgs::FinalTimeStamp

◆ InOutSaveOverrides

TMap<UObject*, FObjectSaveOverride>* FSavePackageArgs::InOutSaveOverrides = nullptr

In/Out list of property overrides per object to apply to during save. This list can be extended by PreSave functions during the save.

◆ SaveFlags

uint32 FSavePackageArgs::SaveFlags = SAVE_None

◆ SavePackageContext

FSavePackageContext* FSavePackageArgs::SavePackageContext = nullptr

Structure to hold longer-lifetime parameters that apply to multiple saves

◆ TopLevelFlags

EObjectFlags FSavePackageArgs::TopLevelFlags = RF_NoFlags

For all objects which are not referenced[either directly, or indirectly] through the InAsset provided to the Save call (See UPackage::Save), only objects that contain any of these flags will be saved. If RF_NoFlags is specified, only objects which are referenced by InAsset will be saved into the package.


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