UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FObjectCollectSaveOverridesContext Class Reference

#include <ObjectSaveContext.h>

Public Member Functions

 FObjectCollectSaveOverridesContext (FObjectSaveContextData &InData)
 
 FObjectCollectSaveOverridesContext (const FObjectCollectSaveOverridesContext &Other)
 
bool IsCooking () const
 
const ITargetPlatformGetTargetPlatform () const
 
bool IsCookByTheBook () const
 
bool IsCookOnTheFly () const
 
bool IsCookTypeUnknown () const
 
UE::Cook::ECookType GetCookType () const
 
UE::Cook::ECookingDLC GetCookingDLC () const
 
bool IsProceduralSave () const
 
uint32 GetSaveFlags () const
 
void AddSaveOverride (UObject *Target, FObjectSaveOverride InOverride)
 

Protected Attributes

FObjectSaveContextDataData
 

Friends

class UObject
 

Detailed Description

Interface used by CollectSaveOverrides to access the save parameters.

Constructor & Destructor Documentation

◆ FObjectCollectSaveOverridesContext() [1/2]

FObjectCollectSaveOverridesContext::FObjectCollectSaveOverridesContext ( FObjectSaveContextData InData)
inlineexplicit

◆ FObjectCollectSaveOverridesContext() [2/2]

FObjectCollectSaveOverridesContext::FObjectCollectSaveOverridesContext ( const FObjectCollectSaveOverridesContext Other)
inline

Member Function Documentation

◆ AddSaveOverride()

void FObjectCollectSaveOverridesContext::AddSaveOverride ( UObject Target,
FObjectSaveOverride  InOverride 
)
inline

Add a save override to specific object. (i.e. mark certain objects or properties transient for this save)

◆ GetCookingDLC()

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

◆ GetCookType()

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

◆ GetSaveFlags()

uint32 FObjectCollectSaveOverridesContext::GetSaveFlags ( ) const
inline

Return the save flags (ESaveFlags) of the save.

◆ GetTargetPlatform()

const ITargetPlatform * FObjectCollectSaveOverridesContext::GetTargetPlatform ( ) const
inline

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

◆ IsCookByTheBook()

bool FObjectCollectSaveOverridesContext::IsCookByTheBook ( ) const
inline

◆ IsCooking()

bool FObjectCollectSaveOverridesContext::IsCooking ( ) const
inline

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

◆ IsCookOnTheFly()

bool FObjectCollectSaveOverridesContext::IsCookOnTheFly ( ) const
inline

◆ IsCookTypeUnknown()

bool FObjectCollectSaveOverridesContext::IsCookTypeUnknown ( ) const
inline

◆ IsProceduralSave()

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

Friends And Related Symbol Documentation

◆ UObject

friend class UObject
friend

Member Data Documentation

◆ Data

FObjectSaveContextData& FObjectCollectSaveOverridesContext::Data
protected

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